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

parsers/URLSegmentFilter.php

Doc Comments +2 added lines, -1 removed lines

@@ -106,7 +106,7 @@ 
 	protected $transliterator;
 
 	/**
-	 * @return SS_Transliterator|NULL
+	 * @return SS_Transliterator
 	 */
 	public function getTransliterator() {
 		if($this->transliterator === null && $this->config()->default_use_transliterator) {
@@ -129,6 +129,7 @@ 
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setAllowMultibyte($bool) {
 		$this->allowMultibyte = $bool;

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

admin/code/LeftAndMain.php

Doc Comments +9 added lines, -3 removed lines

@@ -203,7 +203,7 @@ 
 	/**
 	 * Gets the combined configuration of all LeafAndMain subclasses required by the client app.
 	 *
-	 * @return array
+	 * @return string
 	 *
 	 * WARNING: Experimental API
 	 */
@@ -646,6 +646,9 @@ 
 		}
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	public function index($request) {
 		return $this->getResponseNegotiator()->respond($request);
 	}
@@ -1774,7 +1777,7 @@ 
 	 * The controller might not have any previewable content, in which case
 	 * this method returns FALSE.
 	 *
-	 * @return String|boolean
+	 * @return boolean
 	 */
 	public function LinkPreview() {
 		return false;
@@ -1961,7 +1964,7 @@ 
 	}
 
 	/**
-	 * @return String
+	 * @return DBField
 	 */
 	public function Locale() {
 		return DBField::create_field('Locale', i18n::get_locale());
@@ -2127,6 +2130,9 @@ 
 		return (parent::isFinished() || $this->isFinished);
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setIsFinished($bool) {
 		$this->isFinished = $bool;
 	}

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