Improved doc in format classes

raulfraile · raulfraile · commit b865fad82c59 · 2013-12-18T00:22:54.000+01:00
diff --git a/src/Ladybug/Format/JsonFormat.php b/src/Ladybug/Format/JsonFormat.php
@@ -16,6 +16,11 @@ class JsonFormat implements FormatInterface
 
     const FORMAT_NAME = 'json';
 
+    /**
+     * Gets format name
+     *
+     * @return string
+     */
     public function getName()
     {
         return self::FORMAT_NAME;
diff --git a/src/Ladybug/Format/PhpFormat.php b/src/Ladybug/Format/PhpFormat.php
@@ -16,6 +16,11 @@ class PhpFormat implements FormatInterface
 
     const FORMAT_NAME = 'php';
 
+    /**
+     * Gets format name
+     *
+     * @return string
+     */
     public function getName()
     {
         return self::FORMAT_NAME;
diff --git a/src/Ladybug/Format/TextFormat.php b/src/Ladybug/Format/TextFormat.php
@@ -16,6 +16,11 @@ class TextFormat implements FormatInterface
 
     const FORMAT_NAME = 'text';
 
+    /**
+     * Gets format name
+     *
+     * @return string
+     */
     public function getName()
     {
         return self::FORMAT_NAME;
diff --git a/src/Ladybug/Format/XmlFormat.php b/src/Ladybug/Format/XmlFormat.php
@@ -16,6 +16,11 @@ class XmlFormat implements FormatInterface
 
     const FORMAT_NAME = 'xml';
 
+    /**
+     * Gets format name
+     *
+     * @return string
+     */
     public function getName()
     {
         return self::FORMAT_NAME;
diff --git a/src/Ladybug/Format/YamlFormat.php b/src/Ladybug/Format/YamlFormat.php
@@ -16,6 +16,11 @@ class YamlFormat implements FormatInterface
 
     const FORMAT_NAME = 'yml';
 
+    /**
+     * Gets format name
+     *
+     * @return string
+     */
     public function getName()
     {
         return self::FORMAT_NAME;
