Skip to content

Commit 2e05093

Browse files
Docblock fixes
1 parent 8307ab1 commit 2e05093

11 files changed

+34
-32
lines changed

Encoder/DecoderInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ interface DecoderInterface
2121
/**
2222
* Decodes a string into PHP data.
2323
*
24-
* @param scalar $data Data to decode
25-
* @param string $format Format name
26-
* @param array $context options that decoders have access to.
24+
* @param scalar $data Data to decode
25+
* @param string $format Format name
26+
* @param array $context options that decoders have access to.
2727
*
2828
* The format parameter specifies which format the data is in; valid values
2929
* depend on the specific implementation. Authors implementing this interface

Encoder/EncoderInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ interface EncoderInterface
2121
/**
2222
* Encodes data into the given format
2323
*
24-
* @param mixed $data Data to encode
25-
* @param string $format Format name
24+
* @param mixed $data Data to encode
25+
* @param string $format Format name
2626
* @param array $context options that normalizers/encoders have access to.
2727
*
2828
* @return scalar

Encoder/JsonDecode.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ class JsonDecode implements DecoderInterface
3838
/**
3939
* Constructs a new JsonDecode instance.
4040
*
41-
* @param bool $associative True to return the result associative array, false for a nested stdClass hierarchy
42-
* @param int $depth Specifies the recursion depth
41+
* @param bool $associative True to return the result associative array, false for a nested stdClass hierarchy
42+
* @param int $depth Specifies the recursion depth
4343
*/
4444
public function __construct($associative = false, $depth = 512)
4545
{

Encoder/JsonEncode.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ public function supportsEncoding($format)
6565
* Merge default json encode options with context.
6666
*
6767
* @param array $context
68+
*
6869
* @return array
6970
*/
7071
private function resolveContext(array $context = array())

Encoder/XmlEncoder.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ public function getRootNodeName()
159159

160160
/**
161161
* @param \DOMNode $node
162-
* @param string $val
162+
* @param string $val
163163
*
164164
* @return bool
165165
*/
@@ -290,7 +290,7 @@ private function parseXml($node)
290290
* Parse the data and convert it to DOMElements
291291
*
292292
* @param DOMNode $parentNode
293-
* @param array|object $data data
293+
* @param array|object $data data
294294
* @param string $xmlRootNodeName
295295
*
296296
* @return bool

Normalizer/DenormalizableInterface.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ interface DenormalizableInterface
2828
* recursively all child objects of the implementor.
2929
*
3030
* @param DenormalizerInterface $denormalizer The denormalizer is given so that you
31-
* can use it to denormalize objects contained within this object.
32-
* @param array|scalar $data The data from which to re-create the object.
33-
* @param string|null $format The format is optionally given to be able to denormalize differently
34-
* based on different input formats.
35-
* @param array $context options for denormalizing
31+
* can use it to denormalize objects contained within this object.
32+
* @param array|scalar $data The data from which to re-create the object.
33+
* @param string|null $format The format is optionally given to be able to denormalize differently
34+
* based on different input formats.
35+
* @param array $context options for denormalizing
3636
*/
3737
public function denormalize(DenormalizerInterface $denormalizer, $data, $format = null, array $context = array());
3838
}

Normalizer/DenormalizerInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ interface DenormalizerInterface
2121
/**
2222
* Denormalizes data back into an object of the given class
2323
*
24-
* @param mixed $data data to restore
25-
* @param string $class the expected class to instantiate
26-
* @param string $format format the given data was extracted from
24+
* @param mixed $data data to restore
25+
* @param string $class the expected class to instantiate
26+
* @param string $format format the given data was extracted from
2727
* @param array $context options available to the denormalizer
2828
*
2929
* @return object

Normalizer/GetSetMethodNormalizer.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ public function denormalize($data, $class, $format = null, array $context = arra
173173
* returns attribute name in camelcase format
174174
*
175175
* @param string $attributeName
176+
*
176177
* @return string
177178
*/
178179
protected function formatAttribute($attributeName)
@@ -229,7 +230,7 @@ private function supports($class)
229230
*
230231
* @param \ReflectionMethod $method the method to check
231232
*
232-
* @return bool whether the method is a getter.
233+
* @return bool whether the method is a getter.
233234
*/
234235
private function isGetMethod(\ReflectionMethod $method)
235236
{

Normalizer/NormalizableInterface.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ interface NormalizableInterface
2828
* recursively all child objects of the implementor.
2929
*
3030
* @param NormalizerInterface $normalizer The normalizer is given so that you
31-
* can use it to normalize objects contained within this object.
32-
* @param string|null $format The format is optionally given to be able to normalize differently
33-
* based on different output formats.
34-
* @param array $context Options for normalizing this object
31+
* can use it to normalize objects contained within this object.
32+
* @param string|null $format The format is optionally given to be able to normalize differently
33+
* based on different output formats.
34+
* @param array $context Options for normalizing this object
3535
*
3636
* @return array|scalar
3737
*/

Normalizer/NormalizerInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ interface NormalizerInterface
2121
/**
2222
* Normalizes an object into a set of arrays/scalars
2323
*
24-
* @param object $object object to normalize
25-
* @param string $format format the normalization result will be encoded as
26-
* @param array $context Context options for the normalizer
24+
* @param object $object object to normalize
25+
* @param string $format format the normalization result will be encoded as
26+
* @param array $context Context options for the normalizer
2727
*
2828
* @return array|scalar
2929
*/

Serializer.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -214,9 +214,9 @@ final public function decode($data, $format, array $context = array())
214214
/**
215215
* Normalizes an object into a set of arrays/scalars
216216
*
217-
* @param object $object object to normalize
218-
* @param string $format format name, present to give the option to normalizers to act differently based on formats
219-
* @param array $context The context data for this particular normalization
217+
* @param object $object object to normalize
218+
* @param string $format format name, present to give the option to normalizers to act differently based on formats
219+
* @param array $context The context data for this particular normalization
220220
*
221221
* @return array|scalar
222222
*
@@ -249,10 +249,10 @@ private function normalizeObject($object, $format = null, array $context = array
249249
/**
250250
* Denormalizes data back into an object of the given class
251251
*
252-
* @param mixed $data data to restore
253-
* @param string $class the expected class to instantiate
254-
* @param string $format format name, present to give the option to normalizers to act differently based on formats
255-
* @param array $context The context data for this particular denormalization
252+
* @param mixed $data data to restore
253+
* @param string $class the expected class to instantiate
254+
* @param string $format format name, present to give the option to normalizers to act differently based on formats
255+
* @param array $context The context data for this particular denormalization
256256
*
257257
* @return object
258258
*

0 commit comments

Comments
 (0)