silverstripe / silverstripe-framework

filesystem/Upload.php

Doc Comments +5 added lines, -4 removed lines

@@ -102,7 +102,7 @@ 
 	 * Set a different instance than {@link Upload_Validator}
 	 * for this upload session.
 	 *
-	 * @param object $validator
+	 * @param Upload_Validator $validator
 	 */
 	public function setValidator($validator) {
 		$this->validator = $validator;
@@ -223,7 +223,7 @@ 
 	 *
 	 * @param array $tmpFile
 	 * @param File $file
-	 * @return Boolean
+	 * @return boolean|string
 	 */
 	public function loadIntoFile($tmpFile, $file, $folderPath = false) {
 		$this->file = $file;
@@ -231,7 +231,8 @@ 
 	}
 
 	/**
-	 * @return Boolean
+	 * @param boolean $bool
+	 * @return boolean|null
 	 */
 	public function setReplaceFile($bool) {
 		$this->replaceFile = $bool;
@@ -295,7 +296,7 @@ 
 	/**
 	 * Determines wether previous operations caused an error.
 	 *
-	 * @return boolean
+	 * @return integer
 	 */
 	public function isError() {
 		return (count($this->errors));

forms/PhoneNumberField.php

Doc Comments +3 added lines

@@ -73,6 +73,9 @@
 		return $this;
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function joinPhoneNumber( $value ) {
 		if( is_array( $value ) ) {
 			$completeNumber = '';

forms/TreeDropdownField.php

Doc Comments +3 added lines, -4 removed lines

@@ -76,7 +76,7 @@ 
 	 *
 	 * @param string $name the field name
 	 * @param string $title the field label
-	 * @param string|array $sourceObject The object-type to list in the tree. This could
+	 * @param string $sourceObject The object-type to list in the tree. This could
 	 * be one of the following:
 	 * - A DataObject class name with the {@link Hierarchy} extension.
 	 * - An array of key/value pairs, like a {@link DropdownField} source. In
@@ -204,7 +204,7 @@ 
 	}
 
 	/**
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang');
@@ -385,7 +385,7 @@ 
 	 * If a filter function has been set, that will be called. And if search text is set,
 	 * filter on that too. Return true if all applicable conditions are true, false otherwise.
 	 * @param $node
-	 * @return unknown_type
+	 * @return boolean
 	 */
 	public function filterMarking($node) {
 		if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false;
@@ -436,7 +436,6 @@ 
 	}
 
 	/**
-	 * @param String $field
 	 */
 	public function setSourceObject($class) {
 		$this->sourceObject = $class;

model/connect/Database.php

Doc Comments +4 added lines, -1 removed lines

@@ -385,6 +385,7 @@ 
 	 * - minutes
 	 * - seconds
 	 * This includes the singular forms as well
+	 * @param string $date
 	 * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of
 	 *                the addition
 	 */
@@ -398,6 +399,7 @@ 
 	 *                       e.g. '"SiteTree"."Created"'
 	 * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime
 	 *                      like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"'
+	 * @param string $date1
 	 * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which
 	 *                is the result of the substraction
 	 */
@@ -625,7 +627,7 @@ 
 	 * @param boolean $create Flag indicating whether the database should be created
 	 * if it doesn't exist. If $create is false and the database doesn't exist
 	 * then an error will be raised
-	 * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error
+	 * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error
 	 * should be raised
 	 * @return boolean Flag indicating success
 	 */
@@ -785,6 +787,7 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::field_list instead
+	 * @param string $table
 	 */
 	public function fieldList($table) {
 		Deprecation::notice('4.0', 'Use DB::field_list instead');

model/URLSegmentFilter.php

Doc Comments +1 added lines

@@ -89,6 +89,7 @@
 	 * Determines if the field should render open or closed by default.
 	 * 
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function startClosed($bool) {
 		($bool) ? $this->addExtraClass('startClosed') : $this->removeExtraClass('startClosed');

security/Security.php

Doc Comments +4 added lines, -5 removed lines

@@ -466,7 +466,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return HTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -646,7 +646,6 @@ 
 	 * - t: plaintext token
 	 *
 	 * @param Member $member Member object associated with this link.
-	 * @param string $autoLoginHash The auto login token.
 	 */
 	public static function getPasswordResetLink($member, $autologinToken) {
 		$autologinToken = urldecode($autologinToken);
@@ -737,7 +736,7 @@ 
 	/**
 	 * Factory method for the lost password form
 	 *
-	 * @return Form Returns the lost password form
+	 * @return Security Returns the lost password form
 	 */
 	public function ChangePasswordForm() {
 		return Object::create('ChangePasswordForm', $this, 'ChangePasswordForm');
@@ -921,7 +920,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1076,7 +1075,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;

core/Object.php

Doc Comments +7 added lines, -9 removed lines

@@ -125,8 +125,6 @@ 
 	 *    $list = DataList::create('SiteTree');
 	 *	  $list = SiteTree::get();
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function create() {
@@ -149,7 +147,6 @@ 
 	 * way to access instance methods which don't rely on instance
 	 * data (e.g. the custom SilverStripe static handling).
 	 *
-	 * @param string $className Optional classname (if called on Object directly)
 	 * @return static The singleton instance
 	 */
 	public static function singleton() {
@@ -334,8 +331,6 @@ 
 	 * Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to
 	 * TRUE when using {@link Object::useCustomClass()}
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function strong_create() {
@@ -387,8 +382,8 @@ 
 	 * without any inheritance, merging or parent lookup if it doesn't exist on the given class.
 	 *
 	 * @static
-	 * @param $class - The class to get the static from
-	 * @param $name - The property to get from the class
+	 * @param string $class - The class to get the static from
+	 * @param string $name - The property to get from the class
 	 * @param null $default - The value to return if property doesn't exist on class
 	 * @return any - The value of the static property $name on class $class, or $default if that property is not
 	 *               defined
@@ -908,6 +903,7 @@ 
 
 	/**
 	 * @see Object::get_static()
+	 * @param string $name
 	 */
 	public function stat($name, $uncached = false) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::FIRST_SET);
@@ -915,6 +911,8 @@ 
 
 	/**
 	 * @see Object::set_static()
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function set_stat($name, $value) {
 		Config::inst()->update(($this->class ? $this->class : get_class($this)), $name, $value);
@@ -922,6 +920,7 @@ 
 
 	/**
 	 * @see Object::uninherited_static()
+	 * @param string $name
 	 */
 	public function uninherited($name) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::UNINHERITED);
@@ -972,7 +971,7 @@ 
 	 * all results into an array
 	 *
 	 * @param string $method the method name to call
-	 * @param mixed $argument a single argument to pass
+	 * @param string $argument a single argument to pass
 	 * @return mixed
 	 * @todo integrate inheritance rules
 	 */
@@ -995,7 +994,6 @@ 
 	 * The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
 	 *
 	 * @param string $method the name of the method to call on each extension
-	 * @param mixed $a1,... up to 7 arguments to be passed to the method
 	 * @return array
 	 */
 	public function extend($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null) {