silverstripe / silverstripe-framework

parsers/HTML/HTMLValue.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
 	/**
 	 * Make an xpath query against this HTML
 	 *
-	 * @param $query string - The xpath query string
+	 * @param string $query string - The xpath query string
 	 * @return DOMNodeList
 	 */
 	public function query($query) {

search/SearchContext.php

Doc Comments +1 added lines, -1 removed lines

@@ -179,7 +179,7 @@
 	 * @param array $searchParams
 	 * @param array|bool|string $sort
 	 * @param array|bool|string $limit
-	 * @return SS_List
+	 * @return DataList
 	 * @throws Exception
 	 */
 	public function getResults($searchParams, $sort = false, $limit = false) {

tests/i18n/i18nTextCollectorTest.php

Doc Comments +10 added lines

@@ -843,6 +843,10 @@ 
  * Assist with testing of specific protected methods
  */
 class i18nTextCollectorTest_Collector extends i18nTextCollector implements TestOnly {
+
+	/**
+	 * @param string $directory
+	 */
 	public function getModules_Test($directory) {
 		return $this->getModules($directory);
 	}
@@ -851,6 +855,9 @@ 
 		return $this->resolveDuplicateConflicts($entitiesByModule);
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public function getFileListForModule_Test($module) {
 		return $this->getFileListForModule($module);
 	}
@@ -859,6 +866,9 @@ 
 		return $this->getConflicts($entitiesByModule);
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function findModuleForClass_Test($class) {
 		return $this->findModuleForClass($class);
 	}

tests/model/VersionedOwnershipTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -730,7 +730,7 @@ 
 	/**
 	 * All custom objects with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function Custom() {
 		$title = str_replace('Page', 'Custom', $this->Title);
@@ -784,7 +784,7 @@ 
 	/**
 	 * All pages with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function Pages() {
 		$title = str_replace('Custom', 'Page', $this->Title);

admin/code/CMSMenu.php

Doc Comments +3 added lines, -3 removed lines

@@ -99,7 +99,7 @@ 
 	 *                          left.
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean The result of the operation.
+	 * @return boolean|null The result of the operation.
 	 */
 	public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null) {
 		return self::add_menu_item($code, $menuTitle, $url, null, $priority, $attributes);
@@ -119,7 +119,7 @@ 
 	 *                    have the rights to access some other part of the admin area.
 	 * @param int $priority
 	 * @param array $attributes an array of attributes to include on the link.
-	 * @return bool Success
+	 * @return boolean|null Success
 	 */
 	public static function add_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 											$attributes = null) {
@@ -250,7 +250,7 @@ 
 	 *                    have the rights to access some other part of the admin area.
 	 * @param int $priority
 	 * @param array $attributes an array of attributes to include on the link.
-	 * @return bool Success
+	 * @return boolean|null Success
 	 */
 	public static function replace_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 												$attributes = null) {

control/RequestHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -282,7 +282,7 @@
 	 *
 	 * Must not raise SS_HTTPResponse_Exceptions - instead it should return
 	 *
-	 * @param $request
+	 * @param SS_HTTPRequest $request
 	 * @param $action
 	 * @return SS_HTTPResponse
 	 */

dev/Backtrace.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
 	 * @param mixed $returnVal
 	 * @param bool $ignoreAjax
 	 * @param array $ignoredFunctions
-	 * @return mixed
+	 * @return string|null
 	 */
 	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
 		$plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax);

filesystem/File.php

Doc Comments +6 added lines, -6 removed lines

@@ -258,7 +258,7 @@ 
 	 *
 	 * @param array $args Array of input shortcode arguments
 	 * @param int $errorCode If the file is not found, or is inaccessible, this will be assigned to a HTTP error code.
-	 * @return File|null The File DataObject, if it can be found.
+	 * @return null|DataObject The File DataObject, if it can be found.
 	 */
 	public static function find_shortcode_record($args, &$errorCode = null) {
 		// Validate shortcode
@@ -387,7 +387,7 @@ 
 	 * Check if this file can be modified
 	 *
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canEdit($member = null) {
 		if(!$member) {
@@ -407,7 +407,7 @@ 
 	 *
 	 * @param Member $member
 	 * @param array $context
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canCreate($member = null, $context = array()) {
 		if(!$member) {
@@ -426,7 +426,7 @@ 
 	 * Check if this file can be deleted
 	 *
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canDelete($member = null) {
 		if(!$member) {
@@ -627,7 +627,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 true|null
+	 * @return boolean|null
 	 */
 	public function collateDescendants($condition, &$collator) {
 		if($children = $this->Children()) {
@@ -988,6 +988,7 @@ 
 	 *
 	 * @param String File extension, without dot prefix. Use an asterisk ('*')
 	 * to specify a generic fallback if no mapping is found for an extension.
+	 * @param string $ext
 	 * @return String Classname for a subclass of {@link File}
 	 */
 	public static function get_class_for_file_extension($ext) {
@@ -1125,7 +1126,6 @@ 
 	 * Note that the result will not have a leading slash, and should not be used
 	 * with local file paths.
 	 *
-	 * @param string $part,... Parts
 	 * @return string
 	 */
 	public static function join_paths() {

forms/AssetField.php

Doc Comments +6 added lines, -2 removed lines

@@ -195,7 +195,7 @@ 
 	/**
 	 * Determine if the target folder for new uploads in is visible the field UI.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canPreviewFolder() {
 		if(!$this->isActive()) {
@@ -264,6 +264,10 @@ 
 		return $this->record;
 	}
 
+	/**
+	 * @param null|DataObject $value
+	 * @param DataObject $record
+	 */
 	public function setValue($value, $record = null) {
 		// Extract value from underlying record
 		if(empty($value) && $this->getName() && $record instanceof DataObject) {
@@ -370,7 +374,7 @@ 
 	/**
 	 * Determine if the user has permission to upload.
 	 *
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canUpload() {
 		if(!$this->isActive()) {