minor #18854 [Serializer] Add missing @throws annotations (theofidry)

nicolas-grekas · nicolas-grekas · commit c58513457c08 · 2016-05-30T10:12:16.000+02:00
This PR was squashed before being merged into the 2.3 branch (closes #18854). Discussion ---------- [Serializer] Add missing @throws annotations | Q | A | ------------- | --- | Branch? | 2.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #18798 | License | MIT | Doc PR | - Commits ------- b73400d [Serializer] Add missing @throws annotations
diff --git a/src/Symfony/Component/Serializer/Encoder/ChainDecoder.php b/src/Symfony/Component/Serializer/Encoder/ChainDecoder.php
@@ -59,7 +59,7 @@ public function supportsDecoding($format)
      *
      * @return DecoderInterface
      *
-     * @throws RuntimeException if no decoder is found
+     * @throws RuntimeException If no decoder is found.
      */
     private function getDecoder($format)
     {
diff --git a/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php b/src/Symfony/Component/Serializer/Encoder/DecoderInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Serializer\Encoder;
 
+use Symfony\Component\Serializer\Exception\Exception;
+
 /**
  * Defines the interface of decoders.
  *
@@ -30,6 +32,8 @@ interface DecoderInterface
      * are encouraged to document which formats they support in a non-inherited
      * phpdoc comment.
      *
+     * @throws Exception
+     *                    
      * @return mixed
      */
     public function decode($data, $format, array $context = array());
diff --git a/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php b/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Serializer\Encoder;
 
+use Symfony\Component\Serializer\Exception\Exception;
+
 /**
  * Defines the interface of encoders.
  *
@@ -25,6 +27,8 @@ interface EncoderInterface
      * @param string $format  Format name
      * @param array  $context options that normalizers/encoders have access to.
      *
+     * @throws Exception
+     *                                     
      * @return string|bool|int|float|null
      */
     public function encode($data, $format, array $context = array());
diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
@@ -399,6 +399,8 @@ private function needsCdataWrapping($val)
      * @param \DOMNode $node
      * @param mixed    $val
      *
+     * @throws UnexpectedValueException
+     * 
      * @return bool
      */
     private function selectNodeType(\DOMNode $node, $val)
diff --git a/src/Symfony/Component/Serializer/Normalizer/DenormalizableInterface.php b/src/Symfony/Component/Serializer/Normalizer/DenormalizableInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Serializer\Normalizer;
 
+use Symfony\Component\Serializer\Exception\Exception;
+
 /**
  * Defines the most basic interface a class must implement to be denormalizable.
  *
@@ -33,6 +35,10 @@ interface DenormalizableInterface
      * @param string|null                      $format       The format is optionally given to be able to denormalize differently
      *                                                       based on different input formats.
      * @param array                            $context      options for denormalizing
+     *
+     * @throws Exception
+     * 
+     * @return object
      */
     public function denormalize(DenormalizerInterface $denormalizer, $data, $format = null, array $context = array());
 }
diff --git a/src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php b/src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Serializer\Normalizer;
 
+use Symfony\Component\Serializer\Exception\Exception;
+
 /**
  * Defines the interface of denormalizers.
  *
@@ -26,6 +28,8 @@ interface DenormalizerInterface
      * @param string $format  format the given data was extracted from
      * @param array  $context options available to the denormalizer
      *
+     * @throws Exception
+     *                    
      * @return object
      */
     public function denormalize($data, $class, $format = null, array $context = array());
diff --git a/src/Symfony/Component/Serializer/Normalizer/NormalizableInterface.php b/src/Symfony/Component/Serializer/Normalizer/NormalizableInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Serializer\Normalizer;
 
+use Symfony\Component\Serializer\Exception\Exception;
+
 /**
  * Defines the most basic interface a class must implement to be normalizable.
  *
@@ -33,6 +35,8 @@ interface NormalizableInterface
      *                                        based on different output formats.
      * @param array               $context    Options for normalizing this object
      *
+     * @throws Exception
+     *                                           
      * @return array|string|bool|int|float|null
      */
     public function normalize(NormalizerInterface $normalizer, $format = null, array $context = array());
diff --git a/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php b/src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Serializer\Normalizer;
 
+use Symfony\Component\Serializer\Exception\Exception;
+
 /**
  * Defines the interface of normalizers.
  *
@@ -25,6 +27,8 @@ interface NormalizerInterface
      * @param string $format  format the normalization result will be encoded as
      * @param array  $context Context options for the normalizer
      *
+     * @throws Exception
+     *                                           
      * @return array|string|bool|int|float|null
      */
     public function normalize($object, $format = null, array $context = array());
diff --git a/src/Symfony/Component/Serializer/Serializer.php b/src/Symfony/Component/Serializer/Serializer.php
@@ -169,6 +169,8 @@ public function supportsDenormalization($data, $type, $format = null)
 
     /**
      * {@inheritdoc}
+     * 
+     * @throws RuntimeException
      */
     private function getNormalizer($data, $format = null)
     {
@@ -183,6 +185,8 @@ private function getNormalizer($data, $format = null)
 
     /**
      * {@inheritdoc}
+     * 
+     * @throws RuntimeException
      */
     private function getDenormalizer($data, $type, $format = null)
     {
diff --git a/src/Symfony/Component/Serializer/SerializerInterface.php b/src/Symfony/Component/Serializer/SerializerInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Serializer;
 
+use Symfony\Component\Serializer\Exception\Exception;
+
 /**
  * Defines the interface of the Serializer.
  *
@@ -25,6 +27,8 @@ interface SerializerInterface
      * @param string $format  format name
      * @param array  $context options normalizers/encoders have access to
      *
+     * @throws Exception
+     *                    
      * @return string
      */
     public function serialize($data, $format, array $context = array());
@@ -37,6 +41,8 @@ public function serialize($data, $format, array $context = array());
      * @param string $format
      * @param array  $context
      *
+     * @throws Exception
+     * 
      * @return object
      */
     public function deserialize($data, $type, $format, array $context = array());

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public function supportsDecoding($format)`
`59`	`59`	`*`
`60`	`60`	`* @return DecoderInterface`
`61`	`61`	`*`
`62`		`- * @throws RuntimeException if no decoder is found`
	`62`	`+ * @throws RuntimeException If no decoder is found.`
`63`	`63`	`*/`
`64`	`64`	`private function getDecoder($format)`
`65`	`65`	`{`
Original file line number	Diff line number	Diff line change
`@@ -399,6 +399,8 @@ private function needsCdataWrapping($val)`
`399`	`399`	`* @param \DOMNode $node`
`400`	`400`	`* @param mixed $val`
`401`	`401`	`*`
	`402`	`+ * @throws UnexpectedValueException`
	`403`	`+ *`
`402`	`404`	`* @return bool`
`403`	`405`	`*/`
`404`	`406`	`private function selectNodeType(\DOMNode $node, $val)`