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/forms/SiteTreeURLSegmentField.php

Doc Comments +6 added lines, -2 removed lines

@@ -89,6 +89,7 @@ 
 	
 	/**
 	 * @param the url that prefixes the page url segment field
+	 * @param string $url
 	 */
 	public function setURLPrefix($url){
 		$this->urlPrefix = $url;
@@ -96,7 +97,7 @@ 
 	}
 	
 	/**
-	 * @return the url prefixes the page url segment field to show in template
+	 * @return string url prefixes the page url segment field to show in template
 	 */
 	public function getURLPrefix(){
 		return $this->urlPrefix;
@@ -107,7 +108,7 @@ 
 	}
 
 	/**
-	 * @return Indicator for UI to respond to changes accurately,
+	 * @return string for UI to respond to changes accurately,
 	 * and auto-update the field value if changes to the default occur.
 	 * Does not set the field default value.
 	 */
@@ -115,6 +116,9 @@ 
 		return $this->defaultUrl;
 	}
 	
+	/**
+	 * @param string $url
+	 */
 	public function setDefaultURL($url) {
 		$this->defaultUrl = $url;
 		return $this;

tasks/UpgradeSiteTreePermissionSchemaTask.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 		See http://open.silverstripe.com/ticket/2847
 	";
 	
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	public function run($request) {
 		// transfer values for changed column name
 		foreach(array('SiteTree','SiteTree_Live','SiteTree_versions') as $table) {

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/CMSMain.php

Doc Comments +4 added lines, -4 removed lines

@@ -661,7 +661,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return string HTML
+	 * @return SilverStripe\Model\FieldType\DBField HTML
 	 */
 	public function treeview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_TreeView'));
@@ -669,7 +669,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return string HTML
+	 * @return SilverStripe\Model\FieldType\DBField HTML
 	 */
 	public function listview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_ListView'));
@@ -982,7 +982,7 @@ 
 	 * Actually perform the publication step
 	 *
 	 * @param Versioned|DataObject $record
-	 * @return mixed
+	 * @return SS_HTTPResponse|null
 	 */
 	public function performPublish($record) {
 		if($record && !$record->canPublish()) {
@@ -1136,7 +1136,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

@@ -40,7 +40,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return array
+	 * @return SS_HTTPResponse
 	 */
 	public function show($request) {
 		$form = $this->ShowVersionForm($request->param('VersionID'));
@@ -59,7 +59,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return array
+	 * @return SS_HTTPResponse
 	 */
 	public function compare($request) {
 		$form = $this->CompareVersionsForm(
@@ -278,7 +278,7 @@ 
 	 * @param array
 	 * @param Form
 	 *
-	 * @return html
+	 * @return null|SilverStripe\Model\FieldType\DBField
 	 */
 	public function doCompare($data, $form) {
 		$versions = $data['Versions'];
@@ -315,7 +315,7 @@ 
 	 * @param array
 	 * @param Form
 	 *
-	 * @return html
+	 * @return null|SilverStripe\Model\FieldType\DBField
 	 */
 	public function doShowVersion($data, $form) {
 		$versionID = null;

code/model/SiteTree.php

Doc Comments +3 added lines, -3 removed lines

@@ -661,7 +661,7 @@ 
 	 * @param boolean $unlinked Whether to link page titles.
 	 * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
 	 * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
-	 * @return HTMLText The breadcrumb trail.
+	 * @return SilverStripe\Model\FieldType\DBField The breadcrumb trail.
 	 */
 	public function Breadcrumbs($maxDepth = 20, $unlinked = false, $stopAtPageType = false, $showHidden = false) {
 		$pages = $this->getBreadcrumbItems($maxDepth, $stopAtPageType, $showHidden);
@@ -1198,7 +1198,7 @@ 
 	/**
 	 * Get the 'can edit' information for a number of SiteTree pages.
 	 *
-	 * @param array $ids       An array of IDs of the SiteTree pages to look up
+	 * @param integer[] $ids       An array of IDs of the SiteTree pages to look up
 	 * @param int   $memberID  ID of member
 	 * @param bool  $useCached Return values from the permission cache if they exist
 	 * @return array
@@ -1271,7 +1271,7 @@ 
 	 *
 	 * @param string $condition The PHP condition to be evaluated. The page will be called $item
 	 * @param array  $collator  An array, passed by reference, to collect all of the matching descendants.
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function collateDescendants($condition, &$collator) {
 		if($children = $this->Children()) {