From 0b2b94fd721e54c8a27f41ae4a107672604ee003 Mon Sep 17 00:00:00 2001 From: Markus Lanthaler Date: Fri, 16 Nov 2012 17:06:12 +0100 Subject: [PATCH 1/2] Improve docBlock --- src/Symfony/Component/Serializer/SerializerInterface.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Symfony/Component/Serializer/SerializerInterface.php b/src/Symfony/Component/Serializer/SerializerInterface.php index f1879596e1778..fff654868a317 100644 --- a/src/Symfony/Component/Serializer/SerializerInterface.php +++ b/src/Symfony/Component/Serializer/SerializerInterface.php @@ -33,6 +33,7 @@ public function serialize($data, $format); * @param mixed $data * @param string $type * @param string $format + * @return object */ public function deserialize($data, $type, $format); } From 5934818339cdbcb54cb833202416f56c26dc355d Mon Sep 17 00:00:00 2001 From: Markus Lanthaler Date: Fri, 16 Nov 2012 18:06:31 +0100 Subject: [PATCH 2/2] Add blank line above @return --- src/Symfony/Component/Serializer/Encoder/DecoderInterface.php | 1 + src/Symfony/Component/Serializer/Encoder/EncoderInterface.php | 1 + src/Symfony/Component/Serializer/Encoder/XmlEncoder.php | 3 +++ .../Component/Serializer/Normalizer/CustomNormalizer.php | 2 ++ .../Component/Serializer/Normalizer/DenormalizerInterface.php | 2 ++ .../Component/Serializer/Normalizer/GetSetMethodNormalizer.php | 1 + .../Component/Serializer/Normalizer/NormalizableInterface.php | 1 + .../Component/Serializer/Normalizer/NormalizerInterface.php | 2 ++ src/Symfony/Component/Serializer/Serializer.php | 2 ++ src/Symfony/Component/Serializer/SerializerInterface.php | 2 ++ 10 files changed, 17 insertions(+) diff --git a/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php b/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php index 21a367803caf2..e95271f740b01 100644 --- a/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php +++ b/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php @@ -32,6 +32,7 @@ public function decode($data, $format); * Checks whether the serializer can decode from given format * * @param string $format format name + * * @return Boolean */ public function supportsDecoding($format); diff --git a/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php b/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php index b4739edd6a320..4a68ad3fe9ea0 100644 --- a/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php +++ b/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php @@ -32,6 +32,7 @@ public function encode($data, $format); * Checks whether the serializer can encode to given format * * @param string $format format name + * * @return Boolean */ public function supportsEncoding($format); diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php index cb46926111c77..6c0e2b5b38395 100644 --- a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php +++ b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php @@ -96,6 +96,7 @@ public function decode($data, $format) * Checks whether the serializer can encode to given format * * @param string $format format name + * * @return Boolean */ public function supportsEncoding($format) @@ -107,6 +108,7 @@ public function supportsEncoding($format) * Checks whether the serializer can decode from given format * * @param string $format format name + * * @return Boolean */ public function supportsDecoding($format) @@ -116,6 +118,7 @@ public function supportsDecoding($format) /** * Sets the root node name + * * @param string $name root node name */ public function setRootNodeName($name) diff --git a/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php index aba4df8d4e487..4510fa0b8006d 100644 --- a/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php +++ b/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php @@ -40,6 +40,7 @@ public function denormalize($data, $class, $format = null) * * @param mixed $data Data to normalize. * @param string $format The format being (de-)serialized from or into. + * * @return Boolean */ public function supportsNormalization($data, $format = null) @@ -53,6 +54,7 @@ public function supportsNormalization($data, $format = null) * @param mixed $data Data to denormalize from. * @param string $type The class to which the data should be denormalized. * @param string $format The format being deserialized from. + * * @return Boolean */ public function supportsDenormalization($data, $type, $format = null) diff --git a/src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php b/src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php index 7c4fd4f8f856e..384f9febb6683 100644 --- a/src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php +++ b/src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php @@ -24,6 +24,7 @@ interface DenormalizerInterface * @param mixed $data data to restore * @param string $class the expected class to instantiate * @param string $format format the given data was extracted from + * * @return object */ public function denormalize($data, $class, $format = null); @@ -34,6 +35,7 @@ public function denormalize($data, $class, $format = null); * @param mixed $data Data to denormalize from. * @param string $type The class to which the data should be denormalized. * @param string $format The format being deserialized from. + * * @return Boolean */ public function supportsDenormalization($data, $type, $format = null); diff --git a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php index 8b29bbe51a66e..2c5f1b3e874df 100644 --- a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php +++ b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php @@ -161,6 +161,7 @@ public function supportsDenormalization($data, $type, $format = null) * Checks if the given class has any get{Property} method. * * @param string $class + * * @return Boolean */ private function supports($class) diff --git a/src/Symfony/Component/Serializer/Normalizer/NormalizableInterface.php b/src/Symfony/Component/Serializer/Normalizer/NormalizableInterface.php index b7b8e51a7e5ae..fb77a836d8d90 100644 --- a/src/Symfony/Component/Serializer/Normalizer/NormalizableInterface.php +++ b/src/Symfony/Component/Serializer/Normalizer/NormalizableInterface.php @@ -31,6 +31,7 @@ interface NormalizableInterface * can use it to normalize objects contained within this object. * @param string|null $format The format is optionally given to be able to normalize differently * based on different output formats. + * * @return array|scalar */ public function normalize(NormalizerInterface $normalizer, $format = null); diff --git a/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php b/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php index 7b90d18e1f8b9..f0915db2b4530 100644 --- a/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php +++ b/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php @@ -23,6 +23,7 @@ interface NormalizerInterface * * @param object $object object to normalize * @param string $format format the normalization result will be encoded as + * * @return array|scalar */ public function normalize($object, $format = null); @@ -32,6 +33,7 @@ public function normalize($object, $format = null); * * @param mixed $data Data to normalize. * @param string $format The format being (de-)serialized from or into. + * * @return Boolean */ public function supportsNormalization($data, $format = null); diff --git a/src/Symfony/Component/Serializer/Serializer.php b/src/Symfony/Component/Serializer/Serializer.php index f2c513baec059..5bdeeada28d76 100644 --- a/src/Symfony/Component/Serializer/Serializer.php +++ b/src/Symfony/Component/Serializer/Serializer.php @@ -220,6 +220,7 @@ final public function decode($data, $format) * * @param object $object object to normalize * @param string $format format name, present to give the option to normalizers to act differently based on formats + * * @return array|scalar */ private function normalizeObject($object, $format = null) @@ -250,6 +251,7 @@ private function normalizeObject($object, $format = null) * @param mixed $data data to restore * @param string $class the expected class to instantiate * @param string $format format name, present to give the option to normalizers to act differently based on formats + * * @return object */ private function denormalizeObject($data, $class, $format = null) diff --git a/src/Symfony/Component/Serializer/SerializerInterface.php b/src/Symfony/Component/Serializer/SerializerInterface.php index fff654868a317..143179fe7a313 100644 --- a/src/Symfony/Component/Serializer/SerializerInterface.php +++ b/src/Symfony/Component/Serializer/SerializerInterface.php @@ -23,6 +23,7 @@ interface SerializerInterface * * @param mixed $data any data * @param string $format format name + * * @return string */ public function serialize($data, $format); @@ -33,6 +34,7 @@ public function serialize($data, $format); * @param mixed $data * @param string $type * @param string $format + * * @return object */ public function deserialize($data, $type, $format);