Completed
Pull Request — master (#5771)
by Florian
12:04
created
forms/CompositeField.php 1 patch
Doc Comments   +8 added lines patch added patch discarded remove patch
@@ -94,6 +94,7 @@  discard block
 block discarded – undo
94 94
 
95 95
 	/**
96 96
 	 * @param string
97
+	 * @param string $tag
97 98
 	 */
98 99
 	public function setTag($tag) {
99 100
 		$this->tag = $tag;
@@ -110,6 +111,7 @@  discard block
 block discarded – undo
110 111
 
111 112
 	/**
112 113
 	 * @param string
114
+	 * @param string $legend
113 115
 	 */
114 116
 	public function setLegend($legend) {
115 117
 		$this->legend = $legend;
@@ -200,6 +202,9 @@  discard block
 block discarded – undo
200 202
 		return false;
201 203
 	}
202 204
 
205
+	/**
206
+	 * @param string $name
207
+	 */
203 208
 	public function fieldByName($name) {
204 209
 		return $this->children->fieldByName($name);
205 210
 	}
@@ -224,6 +229,8 @@  discard block
 block discarded – undo
224 229
 
225 230
 	/**
226 231
 	 * @uses FieldList->insertAfter()
232
+	 * @param string $insertAfter
233
+	 * @param FormField $field
227 234
 	 */
228 235
 	public function insertAfter($insertAfter, $field) {
229 236
 		$ret = $this->children->insertAfter($insertAfter, $field);
@@ -309,6 +316,7 @@  discard block
 block discarded – undo
309 316
 	 * the children collection. Doesn't work recursively.
310 317
 	 *
311 318
 	 * @param string|FormField
319
+	 * @param string $field
312 320
 	 * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't
313 321
 	 *             be found.
314 322
 	 */
Please login to merge, or discard this patch.
forms/ConfirmedPasswordField.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -120,7 +120,7 @@  discard block
 block discarded – undo
120 120
 	/**
121 121
 	 * @param array $properties
122 122
 	 *
123
-	 * @return HTMLText
123
+	 * @return string
124 124
 	 */
125 125
 	public function Field($properties = array()) {
126 126
 		Requirements::javascript(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js');
@@ -417,7 +417,7 @@  discard block
 block discarded – undo
417 417
 	 *
418 418
 	 * @param DataObjectInterface $record
419 419
 	 *
420
-	 * @return boolean
420
+	 * @return false|null
421 421
 	 */
422 422
 	public function saveInto(DataObjectInterface $record) {
423 423
 		if(!$this->isSaveable()) {
Please login to merge, or discard this patch.
forms/DateField.php 1 patch
Doc Comments   +9 added lines, -1 removed lines patch added patch discarded remove patch
@@ -90,6 +90,11 @@  discard block
 block discarded – undo
90 90
 	 */
91 91
 	protected $valueObj = null;
92 92
 
93
+	/**
94
+	 * @param string $name
95
+	 * @param string $title
96
+	 * @param string $value
97
+	 */
93 98
 	public function __construct($name, $title = null, $value = null) {
94 99
 		if(!$this->locale) {
95 100
 			$this->locale = i18n::get_locale();
@@ -288,6 +293,9 @@  discard block
 block discarded – undo
288 293
 		return $field;
289 294
 	}
290 295
 
296
+	/**
297
+	 * @param string $class
298
+	 */
291 299
 	public function castedCopy($class) {
292 300
 		$copy = new $class($this->name);
293 301
 		if($copy->hasMethod('setConfig')) {
@@ -326,7 +334,7 @@  discard block
 block discarded – undo
326 334
 	 * @deprecated 4.0 Use the "DateField.default_config" config setting instead
327 335
 	 * @param String $k
328 336
 	 * @param mixed $v
329
-	 * @return boolean
337
+	 * @return boolean|null
330 338
 	 */
331 339
 	public static function set_default_config($k, $v) {
332 340
 		Deprecation::notice('4.0', 'Use the "DateField.default_config" config setting instead');
Please login to merge, or discard this patch.
forms/FileField.php 1 patch
Doc Comments   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -85,7 +85,7 @@  discard block
 block discarded – undo
85 85
 
86 86
 	/**
87 87
 	 * @param array $properties
88
-	 * @return HTMLText
88
+	 * @return string
89 89
 	 */
90 90
 	public function Field($properties = array()) {
91 91
 		$properties = array_merge($properties, array(
@@ -249,7 +249,6 @@  discard block
 block discarded – undo
249 249
 	 * for each of these categories
250 250
 	 *
251 251
 	 * @param string $category Category name
252
-	 * @param string,... $categories Additional category names
253 252
 	 * @return $this
254 253
 	 */
255 254
 	public function setAllowedFileCategories($category) {
Please login to merge, or discard this patch.
forms/FormAction.php 1 patch
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -76,7 +76,7 @@  discard block
 block discarded – undo
76 76
 
77 77
 	/**
78 78
 	 * @param array $properties
79
-	 * @return HTMLText
79
+	 * @return string
80 80
 	 */
81 81
 	public function Field($properties = array()) {
82 82
 		$properties = array_merge(
@@ -93,7 +93,7 @@  discard block
 block discarded – undo
93 93
 
94 94
 	/**
95 95
 	 * @param array $properties
96
-	 * @return HTMLText
96
+	 * @return string
97 97
 	 */
98 98
 	public function FieldHolder($properties = array()) {
99 99
 		return $this->Field($properties);
@@ -157,6 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * Enable or disable the rendering of this action as a <button />
158 158
 	 *
159 159
 	 * @param boolean
160
+	 * @param boolean $bool
160 161
 	 * @return $this
161 162
 	 */
162 163
 	public function setUseButtonTag($bool) {
Please login to merge, or discard this patch.
forms/FormScaffolder.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -49,7 +49,6 @@
 block discarded – undo
49 49
 
50 50
 	/**
51 51
 	 * @param DataObject $obj
52
-	 * @param array $params
53 52
 	 */
54 53
 	public function __construct($obj) {
55 54
 		$this->obj = $obj;
Please login to merge, or discard this patch.
forms/gridfield/GridFieldAddExistingAutocompleter.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -129,7 +129,7 @@
 block discarded – undo
129 129
 	/**
130 130
 	 *
131 131
 	 * @param GridField $gridField
132
-	 * @return array
132
+	 * @return string[]
133 133
 	 */
134 134
 	public function getActions($gridField) {
135 135
 		return array('addto');
Please login to merge, or discard this patch.
forms/gridfield/GridFieldComponent.php 1 patch
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -33,6 +33,7 @@  discard block
 block discarded – undo
33 33
 	 * If you attempt to return HTML for a fragment that doesn't exist, an
34 34
 	 * exception will be thrown when the {@link GridField} is rendered.
35 35
 	 *
36
+	 * @param GridField $gridField
36 37
 	 * @return array
37 38
 	 */
38 39
 	public function getHTMLFragments($gridField);
@@ -57,6 +58,7 @@  discard block
 block discarded – undo
57 58
 	 * @param GridField $gridField
58 59
 	 * @param arary $columns List of columns
59 60
 	 * @param array - List reference of all column names.
61
+	 * @return void
60 62
 	 */
61 63
 	public function augmentColumns($gridField, &$columns);
62 64
 
@@ -139,6 +141,7 @@  discard block
 block discarded – undo
139 141
 	 * @param String Action identifier, see {@link getActions()}.
140 142
 	 * @param Array Arguments relevant for this
141 143
 	 * @param Array All form data
144
+	 * @param string $actionName
142 145
 	 */
143 146
 	public function handleAction(GridField $gridField, $actionName, $arguments, $data);
144 147
 }
@@ -189,6 +192,7 @@  discard block
 block discarded – undo
189 192
 	 *
190 193
 	 * Handler methods will be called on the component, rather than the
191 194
 	 * {@link GridField}.
195
+	 * @param GridField $gridField
192 196
 	 */
193 197
 	public function getURLHandlers($gridField);
194 198
 }
@@ -205,7 +209,6 @@  discard block
 block discarded – undo
205 209
 	/**
206 210
 	 * Called when a grid field is saved - i.e. the form is submitted.
207 211
 	 *
208
-	 * @param GridField $field
209 212
 	 * @param DataObjectInterface $record
210 213
 	 */
211 214
 	public function handleSave(GridField $grid, DataObjectInterface $record);
Please login to merge, or discard this patch.
forms/gridfield/GridFieldConfig.php 1 patch
Doc Comments   +2 added lines patch added patch discarded remove patch
@@ -78,6 +78,7 @@  discard block
 block discarded – undo
78 78
 
79 79
 	/**
80 80
 	 * @param String Class name or interface
81
+	 * @param string $type
81 82
 	 * @return GridFieldConfig $this
82 83
 	 */
83 84
 	public function removeComponentsByType($type) {
@@ -116,6 +117,7 @@  discard block
 block discarded – undo
116 117
 	 * Returns the first available component with the given class or interface.
117 118
 	 *
118 119
 	 * @param String ClassName
120
+	 * @param string $type
119 121
 	 * @return GridFieldComponent
120 122
 	 */
121 123
 	public function getComponentByType($type) {
Please login to merge, or discard this patch.