silverstripe / silverstripe-framework

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

security/Member.php

Doc Comments +3 added lines, -3 removed lines

@@ -826,7 +826,7 @@ 
 	/**
 	 * Returns the current logged in user
 	 *
-	 * @return Member|null
+	 * @return DataObject|null
 	 */
 	public static function currentUser() {
 		$id = Member::currentUserID();
@@ -1270,7 +1270,7 @@ 
 	 * If no $groups is passed, all members will be returned
 	 *
 	 * @param mixed $groups - takes a SS_List, an array or a single Group.ID
-	 * @return SS_Map Returns an SS_Map that returns all Member data.
+	 * @return SilverStripe\ORM\SS_Map Returns an SS_Map that returns all Member data.
 	 */
 	public static function map_in_groups($groups = null) {
 		$groupIDList = array();
@@ -1308,7 +1308,7 @@ 
 	 *
 	 * @param array $groups Groups to consider or NULL to use all groups with
 	 *                      CMS permissions.
-	 * @return SS_Map Returns a map of all members in the groups given that
+	 * @return SilverStripe\ORM\SS_Map Returns a map of all members in the groups given that
 	 *                have CMS permissions.
 	 */
 	public static function mapInCMSGroups($groups = null) {

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

core/Extensible.php

Doc Comments +2 added lines, -2 removed lines

@@ -369,8 +369,8 @@
 	 *
 	 * @param string $method the method name to call
 	 * @param mixed $a1
-	 * @param mixed $a2
-	 * @param mixed $a3
+	 * @param string $a2
+	 * @param boolean $a3
 	 * @param mixed $a4
 	 * @param mixed $a5
 	 * @param mixed $a6

ORM/Connect/DBSchemaManager.php

Doc Comments +2 added lines, -1 removed lines

@@ -112,6 +112,7 @@ 
 	 *
 	 * @var callable $callback
 	 * @throws Exception
+	 * @param \Closure $callback
 	 */
 	public function schemaUpdate($callback) {
 		// Begin schema update
@@ -484,7 +485,7 @@ 
 	/**
 	 * Given an index spec determines the index type
 	 *
-	 * @param array|string $spec
+	 * @param string $spec
 	 * @return string
 	 */
 	protected function determineIndexType($spec) {

ORM/DB.php

Doc Comments +6 added lines, -7 removed lines

@@ -128,7 +128,7 @@ 
 	 *
 	 * @param string $name An optional name given to a connection in the DB::setConn() call.  If omitted,
 	 * the default connection is returned.
-	 * @return DBConnector
+	 * @return Connect\DBConnector|null
 	 */
 	public static function get_connector($name = 'default') {
 		$connection = self::get_conn($name);
@@ -231,9 +231,8 @@ 
 	 * Given the database configuration, this method will create the correct
 	 * subclass of {@link SS_Database}.
 	 *
-	 * @param array $database A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
+	 * @param array $databaseConfig A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
 	 *                        rest of the options, see the specific class.
-	 * @param string $name identifier for the connection
 	 *
 	 * @return SS_Database
 	 */
@@ -282,7 +281,7 @@ 
 	 * Execute the given SQL query.
 	 * @param string $sql The SQL query to execute
 	 * @param int $errorLevel The level of error reporting to enable for the query
-	 * @return SS_Query
+	 * @return Connect\SS_Query
 	 */
 	public static function query($sql, $errorLevel = E_USER_ERROR) {
 		self::$lastQuery = $sql;
@@ -317,7 +316,7 @@ 
 	 * @param string $sql The SQL query to execute. The ? character will denote parameters.
 	 * @param array $parameters An ordered list of arguments.
 	 * @param int $errorLevel The level of error reporting to enable for the query
-	 * @return SS_Query
+	 * @return Connect\SS_Query
 	 */
 	public static function prepared_query($sql, $parameters, $errorLevel = E_USER_ERROR) {
 		self::$lastQuery = $sql;
@@ -427,7 +426,7 @@ 
 
 	/**
 	 * Create a new table.
-	 * @param string $tableName The name of the table
+	 * @param string $table The name of the table
 	 * @param array$fields A map of field names to field types
 	 * @param array $indexes A map of indexes
 	 * @param array $options An map of additional options.  The available keys are as follows:
@@ -577,7 +576,7 @@ 
 	/**
 	 * Checks a table's integrity and repairs it if necessary.
 	 *
-	 * @param string $tableName The name of the table.
+	 * @param string $table The name of the table.
 	 * @return boolean Return true if the table has integrity after the method is complete.
 	 */
 	public static function check_and_repair_table($table) {

ORM/FieldType/DBDate.php

Doc Comments +4 added lines, -1 removed lines

@@ -38,6 +38,9 @@ 
 	 */
 	private static $nice_format = 'd/m/Y';
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value, $record = null, $markChanged = true) {
 		if($value === false || $value === null || (is_string($value) && !strlen($value))) {
 			// don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be
@@ -194,7 +197,7 @@ 
 	 * Return a date formatted as per a CMS user's settings.
 	 *
 	 * @param Member $member
-	 * @return boolean | string A date formatted as per user-defined settings.
+	 * @return false|string | string A date formatted as per user-defined settings.
 	 */
 	public function FormatFromSettings($member = null) {
 		require_once 'Zend/Date.php';