merged branch lanthaler/master (PR #6030)

fabpot · fabpot · commit 00d132a6d31c · 2012-11-17T18:07:16.000+01:00
This PR was squashed before being merged into the master branch (closes #6030). Commits ------- 749dac1 Improve docBlock Discussion ---------- Improve docBlock This is just a minor change documenting the return type of `SerializerInterface::deserialize()`.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 @@ public function serialize($data, $format);
      * @param mixed  $data
      * @param string $type
      * @param string $format
+     *
+     * @return object
      */
     public function deserialize($data, $type, $format);
 }

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ public function decode($data, $format);`
`32`	`32`	`* Checks whether the serializer can decode from given format`
`33`	`33`	`*`
`34`	`34`	`* @param string $format format name`
	`35`	`+ *`
`35`	`36`	`* @return Boolean`
`36`	`37`	`*/`
`37`	`38`	`public function supportsDecoding($format);`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ public function encode($data, $format);`
`32`	`32`	`* Checks whether the serializer can encode to given format`
`33`	`33`	`*`
`34`	`34`	`* @param string $format format name`
	`35`	`+ *`
`35`	`36`	`* @return Boolean`
`36`	`37`	`*/`
`37`	`38`	`public function supportsEncoding($format);`
Original file line number	Diff line number	Diff line change
`@@ -161,6 +161,7 @@ public function supportsDenormalization($data, $type, $format = null)`
`161`	`161`	`* Checks if the given class has any get{Property} method.`
`162`	`162`	`*`
`163`	`163`	`* @param string $class`
	`164`	`+ *`
`164`	`165`	`* @return Boolean`
`165`	`166`	`*/`
`166`	`167`	`private function supports($class)`