From 749dac1e3895b6df6b31b1d2e3d6e891b8d7a653 Mon Sep 17 00:00:00 2001 From: Markus Lanthaler Date: Fri, 16 Nov 2012 17:06:12 +0100 Subject: [PATCH] Improve docBlock --- 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 | 3 +++ 10 files changed, 18 insertions(+) diff --git a/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php b/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php index 21a367803c..e95271f740 100644 --- a/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php +++ b/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php @@ -32,6 +32,7 @@ interface DecoderInterface * 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 b4739edd6a..4a68ad3fe9 100644 --- a/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php +++ b/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php @@ -32,6 +32,7 @@ interface EncoderInterface * 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 cb46926111..6c0e2b5b38 100644 --- a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php +++ b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php @@ -96,6 +96,7 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec * Checks whether the serializer can encode to given format * * @param string $format format name + * * @return Boolean */ public function supportsEncoding($format) @@ -107,6 +108,7 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec * Checks whether the serializer can decode from given format * * @param string $format format name + * * @return Boolean */ public function supportsDecoding($format) @@ -116,6 +118,7 @@ class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, Dec /** * 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 aba4df8d4e..4510fa0b80 100644 --- a/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php +++ b/src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php @@ -40,6 +40,7 @@ class CustomNormalizer extends SerializerAwareNormalizer implements NormalizerIn * * @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 @@ class CustomNormalizer extends SerializerAwareNormalizer implements NormalizerIn * @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 7c4fd4f8f8..384f9febb6 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 @@ interface DenormalizerInterface * @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 8b29bbe51a..2c5f1b3e87 100644 --- a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php +++ b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php @@ -161,6 +161,7 @@ class GetSetMethodNormalizer extends SerializerAwareNormalizer implements Normal * 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 b7b8e51a7e..fb77a836d8 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 7b90d18e1f..f0915db2b4 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 @@ interface NormalizerInterface * * @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 f2c513baec..5bdeeada28 100644 --- a/src/Symfony/Component/Serializer/Serializer.php +++ b/src/Symfony/Component/Serializer/Serializer.php @@ -220,6 +220,7 @@ class Serializer implements SerializerInterface, NormalizerInterface, Denormaliz * * @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 @@ class Serializer implements SerializerInterface, NormalizerInterface, Denormaliz * @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 f1879596e1..143179fe7a 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,8 @@ interface SerializerInterface * @param mixed $data * @param string $type * @param string $format + * + * @return object */ public function deserialize($data, $type, $format); }