silverstripe / silverstripe-framework

forms/TabSet.php

Doc Comments +6 added lines, -4 removed lines

@@ -29,8 +29,6 @@ 
 	
 	/**
 	 * @param string $name Identifier
-	 * @param string $title (Optional) Natural language title of the tabset
-	 * @param Tab|TabSet $unknown All further parameters are inserted as children into the TabSet
 	 */
 	public function __construct($name) {
 		$args = func_get_args();
@@ -148,8 +146,8 @@ 
 	/**
 	 * Inserts a field before a particular field in a FieldList.
 	 *
-	 * @param FormField $item The form field to insert
-	 * @param string $name Name of the field to insert before
+	 * @param TextField $field
+	 * @param string $insertBefore
 	 */
 	public function insertBefore($field, $insertBefore) {
 		parent::insertBefore($field, $insertBefore);
@@ -157,6 +155,10 @@ 
 		$this->sequentialSet = null;
 	}
 	
+	/**
+	 * @param TextField $field
+	 * @param string $insertAfter
+	 */
 	public function insertAfter($field, $insertAfter) {
 		parent::insertAfter($field, $insertAfter);
 		if($field instanceof Tab) $field->setTabSet($this);

forms/TreeDropdownField.php

Doc Comments +3 added lines, -4 removed lines

@@ -75,7 +75,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
@@ -203,7 +203,7 @@ 
 	}
 
 	/**
-	 * @return string
+	 * @return HTMLText
 	 */
 	public function Field($properties = array()) {
 		Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang');
@@ -384,7 +384,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;
@@ -435,7 +435,6 @@ 
 	}
 
 	/**
-	 * @param String $field
 	 */
 	public function setSourceObject($class) {
 		$this->sourceObject = $class;

forms/UploadField.php

Doc Comments +3 added lines, -5 removed lines

@@ -194,7 +194,6 @@ 
 	 * @param string $title The field label.
 	 * @param SS_List $items If no items are defined, the field will try to auto-detect an existing relation on
 	 *                       @link $record}, with the same name as the field name.
-	 * @param Form $form Reference to the container form
 	 */
 	public function __construct($name, $title = null, SS_List $items = null) {
 		
@@ -600,7 +599,6 @@ 
 	 * for each of these categories
 	 * 
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return UploadField Self reference
 	 */
 	public function setAllowedFileCategories($category) {
@@ -1086,7 +1084,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return UploadField_ItemHandler
+	 * @return UploadField_SelectHandler
 	 */
 	public function handleSelect(SS_HTTPRequest $request) {
 		if(!$this->canAttachExisting()) return $this->httpError(403);
@@ -1380,7 +1378,7 @@ 
 
 	/**
 	 * @param UploadFIeld $parent
-	 * @param int $item
+	 * @param int $itemID
 	 */
 	public function __construct($parent, $itemID) {
 		$this->parent = $parent;
@@ -1449,7 +1447,7 @@ 
 	 * Action to handle editing of a single file
 	 * 
 	 * @param SS_HTTPRequest $request
-	 * @return ViewableData_Customised
+	 * @return HTMLText
 	 */
 	public function edit(SS_HTTPRequest $request) {
 		// Check form field state

forms/Validator.php

Doc Comments +1 added lines

@@ -109,6 +109,7 @@
 	 * Used by FormField to return a value for FormField::Required(), to do things like show *s on the form template.
 	 *
 	 * By default, it always returns false.
+	 * @param string $fieldName
 	 */
 	public function fieldIsRequired($fieldName) {
 		return false;

model/Aggregate.php

Doc Comments +2 added lines, -1 removed lines

@@ -47,6 +47,7 @@ 
 	/** 
 	 * Clear the aggregate cache for a given type, or pass nothing to clear all aggregate caches.
 	 * {@link $class} is just effective if the cache backend supports tags.
+	 * @param string $class
 	 */
 	public static function flushCache($class=null) {
 		$cache = self::cache();
@@ -92,7 +93,7 @@ 
 	 * Build the SQLQuery to calculate the aggregate
 	 * This is a seperate function so that subtypes of Aggregate can change just this bit
 	 * @param string $attr - the SQL field statement for selection (i.e. "MAX(LastUpdated)")
-	 * @return SQLQuery
+	 * @return DataList
 	 */
 	protected function query($attr) {
 		$query = DataList::create($this->type)->where($this->filter);

model/ArrayList.php

Doc Comments +6 added lines, -7 removed lines

@@ -295,8 +295,8 @@ 
 	/**
 	 * Find the first item of this list where the given key = value
 	 *
-	 * @param type $key
-	 * @param type $value
+	 * @param string $key
+	 * @param string $value
 	 * @return type 
 	 */
 	public function find($key, $value) {
@@ -387,7 +387,7 @@ 
 	 * 
 	 * Note that columns may be double quoted as per ANSI sql standard
 	 *
-	 * @return DataList
+	 * @return ArrayList
 	 * @see SS_List::sort()
 	 * @example $list->sort('Name'); // default ASC sorting
 	 * @example $list->sort('Name DESC'); // DESC sorting
@@ -523,6 +523,9 @@ 
 		return $list;
 	}
 	
+	/**
+	 * @param integer $id
+	 */
 	public function byID($id) {
 		$firstElement = $this->filter("ID", $id)->first();
 
@@ -624,7 +627,6 @@ 
 	/**
 	 * Returns whether an item with $key exists
 	 * 
-	 * @param mixed $key
 	 * @return bool
 	 */
 	public function offsetExists($offset) {
@@ -634,7 +636,6 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 * 
-	 * @param mixed $key
 	 * @return DataObject
 	 */
 	public function offsetGet($offset) {
@@ -644,7 +645,6 @@ 
 	/**
 	 * Set an item with the key in $key
 	 * 
-	 * @param mixed $key
 	 * @param mixed $value
 	 */
 	public function offsetSet($offset, $value) {
@@ -658,7 +658,6 @@ 
 	/**
 	 * Unset an item with the key in $key
 	 * 
-	 * @param mixed $key
 	 */
 	public function offsetUnset($offset) {
 		unset($this->items[$offset]);

model/Database.php

Doc Comments +32 added lines, -1 removed lines

@@ -145,6 +145,8 @@ 
 	
 	/**
 	 * Returns the enum values available on the given field
+	 * @param string $tableName
+	 * @param string $fieldName
 	 */
 	abstract public function enumValuesForField($tableName, $fieldName);
 	
@@ -255,6 +257,7 @@ 
 	/**
 	 * @param string $table
 	 * @param string $options
+	 * @param boolean $advanced_options
 	 */
 	public function transCreateTable($table, $options = null, $advanced_options = null) {
 		$this->schemaUpdateTransaction[$table] = array(
@@ -269,6 +272,7 @@ 
 	/**
 	 * @param string $table
 	 * @param array $options
+	 * @param boolean $advanced_options
 	 */
 	public function transAlterTable($table, $options, $advanced_options) {
 		$this->transInitTable($table);
@@ -276,18 +280,35 @@ 
 		$this->schemaUpdateTransaction[$table]['advancedOptions'] = $advanced_options;
 	}
 	
+	/**
+	 * @param string $table
+	 * @param string $field
+	 */
 	public function transCreateField($table, $field, $schema) {
 		$this->transInitTable($table);
 		$this->schemaUpdateTransaction[$table]['newFields'][$field] = $schema;
 	}
+
+	/**
+	 * @param string $table
+	 */
 	public function transCreateIndex($table, $index, $schema) {
 		$this->transInitTable($table);
 		$this->schemaUpdateTransaction[$table]['newIndexes'][$index] = $schema;
 	}
+
+	/**
+	 * @param string $table
+	 * @param string $field
+	 */
 	public function transAlterField($table, $field, $schema) {
 		$this->transInitTable($table);
 		$this->schemaUpdateTransaction[$table]['alteredFields'][$field] = $schema;
 	}
+
+	/**
+	 * @param string $table
+	 */
 	public function transAlterIndex($table, $index, $schema) {
 		$this->transInitTable($table);
 		$this->schemaUpdateTransaction[$table]['alteredIndexes'][$index] = $schema;
@@ -319,7 +340,7 @@ 
 	 * @param string $table The name of the table
 	 * @param string $fieldSchema A list of the fields to create, in the same form as DataObject::$db
 	 * @param string $indexSchema A list of indexes to create. See {@link requireIndex()}
-	 * @param array $options
+	 * @param string|null $options
 	 */
 	public function requireTable($table, $fieldSchema = null, $indexSchema = null, $hasAutoIncPK=true,
 			$options = Array(), $extensions=false) {
@@ -786,6 +807,7 @@ 
 	 * Returns the WHERE clauses ready for inserting into a query.
 	 * Caution: Expects correctly quoted and escaped SQL fragments.
 	 * 
+	 * @param string $connective
 	 * @return string
 	 */
 	public function sqlWhereToString($where, $connective) {
@@ -944,6 +966,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
 	 */
@@ -956,6 +979,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
 	 */
@@ -986,6 +1010,10 @@ 
 	/*
 	 * Create a savepoint that you can jump back to if you encounter problems
 	 */
+
+	/**
+	 * @param string $savepoint
+	 */
 	abstract public function transactionSavepoint($savepoint);
 
 	/*
@@ -1015,6 +1043,7 @@ 
 	 * Returns if the lock is available.
 	 * See {@link supportsLocks()} to check if locking is generally supported.
 	 * 
+	 * @param string $name
 	 * @return Boolean
 	 */
 	public function canLock($name) {
@@ -1036,6 +1065,7 @@ 
 	 * 
 	 * @param String
 	 * @param Int Timeout in seconds
+	 * @param string $name
 	 * @return Boolean
 	 */
 	public function getLock($name, $timeout = 5) {
@@ -1047,6 +1077,7 @@ 
 	 * (if the execution aborts (e.g. due to an error) all locks are automatically released).
 	 * 
 	 * @param String
+	 * @param string $name
 	 * @return Boolean
 	 */
 	public function releaseLock($name) {

model/DataDifferencer.php

Doc Comments +2 added lines, -1 removed lines

@@ -46,7 +46,8 @@
 	 * If $fromRecord is null, this will represent a "creation".
 	 * 
 	 * @param DataObject (Optional)
-	 * @param DataObject 
+	 * @param DataObject
+	 * @param DataObject|null $fromRecord 
 	 */
 	public function __construct($fromRecord, DataObject $toRecord) {
 		if(!$toRecord) user_error("DataDifferencer constructed without a toRecord", E_USER_WARNING);

model/DataList.php

Doc Comments +10 added lines, -7 removed lines

@@ -153,6 +153,9 @@ 
 		return $clone;
 	}
 
+	/**
+	 * @param string $val
+	 */
 	public function setDataQueryParam($keyOrArray, $val = null) {
 		$clone = clone $this;
 
@@ -171,7 +174,7 @@ 
 	/**
 	 * Returns the SQL query that will be used to get this DataList's records.  Good for debugging. :-)
 	 * 
-	 * @return SQLQuery
+	 * @return string
 	 */
 	public function sql() {
 		return $this->dataQuery->query()->sql();
@@ -716,7 +719,7 @@ 
 	 * Return the maximum value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function max($fieldName) {
 		return $this->dataQuery->max($fieldName);
@@ -726,7 +729,7 @@ 
 	 * Return the minimum value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function min($fieldName) {
 		return $this->dataQuery->min($fieldName);
@@ -736,7 +739,7 @@ 
 	 * Return the average value of the given field in this DataList
 	 * 
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function avg($fieldName) {
 		return $this->dataQuery->avg($fieldName);
@@ -746,7 +749,7 @@ 
 	 * Return the sum of the values of the given field in this DataList
 	 * 
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function sum($fieldName) {
 		return $this->dataQuery->sum($fieldName);
@@ -817,7 +820,7 @@ 
 	/**
 	 * Restrict the columns to fetch into this DataList
 	 *
-	 * @param array $queriedColumns
+	 * @param string[] $queriedColumns
 	 * @return DataList
 	 */
 	public function setQueriedColumns($queriedColumns) {
@@ -1093,7 +1096,7 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 * 
-	 * @param mixed $key
+	 * @param integer $key
 	 * @return DataObject
 	 */
 	public function offsetGet($key) {