silverstripe / silverstripe-framework

dev/Deprecation.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	 * greater than or equal to this version, a message will be raised
 	 *
 	 * @static
-	 * @param $ver string -
+	 * @param string|null $ver string -
 	 *     A php standard version string, see http://php.net/manual/en/function.version-compare.php for details.
 	 * @param null $forModule string -
 	 *    The name of a module. The passed version will be used as the check value for

forms/DateField.php

Doc Comments +8 added lines, -1 removed lines

@@ -90,6 +90,10 @@ 
 	 */
 	protected $valueObj = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = null) {
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -288,6 +292,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = new $class($this->name);
 		if($copy->hasMethod('setConfig')) {
@@ -326,7 +333,7 @@ 
 	 * @deprecated 4.0 Use the "DateField.default_config" config setting instead
 	 * @param String $k
 	 * @param mixed $v
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public static function set_default_config($k, $v) {
 		Deprecation::notice('4.0', 'Use the "DateField.default_config" config setting instead');

forms/Form.php

Doc Comments +10 added lines, -5 removed lines

@@ -532,7 +532,7 @@ 
 	/**
 	 * Fields can have action to, let's check if anyone of the responds to $funcname them
 	 *
-	 * @param SS_List|array $fields
+	 * @param FieldList|null $fields
 	 * @param callable $funcName
 	 * @return FormField
 	 */
@@ -791,6 +791,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string $name
 	 */
 	public function getAttribute($name) {
@@ -825,6 +826,7 @@ 
 	 *
 	 * @param array Custom attributes to process. Falls back to {@link getAttributes()}.
 	 * If at least one argument is passed as a string, all arguments act as excludes by name.
+	 * @param string $attrs
 	 *
 	 * @return string HTML attributes, ready for insertion into an HTML tag
 	 */
@@ -1032,7 +1034,7 @@ 
 	 * If set to false (the default), then the form method is only used to construct the default
 	 * form.
 	 *
-	 * @param $bool boolean
+	 * @param boolean $bool boolean
 	 * @return $this
 	 */
 	public function setStrictFormMethodCheck($bool) {
@@ -1529,7 +1531,7 @@ 
 	 * This is returned when you access a form as $FormObject rather
 	 * than <% with FormObject %>
 	 *
-	 * @return HTML
+	 * @return HTMLText
 	 */
 	public function forTemplate() {
 		$return = $this->renderWith(array_merge(
@@ -1549,7 +1551,7 @@ 
 	 * It triggers slightly different behaviour, such as disabling the rewriting
 	 * of # links.
 	 *
-	 * @return HTML
+	 * @return HTMLText
 	 */
 	public function forAjaxTemplate() {
 		$view = new SSViewer(array(
@@ -1572,7 +1574,7 @@ 
 	 * and _form_enctype.  These are the attributes of the form.  These fields
 	 * can be used to send the form to Ajax.
 	 *
-	 * @return HTML
+	 * @return string
 	 */
 	public function formHtmlContent() {
 		$this->IncludeFormTag = false;
@@ -1830,6 +1832,9 @@ 
 
 	protected $form;
 
+	/**
+	 * @param Form $form
+	 */
 	public function __construct($form) {
 		$this->form = $form;
 		parent::__construct();

forms/gridfield/GridFieldDetailForm.php

Doc Comments +7 added lines

@@ -164,6 +164,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $class
 	 */
 	public function setItemRequestClass($class) {
 		$this->itemRequestClass = $class;
@@ -271,6 +272,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		return Controller::join_links($this->gridField->Link('item'),
 			$this->record->ID ? $this->record->ID : 'new', $action);
@@ -299,6 +303,9 @@ 
 		}
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	public function edit($request) {
 		$controller = $this->getToplevelController();
 		$form = $this->ItemEditForm($this->gridField, $request);

model/DatabaseAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -152,7 +152,7 @@
 	/**
 	 * Returns the timestamp of the time that the database was last built
 	 *
-	 * @return string Returns the timestamp of the time that the database was
+	 * @return integer|null Returns the timestamp of the time that the database was
 	 *                last built
 	 */
 	public static function lastBuilt() {

model/DB.php

Doc Comments +5 added lines, -4 removed lines

@@ -217,9 +217,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
 	 */
@@ -413,7 +412,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:
@@ -500,6 +499,8 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::require_field instead
+	 * @param string $field
+	 * @param string $spec
 	 */
 	public static function requireField($table, $field, $spec) {
 		Deprecation::notice('4.0', 'Use DB::require_field instead');
@@ -563,7 +564,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) {

model/fieldtypes/Money.php

Doc Comments +6 added lines

@@ -236,6 +236,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getSymbol($currency = null, $locale = null) {
@@ -247,6 +249,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getShortName($currency = null, $locale = null) {
@@ -257,6 +261,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getName($currency = null, $locale = null) {

model/fieldtypes/PrimaryKey.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
 	/**
 	 * @param string $name
-	 * @param DataOject $object The object that this is primary key for (should have a relation with $name)
+	 * @param DataObject $object The object that this is primary key for (should have a relation with $name)
 	 */
 	public function __construct($name = null, $object) {
 		$this->object = $object;

model/Image_Backend.php

Doc Comments +2 added lines, -2 removed lines

@@ -71,8 +71,8 @@
 	/**
 	 * resizeRatio
 	 *
-	 * @param int $width
-	 * @param int $height
+	 * @param integer $maxWidth
+	 * @param integer $maxHeight
 	 * @return Image_Backend
 	 */
 	public function resizeRatio($maxWidth, $maxHeight, $useAsMinimum = false);