silverstripe / silverstripe-framework

admin/code/AddToCampaignHandler.php

Doc Comments -1 removed lines

@@ -60,7 +60,6 @@
 	/**
 	 * AddToCampaignHandler constructor.
 	 *
-	 * @param Controller $parentController Controller for this form
 	 * @param array|DataObject $data The data submitted as part of that form
 	 * @param string $name Form name
 	 */

forms/FormSchema.php

Doc Comments +3 added lines

@@ -77,6 +77,9 @@
 		return $state;
 	}
 
+	/**
+	 * @param \FieldList|null $fields
+	 */
 	protected function getFieldStates($fields) {
 		$states = [];
 		foreach ($fields as $field) {

admin/code/LeftAndMain.php

Doc Comments +4 added lines, -4 removed lines

@@ -258,7 +258,7 @@ 
 	/**
 	 * Gets the combined configuration of all LeafAndMain subclasses required by the client app.
 	 *
-	 * @return array
+	 * @return string
 	 *
 	 * WARNING: Experimental API
 	 */
@@ -691,7 +691,7 @@ 
 	 *
 	 * @param string $url
 	 * @param int $code
-	 * @return SS_HTTPResponse|string
+	 * @return string|null
 	 */
 	public function redirect($url, $code=302) {
 		if($this->getRequest()->isAjax()) {
@@ -969,7 +969,7 @@ 
 	 * {@link SSViewer::get_templates_by_class()}
 	 *
 	 * @param string $suffix
-	 * @return array
+	 * @return string
 	 */
 	public function getTemplatesWithSuffix($suffix) {
 		$templates = SSViewer::get_templates_by_class(get_class($this), $suffix, __CLASS__);
@@ -2039,7 +2039,7 @@ 
 	}
 
 	/**
-	 * @return String
+	 * @return DBField
 	 */
 	public function Locale() {
 		return DBField::create_field('Locale', i18n::get_locale());

api/RSSFeed.php

Doc Comments +1 added lines

@@ -227,6 +227,7 @@
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string|null $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;

core/ClassInfo.php

Doc Comments +6 added lines, -1 removed lines

@@ -46,6 +46,7 @@ 
 
 	/**
 	 * @todo Move this to SS_Database or DB
+	 * @param string $class
 	 */
 	public static function hasTable($class) {
 		// Cache the list of all table names to reduce on DB traffic
@@ -87,7 +88,7 @@ 
 	 *
 	 * @todo Move this into {@see DataObjectSchema}
 	 *
-	 * @param string|object $nameOrObject Class or object instance
+	 * @param string $nameOrObject Class or object instance
 	 * @return array
 	 */
 	public static function dataClassesFor($nameOrObject) {
@@ -214,6 +215,7 @@ 
 
 	/**
 	 * Returns true if the given class implements the given interface
+	 * @param string $interfaceName
 	 */
 	public static function classImplements($className, $interfaceName) {
 		return in_array($className, self::implementorsOf($interfaceName));
@@ -264,6 +266,9 @@ 
 
 	private static $method_from_cache = array();
 
+	/**
+	 * @param string $method
+	 */
 	public static function has_method_from($class, $method, $compclass) {
 		$lClass = strtolower($class);
 		$lMethod = strtolower($method);

core/manifest/ClassManifest.php

Doc Comments +1 added lines, -1 removed lines

@@ -235,7 +235,7 @@
 	 * Returns an array containing all the descendants (direct and indirect)
 	 * of a class.
 	 *
-	 * @param  string|object $class
+	 * @param  string $class
 	 * @return array
 	 */
 	public function getDescendantsOf($class) {

forms/FieldList.php

Doc Comments +9 added lines, -2 removed lines

@@ -127,6 +127,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();
@@ -166,7 +167,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();
@@ -449,6 +450,7 @@ 
 
 	/**
 	 * Handler method called before the FieldList is going to be manipulated.
+	 * @param FormField $item
 	 */
 	protected function onBeforeInsert($item) {
 		$this->flushFieldsCache();
@@ -521,6 +523,7 @@ 
 	 * Transform this FieldList with a given tranform method,
 	 * e.g. $this->transform(new ReadonlyTransformation())
 	 *
+	 * @param ReadonlyTransformation $trans
 	 * @return FieldList
 	 */
 	public function transform($trans) {
@@ -540,6 +543,9 @@ 
 		else return $this;
 	}
 
+	/**
+	 * @param CompositeField $field
+	 */
 	public function setContainerField($field) {
 		$this->containerField = $field;
 		return $this;
@@ -607,6 +613,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.
 	 */
@@ -654,7 +661,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/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -76,7 +76,7 @@ 
 	 * @param GridField $gridField
 	 * @param DataObject $record
 	 * @param string $columnName
-	 * @return string The HTML for the column
+	 * @return DBHTMLText The HTML for the column
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		// No permission checks, handled through GridFieldDetailForm,

search/filters/SearchFilter.php

Doc Comments +3 added lines, -3 removed lines

@@ -60,7 +60,7 @@ 
 	 *  column. Can contain a relation name in dot notation, which will automatically join
 	 *  the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and
 	 *  search the "Name" column when applying this filter to a SiteTree class).
-	 * @param mixed $value
+	 * @param string $value
 	 * @param array $modifiers
 	 */
 	public function __construct($fullName = null, $value = false, array $modifiers = array()) {
@@ -140,7 +140,7 @@ 
 	/**
 	 * Gets supported modifiers for this filter
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getSupportedModifiers()
 	{
@@ -321,7 +321,7 @@ 
 	/**
 	 * Determines case sensitivity based on {@link getModifiers()}.
 	 *
-	 * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
+	 * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
 	 */
 	protected function getCaseSensitive() {
 		$modifiers = $this->getModifiers();