stakx-io / stakx

src/allejo/stakx/DataTransformer/DataTransformerManager.php

Doc Comments +3 added lines

@@ -26,6 +26,9 @@
         }
     }
 
+    /**
+     * @param string $extension
+     */
     public function getTransformer($extension)
     {
         if (isset($this->transformers[$extension]))

src/allejo/stakx/Document/CollectableItem.php

Doc Comments +4 added lines

@@ -12,6 +12,9 @@ 
  */
 interface CollectableItem
 {
+    /**
+     * @return string
+     */
     public function getRelativeFilePath();
 
     /**
@@ -58,6 +61,7 @@ 
      * Evaluate the FrontMatter in this object by merging a custom array of data.
      *
      * @param array|null $variables An array of YAML variables to use in evaluating the `$permalink` value
+     * @return void
      */
     public function evaluateFrontMatter(array $variables = null);
 }

src/allejo/stakx/Manager/CollectionManager.php

Doc Comments +2 added lines, -1 removed lines

@@ -49,7 +49,7 @@ 
     /**
      * Get all of the ContentItems grouped by Collection name.
      *
-     * @return ContentItem[][]
+     * @return \allejo\stakx\Document\ReadableDocument[]
      */
     public function &getCollections()
     {
@@ -135,6 +135,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $filePath
      */
     public function createNewItem($filePath)
     {

src/allejo/stakx/Manager/PageManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
      *
      * @since  0.1.1
      *
-     * @return BasePageView[][]
+     * @return \allejo\stakx\Document\ReadableDocument[]
      */
     public function &getPageViews()
     {

src/allejo/stakx/Manager/TrackingManager.php

Doc Comments +5 added lines, -5 removed lines

@@ -88,9 +88,9 @@ 
     }
 
     /**
-     * @param File|string $filePath
+     * @param string $filePath
      *
-     * @return mixed|null
+     * @return \allejo\stakx\Document\BasePageView
      */
     public function createNewItem($filePath)
     {
@@ -135,9 +135,9 @@ 
     /**
      * Update the contents of a specified file.
      *
-     * @param File|string $filePath The relative path of the file
+     * @param string $filePath The relative path of the file
      *
-     * @return mixed|null
+     * @return \allejo\stakx\Document\BasePageView
      */
     public function refreshItem($filePath)
     {
@@ -286,7 +286,7 @@ 
     /**
      * Return an array of JailedDocuments created from the tracked items
      *
-     * @param array    $elements
+     * @param ReadableDocument[]    $elements
      * @param \Closure $name
      *
      * @return JailedDocument[]|JailedDocument[][]