Skip to content

Commit 66ffec0

Browse files
Cleanup @return annotations
1 parent b6cd2fe commit 66ffec0

12 files changed

+18
-18
lines changed

AbstractExtension.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public function getTypeGuesser()
115115
/**
116116
* Registers the types.
117117
*
118-
* @return FormTypeInterface[] An array of FormTypeInterface instances
118+
* @return FormTypeInterface[]
119119
*/
120120
protected function loadTypes()
121121
{
@@ -125,7 +125,7 @@ protected function loadTypes()
125125
/**
126126
* Registers the type extensions.
127127
*
128-
* @return FormTypeExtensionInterface[] An array of FormTypeExtensionInterface instances
128+
* @return FormTypeExtensionInterface[]
129129
*/
130130
protected function loadTypeExtensions()
131131
{

Button.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ public function getExtraData()
245245
/**
246246
* Returns the button's configuration.
247247
*
248-
* @return FormConfigInterface The configuration instance
248+
* @return FormConfigInterface
249249
*/
250250
public function getConfig()
251251
{

Extension/Core/DataTransformer/DateIntervalToStringTransformer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public function transform($value)
6262
*
6363
* @param string $value An ISO 8601 or date string like date interval presentation
6464
*
65-
* @return \DateInterval|null An instance of \DateInterval
65+
* @return \DateInterval|null
6666
*
6767
* @throws UnexpectedTypeException if the given value is not a string
6868
* @throws TransformationFailedException if the date interval could not be parsed

Extension/Core/DataTransformer/DateTimeToStringTransformer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public function transform($dateTime)
101101
*
102102
* @param string $value A value as produced by PHP's date() function
103103
*
104-
* @return \DateTime|null An instance of \DateTime
104+
* @return \DateTime|null
105105
*
106106
* @throws TransformationFailedException If the given value is not a string,
107107
* or could not be transformed

Extension/Core/DataTransformer/UlidToStringTransformer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function transform($value)
4949
*
5050
* @param string $value A ULID string
5151
*
52-
* @return Ulid|null An instance of Ulid
52+
* @return Ulid|null
5353
*
5454
* @throws TransformationFailedException If the given value is not a string,
5555
* or could not be transformed

Extension/Core/DataTransformer/UuidToStringTransformer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function transform($value)
4949
*
5050
* @param string $value A UUID string
5151
*
52-
* @return Uuid|null An instance of Uuid
52+
* @return Uuid|null
5353
*
5454
* @throws TransformationFailedException If the given value is not a string,
5555
* or could not be transformed

FormConfigInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,14 @@ public function getType();
8989
/**
9090
* Returns the view transformers of the form.
9191
*
92-
* @return DataTransformerInterface[] An array of {@link DataTransformerInterface} instances
92+
* @return DataTransformerInterface[]
9393
*/
9494
public function getViewTransformers();
9595

9696
/**
9797
* Returns the model transformers of the form.
9898
*
99-
* @return DataTransformerInterface[] An array of {@link DataTransformerInterface} instances
99+
* @return DataTransformerInterface[]
100100
*/
101101
public function getModelTransformers();
102102

FormErrorIterator.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ public function offsetUnset($position)
204204
* Returns whether the current element of the iterator can be recursed
205205
* into.
206206
*
207-
* @return bool Whether the current element is an instance of this class
207+
* @return bool
208208
*/
209209
#[\ReturnTypeWillChange]
210210
public function hasChildren()
@@ -274,7 +274,7 @@ public function seek($position)
274274
*
275275
* @param string|string[] $codes The codes to find
276276
*
277-
* @return static new instance which contains only specific errors
277+
* @return static
278278
*/
279279
public function findByCodes($codes)
280280
{

FormExtensionInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function hasType(string $name);
4141
*
4242
* @param string $name The name of the type
4343
*
44-
* @return FormTypeExtensionInterface[] An array of extensions as FormTypeExtensionInterface instances
44+
* @return FormTypeExtensionInterface[]
4545
*/
4646
public function getTypeExtensions(string $name);
4747

FormInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ public function getExtraData();
172172
/**
173173
* Returns the form's configuration.
174174
*
175-
* @return FormConfigInterface The configuration instance
175+
* @return FormConfigInterface
176176
*/
177177
public function getConfig();
178178

@@ -195,7 +195,7 @@ public function getName();
195195
/**
196196
* Returns the property path that the form is mapped to.
197197
*
198-
* @return PropertyPathInterface|null The property path instance
198+
* @return PropertyPathInterface|null
199199
*/
200200
public function getPropertyPath();
201201

@@ -308,7 +308,7 @@ public function submit($submittedData, bool $clearMissing = true);
308308
/**
309309
* Returns the root of the form tree.
310310
*
311-
* @return self The root of the tree, may be the instance itself
311+
* @return self
312312
*/
313313
public function getRoot();
314314

0 commit comments

Comments
 (0)