silverstripe / silverstripe-framework

forms/FileField.php

Doc Comments +1 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(
@@ -249,7 +249,6 @@ 
 	 * for each of these categories
 	 *
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return $this
 	 */
 	public function setAllowedFileCategories($category) {

admin/code/CMSMenu.php

Doc Comments +5 added lines, -3 removed lines

@@ -86,7 +86,7 @@ 
 	 *                          left.
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean The result of the operation.
+	 * @return boolean|null The result of the operation.
 	 */
 	public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null) {
 		return self::add_menu_item($code, $menuTitle, $url, null, $priority, $attributes);
@@ -107,7 +107,7 @@ 
 	 * @param int $priority
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function add_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 											$attributes = null) {
@@ -239,7 +239,7 @@ 
 	 * @param int $priority
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function replace_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 												$attributes = null) {
@@ -258,6 +258,8 @@ 
 
 	/**
 	 * Add a previously built menu item object to the menu
+	 * @param string $code
+	 * @param CMSMenuItem $cmsMenuItem
 	 */
 	protected static function add_menu_item_obj($code, $cmsMenuItem) {
 		self::$menu_item_changes[] = array(

core/Config.php

Doc Comments +24 added lines, -1 removed lines

@@ -470,11 +470,17 @@ 
 
 	protected $extraConfigSources = array();
 
+	/**
+	 * @param string $class
+	 */
 	public function extraConfigSourcesChanged($class) {
 		unset($this->extraConfigSources[$class]);
 		$this->cache->clean("__{$class}");
 	}
 
+	/**
+	 * @param integer $sourceOptions
+	 */
 	protected function getUncached($class, $name, $sourceOptions, &$result, $suppress, &$tags) {
 		$tags[] = "__{$class}";
 		$tags[] = "__{$class}__{$name}";
@@ -604,7 +610,7 @@ 
 	 *
 	 * @param string $class The class to update a configuration value for
 	 * @param string $name  The configuration property name to update
-	 * @param mixed $value The value to update with
+	 * @param mixed $val The value to update with
 	 *
 	 * Arrays are recursively merged into current configuration as "latest" - for associative arrays the passed value
 	 * replaces any item with the same key, for sequential arrays the items are placed at the end of the array, for
@@ -728,6 +734,10 @@ 
 		$this->cache = $cloned;
 	}
 
+	/**
+	 * @param integer $key
+	 * @param integer $val
+	 */
 	public function set($key, $val, $tags = array()) {
 		// Find an index to set at
 		$replacing = null;
@@ -796,6 +806,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if ($tag) {
 			foreach ($this->cache as $i => $v) {
@@ -827,6 +840,10 @@ 
 		$this->cache = array();
 	}
 
+	/**
+	 * @param integer $key
+	 * @param integer $val
+	 */
 	public function set($key, $val, $tags = array()) {
 		foreach($tags as $t) {
 			if(!isset($this->tags[$t])) {
@@ -845,6 +862,9 @@ 
 		return $this->miss ? ($this->hit / $this->miss) : 0;
 	}
 
+	/**
+	 * @param integer $key
+	 */
 	public function get($key) {
 		list($hit, $result) = $this->checkAndGet($key);
 		return $hit ? $result : false;
@@ -864,6 +884,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if($tag) {
 			if(isset($this->tags[$tag])) {

forms/FieldList.php

Doc Comments +9 added lines, -2 removed lines

@@ -133,7 +133,7 @@ 
 	 * @param string $tabName The name of the tab or tabset.  Subtabs can be referred to as TabSet.Tab
 	 *                        or TabSet.Tab.Subtab. This function will create any missing tabs.
 	 * @param array $fields An array of {@link FormField} objects.
-	 * @param string $name Name of the field to insert before (optional)
+	 * @param string $insertBefore
 	 */
 	public function addFieldsToTab($tabName, $fields, $insertBefore = null) {
 		$this->flushFieldsCache();
@@ -173,7 +173,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();
@@ -453,6 +453,7 @@ 
 
 	/**
 	 * Handler method called before the FieldList is going to be manipulated.
+	 * @param FormField $item
 	 */
 	protected function onBeforeInsert($item) {
 		$this->flushFieldsCache();
@@ -525,6 +526,7 @@ 
 	 * Transform this FieldList with a given tranform method,
 	 * e.g. $this->transform(new ReadonlyTransformation())
 	 *
+	 * @param ReadonlyTransformation $trans
 	 * @return FieldList
 	 */
 	public function transform($trans) {
@@ -544,6 +546,9 @@ 
 		else return $this;
 	}
 
+	/**
+	 * @param CompositeField $field
+	 */
 	public function setContainerField($field) {
 		$this->containerField = $field;
 		return $this;
@@ -562,6 +567,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;
@@ -616,6 +622,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.
 	 */

forms/FormField.php

Doc Comments +2 added lines, -1 removed lines

@@ -540,6 +540,7 @@ 
 	 *
 	 * Caution: this doesn't work on all fields, see {@link setAttribute()}.
 	 *
+	 * @param string $name
 	 * @return null|string
 	 */
 	public function getAttribute($name) {
@@ -1201,7 +1202,7 @@ 
 	 *
 	 * @param FieldList $containerFieldList
 	 *
-	 * @return FieldList
+	 * @return FormField
 	 */
 	public function setContainerFieldList($containerFieldList) {
 		$this->containerFieldList = $containerFieldList;

forms/gridfield/GridFieldDataColumns.php

Doc Comments +1 added lines

@@ -70,6 +70,7 @@
 	/**
 	 * Get the DisplayFields
 	 *
+	 * @param GridField $gridField
 	 * @return array
 	 * @see GridFieldDataColumns::setDisplayFields
 	 */

forms/gridfield/GridFieldSortableHeader.php

Doc Comments +2 added lines

@@ -29,6 +29,7 @@ 
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -44,6 +45,7 @@ 
 	/**
 	 * Check that this dataList is of the right data type.
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
+	 * @param SS_List $dataList
 	 */
 	protected function checkDataType($dataList) {
 		if($dataList instanceof SS_Sortable) {

forms/HtmlEditorSanitiser.php

Doc Comments +2 added lines, -2 removed lines

@@ -39,7 +39,7 @@ 
 	/**
 	 * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
 	 *
-	 * @param $str - The TinyMCE pattern
+	 * @param string|null $str - The TinyMCE pattern
 	 * @return string - The equivalent regex
 	 */
 	protected function patternToRegex($str) {
@@ -181,7 +181,7 @@ 
 	/**
 	 * Given an attribute name, return the rule structure for that attribute
 	 *
-	 * @param object $elementRule
+	 * @param stdClass $elementRule
 	 * @param string $name The attribute name
 	 * @return stdClass The attribute rule
 	 */

forms/TreeDropdownField.php

Doc Comments +2 added lines, -3 removed lines

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