feature #7040 [Serializer] Docs for CSV and YAML encoders (dunglas)

xabbuh · xabbuh · commit 864a1e1c431e · 2016-12-12T21:28:51.000+01:00
This PR was submitted for the master branch but it was merged into the 3.2 branch instead (closes #7040). Discussion ---------- [Serializer] Docs for CSV and YAML encoders Docs for symfony/symfony#19197 and symfony/symfony#19326. Commits ------- 5687972 [Serializer] Docs for CSV and YAML encoders.
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -540,6 +540,30 @@ There are several types of normalizers available:
     The ``JsonSerializableNormalizer``, ``DateTimeNormalizer`` and
     ``DataUriNormalizer`` normalizers were added in Symfony 3.1
 
+Encoders
+--------
+
+The Serializer component supports many formats out of the box:
+
+:class:`Symfony\\Component\\Serializer\\Encoder\\JsonEncoder`
+    This class encodes and decodes data in JSON_.
+
+:class:`Symfony\\Component\\Serializer\\Encoder\\XmlEncoder`
+    This class encodes and decodes data in XML_.
+
+:class:`Symfony\\Component\\Serializer\\Encoder\\YamlEncoder`
+    This encoder encodes and decodes data in YAML_. This encoder requires the
+    :doc:`Yaml Component </components/yaml>`.
+
+:class:`Symfony\\Component\\Serializer\\Encoder\\CsvEncoder`
+    This encoder encodes and decodes data in CSV_.
+
+All these encoders are enabled by default when using the Symfony Standard Edition
+with the serializer enabled.
+
+.. versionadded:: 3.2
+    The ``YamlEncoder`` and ``CsvEncoder`` encoders were added in Symfony 3.2
+
 Handling Circular References
 ----------------------------
 
@@ -692,3 +716,7 @@ Learn more
 .. _`JMS serializer`: https://github.com/schmittjoh/serializer
 .. _Packagist: https://packagist.org/packages/symfony/serializer
 .. _RFC3339: https://tools.ietf.org/html/rfc3339#section-5.8
+.. _JSON: http://www.json.org/
+.. _XML: https://www.w3.org/XML/
+.. _YAML: http://yaml.org/
+.. _CSV: https://tools.ietf.org/html/rfc4180
