sminnee / silverstripe-framework

core/Extensible.php

Doc Comments +1 added lines, -1 removed lines

@@ -369,7 +369,7 @@
 	 *
 	 * @param string $method the method name to call
 	 * @param mixed $a1
-	 * @param mixed $a2
+	 * @param string $a2
 	 * @param mixed $a3
 	 * @param mixed $a4
 	 * @param mixed $a5

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() {

filesystem/flysystem/AssetAdapter.php

Doc Comments +4 added lines, -1 removed lines

@@ -37,6 +37,9 @@ 
         ]
 	);
 
+	/**
+	 * @param string $root
+	 */
 	public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) {
 		// Get root path
 		$root = $this->findRoot($root);
@@ -117,7 +120,7 @@ 
 	 * Render server configuration file from a template file
 	 *
 	 * @param string $template
-	 * @return \HTMLText Rendered results
+	 * @return string Rendered results
 	 */
 	protected function renderTemplate($template) {
 		// Build allowed extensions

filesystem/flysystem/ProtectedAssetAdapter.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      * Provide secure downloadable
      *
      * @param string $path
-     * @return string|null
+     * @return string
      */
     public function getProtectedUrl($path) {
         // Public URLs are handled via a request handler within /assets.

filesystem/ImageManipulation.php

Doc Comments +1 added lines, -1 removed lines

@@ -510,7 +510,7 @@
 	/**
 	 * Get HTML for img containing the icon for this file
 	 *
-	 * @return type
+	 * @return DBField
 	 */
 	public function IconTag() {
 		return DBField::create_field(

filesystem/storage/DBFile.php

Unused Use Statements -2 removed lines

@@ -6,13 +6,11 @@
 use SilverStripe\Filesystem\Storage\AssetContainer;
 use SilverStripe\Filesystem\Storage\AssetStore;
 use SilverStripe\Model\FieldType\DBComposite;
-
 use Injector;
 use AssetField;
 use File;
 use Director;
 use Permission;
-use ShortcodeHandler;
 use ValidationResult;
 use ValidationException;
 

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/Form.php

Doc Comments +12 added lines, -6 removed lines

@@ -498,7 +498,7 @@ 
 	 * The callback can opt out of handling specific responses by returning NULL,
 	 * in which case the default form behaviour will kick in.
 	 *
-	 * @param $callback
+	 * @param Closure $callback
 	 * @return self
 	 */
 	public function setValidationResponseCallback($callback) {
@@ -558,7 +558,7 @@ 
 	/**
 	 * Fields can have action to, let's check if anyone of the responds to $funcname them
 	 *
-	 * @param SS_List|array $fields
+	 * @param FieldList|null $fields
 	 * @param callable $funcName
 	 * @return FormField
 	 */
@@ -697,6 +697,7 @@ 
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 */
 	public function setValidationExemptActions($actions) {
 		$this->validationExemptActions = $actions;
@@ -836,6 +837,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string $name
 	 */
 	public function getAttribute($name) {
@@ -870,6 +872,7 @@ 
 	 *
 	 * @param array Custom attributes to process. Falls back to {@link getAttributes()}.
 	 * If at least one argument is passed as a string, all arguments act as excludes by name.
+	 * @param string $attrs
 	 *
 	 * @return string HTML attributes, ready for insertion into an HTML tag
 	 */
@@ -1077,7 +1080,7 @@ 
 	 * If set to false (the default), then the form method is only used to construct the default
 	 * form.
 	 *
-	 * @param $bool boolean
+	 * @param boolean $bool boolean
 	 * @return $this
 	 */
 	public function setStrictFormMethodCheck($bool) {
@@ -1592,7 +1595,7 @@ 
 	 * This is returned when you access a form as $FormObject rather
 	 * than <% with FormObject %>
 	 *
-	 * @return HTML
+	 * @return DBField
 	 */
 	public function forTemplate() {
 		$return = $this->renderWith(array_merge(
@@ -1612,7 +1615,7 @@ 
 	 * It triggers slightly different behaviour, such as disabling the rewriting
 	 * of # links.
 	 *
-	 * @return HTML
+	 * @return DBField
 	 */
 	public function forAjaxTemplate() {
 		$view = new SSViewer(array(
@@ -1635,7 +1638,7 @@ 
 	 * and _form_enctype.  These are the attributes of the form.  These fields
 	 * can be used to send the form to Ajax.
 	 *
-	 * @return HTML
+	 * @return string
 	 */
 	public function formHtmlContent() {
 		$this->IncludeFormTag = false;
@@ -1896,6 +1899,9 @@ 
 
 	protected $form;
 
+	/**
+	 * @param Form $form
+	 */
 	public function __construct($form) {
 		$this->form = $form;
 		parent::__construct();