Document design decisions #35

marein · Oct 6, 2021 · 744738b · 744738b
1 parent e29b8b1
commit 744738b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/Common/Normalizer/Normalizer.php b/src/Common/Normalizer/Normalizer.php
@@ -5,6 +5,10 @@
 
 use Gaming\Common\Normalizer\Exception\NormalizerException;
 
+/**
+ * This interface abstracts the library used for normalization so that
+ * we can exchange it in the future.
+ */
 interface Normalizer
 {
     /**

diff --git a/src/Common/Port/Adapter/Jms/JmsSerializerFactory.php b/src/Common/Port/Adapter/Jms/JmsSerializerFactory.php
@@ -11,6 +11,12 @@
 use JMS\Serializer\Serializer;
 use JMS\Serializer\SerializerBuilder;
 
+/**
+ * This class provides a factory for jms/serializer used in our service container.
+ * The bundle which integrates jms/serializer with symfony cleanly is currently only
+ * capable of configuring one serializer for the application. This factory can be used
+ * to create a jms/serializer for each context with some application-wide defaults.
+ */
 final class JmsSerializerFactory
 {
     /**