silverstripe / silverstripe-framework

ORM/FieldType/DBTime.php

Doc Comments +3 added lines

@@ -55,6 +55,9 @@
 		if($this->value) return date($format, strtotime($this->value));
 	}
 
+	/**
+	 * @param string[] $parts
+	 */
 	public function TwelveHour( $parts ) {
 		$hour = $parts[1];
 		$min = $parts[2];

ORM/FieldType/DBYear.php

Doc Comments +3 added lines

@@ -18,6 +18,9 @@
 		DB::require_field($this->tableName, $this->name, $values);
 	}
 
+	/**
+	 * @param string $title
+	 */
 	public function scaffoldFormField($title = null, $params = null) {
 		$selectBox = new DropdownField($this->name, $title);
 		$selectBox->setSource($this->getDefaultOptions());

ORM/Queries/SQLConditionalExpression.php

Doc Comments -4 removed lines

@@ -374,7 +374,6 @@ 
 	 * @see SQLConditionalExpression::addWhere() for syntax examples
 	 *
 	 * @param mixed $where Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $where,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setWhere($where) {
@@ -460,7 +459,6 @@ 
 	 * </code>
 	 *
 	 * @param mixed $where Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $where,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addWhere($where) {
@@ -476,7 +474,6 @@ 
 	 * @see SQLConditionalExpression::addWhere()
 	 *
 	 * @param mixed $filters Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $filters,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setWhereAny($filters) {
@@ -490,7 +487,6 @@ 
 	 * @see SQLConditionalExpression::addWhere()
 	 *
 	 * @param mixed $filters Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $filters,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addWhereAny($filters) {

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

ORM/DataExtension.php

Doc Comments +6 added lines

@@ -78,9 +78,15 @@
 	public function can($member) {
 	}
 
+	/**
+	 * @param \SilverStripe\Security\Member|null $member
+	 */
 	public function canEdit($member) {
 	}
 
+	/**
+	 * @param \SilverStripe\Security\Member|null $member
+	 */
 	public function canDelete($member) {
 	}
 

ORM/Versioning/ChangeSetItem.php

Doc Comments +2 added lines, -2 removed lines

@@ -127,7 +127,7 @@ 
 	 * Find version of this object in the given stage
 	 *
 	 * @param string $stage
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectInStage($stage) {
 		return Versioned::get_by_stage($this->ObjectClass, $stage)->byID($this->ObjectID);
@@ -136,7 +136,7 @@ 
 	/**
 	 * Find latest version of this object
 	 *
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectLatestVersion() {
 		return Versioned::get_latest_version($this->ObjectClass, $this->ObjectID);

Security/Authenticator.php

Doc Comments +2 added lines, -1 removed lines

@@ -128,7 +128,7 @@ 
 	 * Remove a previously registered authenticator
 	 *
 	 * @param string $authenticator Name of the authenticator class to register
-	 * @return bool Returns TRUE on success, FALSE otherwise.
+	 * @return boolean|null Returns TRUE on success, FALSE otherwise.
 	 */
 	public static function unregister_authenticator($authenticator) {
 		if(call_user_func(array($authenticator, 'on_unregister')) === true) {
@@ -171,6 +171,7 @@ 
 	 * Set a default authenticator (shows first in tabs)
 	 *
 	 * @param string
+	 * @param string $authenticator
 	 */
 	public static function set_default_authenticator($authenticator) {
 		self::$default_authenticator = $authenticator;