silverstripe / silverstripe-framework

forms/TabSet.php

Doc Comments -2 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();

forms/TextField.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
 	}
 
 	/**
-	 * @return null|int
+	 * @return integer
 	 */
 	public function getMaxLength() {
 		return $this->maxLength;

forms/TimeField.php

Doc Comments +7 added lines

@@ -50,6 +50,10 @@ 
 	 */
 	protected $valueObj = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -228,6 +232,9 @@ 
 		return $this->castedCopy('TimeField_Readonly');
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = parent::castedCopy($class);
 		if($copy->hasMethod('setConfig')) {

forms/TreeDropdownField.php

Doc Comments +2 added lines, -3 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
@@ -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;

forms/UploadField.php

Doc Comments +2 added lines, -3 removed lines

@@ -211,7 +211,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) {
 
@@ -1078,7 +1077,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return UploadField_ItemHandler
+	 * @return UploadField_SelectHandler
 	 */
 	public function handleSelect(SS_HTTPRequest $request) {
 		if(!$this->canAttachExisting()) return $this->httpError(403);
@@ -1434,7 +1433,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, -1 removed lines

@@ -37,7 +37,7 @@
 	/**
 	 * Returns any errors there may be.
 	 *
-	 * @return null|array
+	 * @return string
 	 */
 	public function validate() {
 		$this->errors = null;

i18n/i18n.php

Doc Comments +5 added lines, -2 removed lines

@@ -118,7 +118,7 @@ 
 
 	/**
 	 * Return an instance of the cache used for i18n data.
-	 * @return Zend_Cache
+	 * @return Zend_Cache_Core
 	 */
 	public static function get_cache() {
 		return SS_Cache::factory('i18n', 'Output', array('lifetime' => null, 'automatic_serialization' => true));
@@ -2156,6 +2156,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $name
 	 * @return Zend_Translate
 	 */
 	public static function get_translator($name) {
@@ -2169,6 +2170,7 @@ 
 	 * @param Zend_Translate Needs to implement {@link i18nTranslateAdapterInterface}
 	 * @param String If left blank will override the default translator.
 	 * @param Int
+	 * @param string $name
 	 */
 	public static function register_translator($translator, $name, $priority = 10) {
 		if (!is_int($priority)) throw new InvalidArgumentException("register_translator expects an int priority");
@@ -2298,7 +2300,7 @@ 
 	 *
 	 * @see get_locale_name()
 	 *
-	 * @param mixed $code Language code
+	 * @param string $code Language code
 	 * @param boolean $native If true, the native name will be returned
 	 * @return Name of the language
 	 */
@@ -2455,6 +2457,7 @@ 
 	 *
 	 * Note: Does not check for {@link $allowed_locales}.
 	 *
+	 * @param string $locale
 	 * @return boolean
 	 */
 	public static function validate_locale($locale) {

i18n/i18nTextCollector.php

Doc Comments +6 added lines, -1 removed lines

@@ -712,7 +712,8 @@ 
 	 * Input for langArrayCodeForEntitySpec() should be suitable for insertion
 	 * into single-quoted strings, so needs to be escaped already.
 	 *
-	 * @param string $entity The entity name, e.g. CMSMain.BUTTONSAVE
+	 * @param string $entitySpec The entity name, e.g. CMSMain.BUTTONSAVE
+	 * @param string $locale
 	 */
 	public function langArrayCodeForEntitySpec($entityFullName, $entitySpec, $locale) {
 		$php = '';
@@ -775,6 +776,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	public function getYaml($entities, $locale) {
 		// Unflatten array
 		$entitiesNested = array();
@@ -843,6 +847,7 @@ 
 
 	/**
 	 * Parses a template and returns any translatable entities
+	 * @param string $template
 	 */
 	public static function GetTranslatables($template) {
 		self::$entities = array();

model/ArrayList.php

Doc Comments +4 added lines, -5 removed lines

@@ -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]);