silverstripe / silverstripe-cms

code/controllers/AssetAdmin.php

Doc Comments +4 added lines

@@ -538,6 +538,10 @@
 		return new Folder();
 	}
 
+	/**
+	 * @param string $childrenMethod
+	 * @param string $numChildrenMethod
+	 */
 	public function getSiteTreeFor($className, $rootID = null, $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $minNodeCount = 30) {
 		if (!$childrenMethod) $childrenMethod = 'ChildFolders';
 		if (!$numChildrenMethod) $numChildrenMethod = 'numChildFolders';

code/model/ErrorPage.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
 	/**
 	 * Write out the published version of the page to the filesystem
 	 *
-	 * @return true if the page write was successful
+	 * @return boolean if the page write was successful
 	 */
 	public function writeStaticPage() {
 		if(!self::config()->enable_static_file) {

code/controllers/ContentController.php

Doc Comments +1 added lines

@@ -222,6 +222,7 @@
 
 	/**
 	 * Returns the associated database record
+	 * @return SiteTree
 	 */
 	public function data() {
 		return $this->dataRecord;

code/model/VirtualPage.php

Doc Comments +3 added lines

@@ -341,6 +341,9 @@
 		}
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function getField($field) {
 		if($this->isFieldVirtualised($field)) {
 			return $this->CopyContentFrom()->getField($field);

code/controllers/SilverStripeNavigator.php

Doc Comments +3 added lines, -3 removed lines

@@ -20,7 +20,7 @@ 
 	protected $record;
 
 	/**
-	 * @param DataObject|CMSPreviewable $record
+	 * @param CMSPreviewable $record
 	 */
 	public function __construct(CMSPreviewable $record) {
 		parent::__construct();
@@ -106,7 +106,7 @@ 
 	protected $record;
 
 	/**
-	 * @param DataObject|CMSPreviewable $record
+	 * @param CMSPreviewable $record
 	 */
 	public function __construct(CMSPreviewable $record) {
 		parent::__construct();
@@ -149,7 +149,7 @@ 
 	public function getMessage() {}
 
 	/**
-	 * @return DataObject
+	 * @return CMSPreviewable
 	 */
 	public function getRecord() {
 		return $this->record;

code/controllers/CMSMain.php

Doc Comments +4 added lines, -4 removed lines

@@ -690,7 +690,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return string HTML
+	 * @return DBHTMLText HTML
 	 */
 	public function treeview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_TreeView'));
@@ -698,7 +698,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return string HTML
+	 * @return DBHTMLText HTML
 	 */
 	public function listview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_ListView'));
@@ -1011,7 +1011,7 @@ 
 	 * Actually perform the publication step
 	 *
 	 * @param Versioned|DataObject $record
-	 * @return mixed
+	 * @return SS_HTTPResponse|null
 	 */
 	public function performPublish($record) {
 		if($record && !$record->canPublish()) {
@@ -1165,7 +1165,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return SS_HTTPResponse|null
 	 */
 	public function rollback() {
 		return $this->doRollback(array(

code/controllers/CMSPageHistoryController.php

Doc Comments +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return array
+	 * @return SS_HTTPResponse
 	 */
 	public function show($request) {
 		$form = $this->ShowVersionForm($request->param('VersionID'));
@@ -63,7 +63,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return array
+	 * @return SS_HTTPResponse
 	 */
 	public function compare($request) {
 		$form = $this->CompareVersionsForm(
@@ -282,7 +282,7 @@ 
 	 * @param array
 	 * @param Form
 	 *
-	 * @return html
+	 * @return null|DBHTMLText
 	 */
 	public function doCompare($data, $form) {
 		$versions = $data['Versions'];
@@ -319,7 +319,7 @@ 
 	 * @param array
 	 * @param Form
 	 *
-	 * @return html
+	 * @return null|DBHTMLText
 	 */
 	public function doShowVersion($data, $form) {
 		$versionID = null;

code/controllers/CMSSiteTreeFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -215,7 +215,7 @@
 	/**
 	 * Maps a list of pages to an array of associative arrays with ID and ParentID keys
 	 *
-	 * @param DataList $pages
+	 * @param SS_List $pages
 	 * @return array
 	 */
 	protected function mapIDs($pages) {

code/forms/SiteTreeURLSegmentField.php

Doc Comments +3 added lines

@@ -118,6 +118,9 @@
 		return $this->defaultUrl;
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public function setDefaultURL($url) {
 		$this->defaultUrl = $url;
 		return $this;