[2.3] CS And DocBlock Fixes

Author: GrahamCampbell

Encoder/ChainDecoder.php

@@ -58,6 +58,7 @@ public function supportsDecoding($format)
      * @param string $format
      *
      * @return DecoderInterface
+     *
      * @throws RuntimeException if no decoder is found
      */
     private function getDecoder($format)

Encoder/ChainEncoder.php

@@ -80,6 +80,7 @@ public function needsNormalization($format)
      * @param string $format
      *
      * @return EncoderInterface
+     *
      * @throws RuntimeException if no encoder is found
      */
     private function getEncoder($format)

Encoder/DecoderInterface.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Encoder;
 
 /**
- * Defines the interface of decoders
+ * Defines the interface of decoders.
  *
  * @author Jordi Boggiano <[email protected]>
  */

Encoder/EncoderInterface.php

@@ -12,14 +12,14 @@
 namespace Symfony\Component\Serializer\Encoder;
 
 /**
- * Defines the interface of encoders
+ * Defines the interface of encoders.
  *
  * @author Jordi Boggiano <[email protected]>
  */
 interface EncoderInterface
 {
     /**
-     * Encodes data into the given format
+     * Encodes data into the given format.
      *
      * @param mixed  $data    Data to encode
      * @param string $format  Format name
@@ -30,7 +30,7 @@ interface EncoderInterface
     public function encode($data, $format, array $context = array());
 
     /**
-     * Checks whether the serializer can encode to given format
+     * Checks whether the serializer can encode to given format.
      *
      * @param string $format format name
      *

Encoder/JsonDecode.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Encoder;
 
 /**
- * Decodes JSON data
+ * Decodes JSON data.
  *
  * @author Sander Coolen <[email protected]>
  */

Encoder/JsonEncode.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Encoder;
 
 /**
- * Encodes JSON data
+ * Encodes JSON data.
  *
  * @author Sander Coolen <[email protected]>
  */
@@ -27,7 +27,7 @@ public function __construct($bitmask = 0)
     }
 
     /**
-     * Returns the last encoding error (if any)
+     * Returns the last encoding error (if any).
      *
      * @return int
      *
@@ -39,7 +39,7 @@ public function getLastError()
     }
 
     /**
-     * Encodes PHP data to a JSON string
+     * Encodes PHP data to a JSON string.
      *
      * {@inheritdoc}
      */

Encoder/JsonEncoder.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Encoder;
 
 /**
- * Encodes JSON data
+ * Encodes JSON data.
  *
  * @author Jordi Boggiano <[email protected]>
  */
@@ -37,7 +37,7 @@ public function __construct(JsonEncode $encodingImpl = null, JsonDecode $decodin
     }
 
     /**
-     * Returns the last encoding error (if any)
+     * Returns the last encoding error (if any).
      *
      * @return int
      */
@@ -47,7 +47,7 @@ public function getLastEncodingError()
     }
 
     /**
-     * Returns the last decoding error (if any)
+     * Returns the last decoding error (if any).
      *
      * @return int
      */

Encoder/NormalizationAwareInterface.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Encoder;
 
 /**
- * Defines the interface of encoders that will normalize data themselves
+ * Defines the interface of encoders that will normalize data themselves.
  *
  * Implementing this interface essentially just tells the Serializer that the
  * data should not be pre-normalized before being passed to this Encoder.

Encoder/SerializerAwareEncoder.php

@@ -15,7 +15,7 @@
 use Symfony\Component\Serializer\SerializerAwareInterface;
 
 /**
- * SerializerAware Encoder implementation
+ * SerializerAware Encoder implementation.
  *
  * @author Jordi Boggiano <[email protected]>
  */

Encoder/XmlEncoder.php

@@ -14,7 +14,7 @@
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
 
 /**
- * Encodes XML data
+ * Encodes XML data.
  *
  * @author Jordi Boggiano <[email protected]>
  * @author John Wards <[email protected]>
@@ -115,7 +115,7 @@ public function decode($data, $format, array $context = array())
     }
 
      /**
-      * Checks whether the serializer can encode to given format
+      * Checks whether the serializer can encode to given format.
       *
       * @param string $format format name
       *
@@ -127,7 +127,7 @@ public function supportsEncoding($format)
      }
 
      /**
-      * Checks whether the serializer can decode from given format
+      * Checks whether the serializer can decode from given format.
       *
       * @param string $format format name
       *
@@ -139,7 +139,7 @@ public function supportsDecoding($format)
      }
 
     /**
-     * Sets the root node name
+     * Sets the root node name.
      *
      * @param string $name root node name
      */
@@ -149,7 +149,8 @@ public function setRootNodeName($name)
     }
 
     /**
-     * Returns the root node name
+     * Returns the root node name.
+     *
      * @return string
      */
     public function getRootNodeName()
@@ -222,7 +223,7 @@ final protected function appendDocumentFragment($node, $fragment)
     }
 
     /**
-     * Checks the name is a valid xml element name
+     * Checks the name is a valid xml element name.
      *
      * @param string $name
      *
@@ -287,7 +288,7 @@ private function parseXml($node)
     }
 
     /**
-     * Parse the data and convert it to DOMElements
+     * Parse the data and convert it to DOMElements.
      *
      * @param DOMNode      $parentNode
      * @param array|object $data            data
@@ -316,7 +317,7 @@ private function buildXml($parentNode, $data, $xmlRootNodeName = null)
                         /**
                          * Create nodes to append to $parentNode based on the $key of this array
                          * Produces <xml><item>0</item><item>1</item></xml>
-                         * From array("item" => array(0,1));
+                         * From array("item" => array(0,1));.
                          */
                         foreach ($data as $subData) {
                             $append = $this->appendNode($parentNode, $subData, $key);
@@ -392,7 +393,7 @@ private function needsCdataWrapping($val)
     }
 
     /**
-     * Tests the value being passed and decide what sort of element to create
+     * Tests the value being passed and decide what sort of element to create.
      *
      * @param DOMNode $node
      * @param mixed   $val

Exception/Exception.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Exception;
 
 /**
- * Base exception
+ * Base exception.
  *
  * @author Johannes M. Schmitt <[email protected]>
  */

Exception/InvalidArgumentException.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Exception;
 
 /**
- * InvalidArgumentException
+ * InvalidArgumentException.
  *
  * @author Johannes M. Schmitt <[email protected]>
  */

Exception/LogicException.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Exception;
 
 /**
- * LogicException
+ * LogicException.
  *
  * @author Lukas Kahwe Smith <[email protected]>
  */

Exception/RuntimeException.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Exception;
 
 /**
- * RuntimeException
+ * RuntimeException.
  *
  * @author Johannes M. Schmitt <[email protected]>
  */

Exception/UnexpectedValueException.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Exception;
 
 /**
- * UnexpectedValueException
+ * UnexpectedValueException.
  *
  * @author Lukas Kahwe Smith <[email protected]>
  */

Exception/UnsupportedException.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Exception;
 
 /**
- * UnsupportedException
+ * UnsupportedException.
  *
  * @author Johannes M. Schmitt <[email protected]>
  */

Normalizer/DenormalizableInterface.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Normalizer;
 
 /**
- * Defines the most basic interface a class must implement to be denormalizable
+ * Defines the most basic interface a class must implement to be denormalizable.
  *
  * If a denormalizer is registered for the class and it doesn't implement
  * the Denormalizable interfaces, the normalizer will be used instead

Normalizer/DenormalizerInterface.php

@@ -19,7 +19,7 @@
 interface DenormalizerInterface
 {
     /**
-     * Denormalizes data back into an object of the given class
+     * Denormalizes data back into an object of the given class.
      *
      * @param mixed  $data    data to restore
      * @param string $class   the expected class to instantiate
@@ -31,7 +31,7 @@ interface DenormalizerInterface
     public function denormalize($data, $class, $format = null, array $context = array());
 
     /**
-     * Checks whether the given class is supported for denormalization by this normalizer
+     * Checks whether the given class is supported for denormalization by this normalizer.
      *
      * @param mixed  $data   Data to denormalize from.
      * @param string $type   The class to which the data should be denormalized.

Normalizer/GetSetMethodNormalizer.php

@@ -41,7 +41,7 @@ class GetSetMethodNormalizer extends SerializerAwareNormalizer implements Normal
     protected $camelizedAttributes = array();
 
     /**
-     * Set normalization callbacks
+     * Set normalization callbacks.
      *
      * @param array $callbacks help normalize the result
      *
@@ -58,7 +58,7 @@ public function setCallbacks(array $callbacks)
     }
 
     /**
-     * Set ignored attributes for normalization
+     * Set ignored attributes for normalization.
      *
      * @param array $ignoredAttributes
      */
@@ -68,7 +68,7 @@ public function setIgnoredAttributes(array $ignoredAttributes)
     }
 
     /**
-     * Set attributes to be camelized on denormalize
+     * Set attributes to be camelized on denormalize.
      *
      * @param array $camelizedAttributes
      */
@@ -170,7 +170,7 @@ public function denormalize($data, $class, $format = null, array $context = arra
     /**
      * Format attribute name to access parameters or methods
      * As option, if attribute name is found on camelizedAttributes array
-     * returns attribute name in camelcase format
+     * returns attribute name in camelcase format.
      *
      * @param string $attributeName
      *

Normalizer/NormalizableInterface.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Serializer\Normalizer;
 
 /**
- * Defines the most basic interface a class must implement to be normalizable
+ * Defines the most basic interface a class must implement to be normalizable.
  *
  * If a normalizer is registered for the class and it doesn't implement
  * the Normalizable interfaces, the normalizer will be used instead

Normalizer/NormalizerInterface.php

@@ -19,7 +19,7 @@
 interface NormalizerInterface
 {
     /**
-     * Normalizes an object into a set of arrays/scalars
+     * Normalizes an object into a set of arrays/scalars.
      *
      * @param object $object  object to normalize
      * @param string $format  format the normalization result will be encoded as
@@ -30,7 +30,7 @@ interface NormalizerInterface
     public function normalize($object, $format = null, array $context = array());
 
     /**
-     * Checks whether the given class is supported for normalization by this normalizer
+     * Checks whether the given class is supported for normalization by this normalizer.
      *
      * @param mixed  $data   Data to normalize.
      * @param string $format The format being (de-)serialized from or into.

Normalizer/SerializerAwareNormalizer.php

@@ -15,7 +15,7 @@
 use Symfony\Component\Serializer\SerializerAwareInterface;
 
 /**
- * SerializerAware Normalizer implementation
+ * SerializerAware Normalizer implementation.
  *
  * @author Jordi Boggiano <[email protected]>
  */

Serializer.php

@@ -22,7 +22,7 @@
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
 
 /**
- * Serializer serializes and deserializes data
+ * Serializer serializes and deserializes data.
  *
  * objects are turned into arrays by normalizers
  * arrays are turned into various output formats by encoders
@@ -212,7 +212,7 @@ final public function decode($data, $format, array $context = array())
     }
 
     /**
-     * Normalizes an object into a set of arrays/scalars
+     * Normalizes an object into a set of arrays/scalars.
      *
      * @param object $object  object to normalize
      * @param string $format  format name, present to give the option to normalizers to act differently based on formats
@@ -247,7 +247,7 @@ private function normalizeObject($object, $format = null, array $context = array
     }
 
     /**
-     * Denormalizes data back into an object of the given class
+     * Denormalizes data back into an object of the given class.
      *
      * @param mixed  $data    data to restore
      * @param string $class   the expected class to instantiate