Merge pull request #115 from adrienbrault/handler-doc

Document the SubscribingHandlerInterface a bit
schmittjoh · Jul 8, 2013 · 30422b6 · 30422b6
2 parents 6c0dfb8 + 568e661
commit 30422b6
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/JMS/Serializer/Handler/SubscribingHandlerInterface.php b/src/JMS/Serializer/Handler/SubscribingHandlerInterface.php
@@ -21,6 +21,19 @@
 interface SubscribingHandlerInterface
 {
     /**
+     * Return format:
+     *
+     *      array(
+     *          array(
+     *              'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
+     *              'format' => 'json',
+     *              'type' => 'DateTime',
+     *              'method' => 'serializeDateTimeToJson',
+     *          ),
+     *      )
+     *
+     * The direction and method keys can be omitted.
+     *
      * @return array
      */
     public static function getSubscribingMethods();