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/controllers/CMSPageHistoryController.php

Doc Comments +5 added lines, -5 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|HTMLText
 	 */
 	public function doCompare($data, $form) {
 		$versions = $data['Versions'];
@@ -315,7 +315,7 @@ 
 	 * @param array
 	 * @param Form
 	 *
-	 * @return html
+	 * @return null|HTMLText
 	 */
 	public function doShowVersion($data, $form) {
 		$versionID = null;
@@ -344,7 +344,7 @@ 
 
 	/**
 	 * @param int|null $versionID
-	 * @return Form
+	 * @return null|CMSForm
 	 */
 	public function ShowVersionForm($versionID = null) {
 		if(!$versionID) return null;

code/controllers/ContentController.php

Doc Comments +2 added lines

@@ -212,6 +212,7 @@ 
 
 	/**
 	 * @uses ErrorPage::response_for()
+	 * @param integer $code
 	 */
 	public function httpError($code, $message = null) {
 		// Don't use the HTML response for media requests
@@ -232,6 +233,7 @@ 
 
 	/**
 	 * Returns the associated database record
+	 * @return SiteTree
 	 */
 	public function data() {
 		return $this->dataRecord;

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;

code/model/SiteTree.php

Doc Comments +6 added lines, -3 removed lines

@@ -961,7 +961,7 @@ 
 	 * 
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -1132,6 +1132,9 @@ 
 		return $this->canEdit($member);
 	}
 	
+	/**
+	 * @param DataObject $member
+	 */
 	public function canDeleteFromLive($member = null) {
 		// Standard mechanism for accepting permission changes from extensions
 		$extended = $this->extendedCan('canDeleteFromLive', $member);
@@ -1333,7 +1336,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
@@ -1406,7 +1409,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()) {

code/model/SiteTreeFileExtension.php

Doc Comments -4 removed lines

@@ -51,10 +51,6 @@
 	/**
 	 * Extend through {@link updateBackLinkTracking()} in your own {@link Extension}.
 	 *
-	 * @param string|array $filter
-	 * @param string $sort
-	 * @param string $join
-	 * @param string $limit
 	 * @return ManyManyList
 	 */
 	public function BackLinkTracking() {

code/model/VirtualPage.php

Doc Comments +1 added lines

@@ -374,6 +374,7 @@
 	
 	/**
 	 * Ensure we have an up-to-date version of everything.
+	 * @param DataObject $source
 	 */
 	public function copyFrom($source, $updateImageTracking = true) {
 		if($source) {

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) {