silverstripe / silverstripe-framework

model/Map.php

Doc Comments +4 added lines

@@ -41,6 +41,7 @@ 
 	 * Set the key field for this map.
 	 *
 	 * @var string $keyField
+	 * @param string $keyField
 	 */
 	public function setKeyField($keyField) {
 		$this->keyField = $keyField;
@@ -50,6 +51,7 @@ 
 	 * Set the value field for this map.
 	 *
 	 * @var string $valueField
+	 * @param string $valueField
 	 */
 	public function setValueField($valueField) {
 		$this->valueField = $valueField;
@@ -95,6 +97,7 @@ 
 	 *
 	 * @var string $key
 	 * @var mixed $value
+	 * @param string $value
 	 */
 	public function unshift($key, $value) {
 		$oldItems = $this->firstItems;
@@ -114,6 +117,7 @@ 
 	 *
 	 * @var string $key
 	 * @var mixed $value
+	 * @param string $value
 	 */
 	public function push($key, $value) {
 		$oldItems = $this->lastItems;

tests/core/ObjectTest.php

Doc Comments +5 added lines

@@ -619,6 +619,11 @@
 		'ObjectTest_Extending_Extension'
 	);
 
+	/**
+	 * @param integer $first
+	 * @param integer $second
+	 * @param integer $third
+	 */
 	public function getResults(&$first, &$second, &$third) {
 		// Before extending should be invoked second
 		$this->beforeExtending('updateResult', function(&$first, &$second, &$third) {

core/Injectable.php

Doc Comments -3 removed lines

@@ -23,8 +23,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() {
@@ -47,7 +45,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() {

core/Extensible.php

Doc Comments +1 added lines, -1 removed lines

@@ -387,7 +387,7 @@
 	 * 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
+	 * @param \Controller $a4
 	 * @return array
 	 */
 	public function extend($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null) {

core/Extension.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 
 	/**
 	 * Set the owner of this extension.
-	 * @param Object $owner The owner object,
+	 * @param DataObject $owner The owner object,
 	 * @param string $ownerBaseClass The base class that the extension is applied to; this may be
 	 * the class of owner, or it may be a parent.  For example, if Versioned was applied to SiteTree,
 	 * and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass

filesystem/Upload.php

Doc Comments +2 added lines, -2 removed lines

@@ -114,7 +114,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;
@@ -363,7 +363,7 @@ 
 	/**
 	 * Determines wether previous operations caused an error.
 	 *
-	 * @return boolean
+	 * @return integer
 	 */
 	public function isError() {
 		return (count($this->errors));

forms/FieldList.php

Doc Comments +10 added lines, -2 removed lines

@@ -118,6 +118,7 @@ 
 	 *                        or TabSet.Tab.Subtab.
 	 * This function will create any missing tabs.
 	 * @param array $fields An array of {@link FormField} objects.
+	 * @param string $insertBefore
 	 */
 	public function addFieldsToTab($tabName, $fields, $insertBefore = null) {
 		$this->flushFieldsCache();
@@ -157,7 +158,7 @@ 
 	 * Removes a number of fields from a Tab/TabSet within this FieldList.
 	 *
 	 * @param string $tabName The name of the Tab or TabSet field
-	 * @param array $fields A list of fields, e.g. array('Name', 'Email')
+	 * @param string[] $fields A list of fields, e.g. array('Name', 'Email')
 	 */
 	public function removeFieldsFromTab($tabName, $fields) {
 		$this->flushFieldsCache();
@@ -440,6 +441,7 @@ 
 
 	/**
 	 * Handler method called before the FieldList is going to be manipulated.
+	 * @param FormField $item
 	 */
 	protected function onBeforeInsert($item) {
 		$this->flushFieldsCache();
@@ -512,6 +514,7 @@ 
 	 * Transform this FieldList with a given tranform method,
 	 * e.g. $this->transform(new ReadonlyTransformation())
 	 *
+	 * @param ReadonlyTransformation $trans
 	 * @return FieldList
 	 */
 	public function transform($trans) {
@@ -531,6 +534,9 @@ 
 		else return $this;
 	}
 
+	/**
+	 * @param CompositeField $field
+	 */
 	public function setContainerField($field) {
 		$this->containerField = $field;
 		return $this;
@@ -549,6 +555,7 @@ 
 	 * Transform the named field into a readonly feld.
 	 *
 	 * @param string|FormField
+	 * @param string $field
 	 */
 	public function makeFieldReadonly($field) {
 		$fieldName = ($field instanceof FormField) ? $field->getName() : $field;
@@ -598,6 +605,7 @@ 
 	 * the children collection. Doesn't work recursively.
 	 *
 	 * @param string|FormField
+	 * @param string $field
 	 * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't
 	 *             be found.
 	 */
@@ -645,7 +653,7 @@ 
 	 * Support function for backwards compatibility purposes.
 	 * Caution: Volatile API, might be removed in 3.1 or later.
 	 *
-	 * @param  String $tabname Path to a tab, e.g. "Root.Content.Main"
+	 * @param  string $name Path to a tab, e.g. "Root.Content.Main"
 	 * @return String Rewritten path, based on {@link tabPathRewrites}
 	 */
 	protected function rewriteTabPath($name) {

forms/gridfield/GridFieldDetailForm.php

Doc Comments +13 added lines

@@ -185,6 +185,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $class
 	 */
 	public function setItemRequestClass($class) {
 		$this->itemRequestClass = $class;
@@ -292,6 +293,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);
@@ -320,6 +324,9 @@ 
 		}
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	public function edit($request) {
 		$controller = $this->getToplevelController();
 		$form = $this->ItemEditForm($this->gridField, $request);
@@ -515,6 +522,9 @@ 
 		return $c;
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function getBackLink(){
 		// TODO Coupling with CMS
 		$backlink = '';
@@ -616,6 +626,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $errorCode
+	 */
 	public function httpError($errorCode, $errorMessage = null) {
 		$controller = $this->getToplevelController();
 		return $controller->httpError($errorCode, $errorMessage);

model/DataObject.php

Doc Comments +8 added lines, -4 removed lines

@@ -554,7 +554,7 @@ 
 	 * The destinationObject must be written to the database already and have an ID. Writing is performed
 	 * automatically when adding the new relations.
 	 *
-	 * @param $sourceObject the source object to duplicate from
+	 * @param DataObject $sourceObject the source object to duplicate from
 	 * @param $destinationObject the destination object to populate with the duplicated relations
 	 * @return DataObject with the new many_many relations copied in
 	 */
@@ -962,6 +962,7 @@ 
 	 * @param $includeRelations Boolean Merge any existing relations (optional)
 	 * @param $overwriteWithEmpty Boolean Overwrite existing left values with empty right values.
 	 *                            Only applicable with $priority='right'. (optional)
+	 * @param DataObject|null $rightObj
 	 * @return Boolean
 	 */
 	public function merge($rightObj, $priority = 'right', $includeRelations = true, $overwriteWithEmpty = false) {
@@ -1649,7 +1650,7 @@ 
 	/**
 	 * Find the foreign class of a relation on this DataObject, regardless of the relation type.
 	 *
-	 * @param $relationName Relation name.
+	 * @param string $relationName Relation name.
 	 * @return string Class name, or null if not found.
 	 */
 	public function getRelationClass($relationName) {
@@ -2225,6 +2226,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -3028,7 +3030,7 @@ 
 	 * Traverses to a field referenced by relationships between data objects, returning the value
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
-	 * @param $fieldName string
+	 * @param string $fieldName string
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3097,7 +3099,7 @@ 
 	 * @param string $callerClass The class of objects to be returned
 	 * @param string|array $filter A filter to be inserted into the WHERE clause.
 	 * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
-	 * @param string|array $sort A sort expression to be inserted into the ORDER
+	 * @param string $sort A sort expression to be inserted into the ORDER
 	 * BY clause.  If omitted, self::$default_sort will be used.
 	 * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
 	 * @param string|array $limit A limit expression to be inserted into the LIMIT clause.
@@ -3296,6 +3298,7 @@ 
 	/**
 	 * @see $sourceQueryParams
 	 * @param array
+	 * @param string $key
 	 */
 	public function setSourceQueryParam($key, $value) {
 		$this->sourceQueryParams[$key] = $value;
@@ -3303,6 +3306,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {