stakx-io / stakx

src/allejo/stakx/Configuration.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
     /**
      * @TODO 1.0.0 Remove support for 'base' in next major release; it has been replaced by 'baseurl'
      *
-     * @return mixed|null
+     * @return string
      */
     public function getBaseUrl()
     {

src/allejo/stakx/Compiler.php

Doc Comments +7 added lines, -1 removed lines

@@ -88,7 +88,7 @@ 
     }
 
     /**
-     * @param PageView[][] $pageViews
+     * @param Document\TrackableDocument[] $pageViews
      * @param PageView[]   $pageViewsFlattened
      */
     public function setPageViews(array &$pageViews, array &$pageViewsFlattened)
@@ -109,6 +109,9 @@ 
     // Twig parent templates
     ///
 
+    /**
+     * @param string $filePath
+     */
     public function isImportDependency($filePath)
     {
         return isset($this->importDependencies[$filePath]);
@@ -161,6 +164,9 @@ 
         }
     }
 
+    /**
+     * @param string $filePath
+     */
     public function compileImportDependencies($filePath)
     {
         foreach ($this->importDependencies[$filePath] as &$dependent)

src/allejo/stakx/Document/TwigDocument.php

Doc Comments +1 added lines

@@ -11,6 +11,7 @@
 {
     /**
      * @param string $filePath
+     * @return void
      */
     public function __construct($filePath);
 

src/allejo/stakx/Manager/AssetManager.php

Doc Comments +2 added lines

@@ -68,6 +68,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $filePath
      */
     public function refreshItem($filePath)
     {
@@ -86,6 +87,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $filePath
      */
     public function createNewItem($filePath)
     {

src/allejo/stakx/Manager/CollectionManager.php

Doc Comments +2 added lines, -1 removed lines

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

src/allejo/stakx/Manager/PageManager.php

Doc Comments +6 added lines, -3 removed lines

@@ -64,7 +64,7 @@ 
     /**
      * Give this manager the collections we'll be using for dynamic PageViews.
      *
-     * @param ContentItem[][] $collections
+     * @param \allejo\stakx\Document\TrackableDocument[] $collections
      *
      * @since 0.1.0
      */
@@ -73,6 +73,9 @@ 
         $this->collections = &$collections;
     }
 
+    /**
+     * @param \allejo\stakx\Document\TrackableDocument[] $datasets
+     */
     public function setDatasets($datasets)
     {
         $this->datasets = $datasets;
@@ -86,7 +89,7 @@ 
      * @deprecated Been replaced by getPageViewsFlattened()
      * @since      0.1.0
      *
-     * @return PageView[][]
+     * @return \allejo\stakx\Document\TrackableDocument[]
      */
     public function getAllPageViews()
     {
@@ -98,7 +101,7 @@ 
      *
      * @since  0.1.1
      *
-     * @return PageView[][]
+     * @return \allejo\stakx\Document\TrackableDocument[]
      */
     public function &getPageViews()
     {

src/allejo/stakx/Twig/BaseUrlFunction.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
         ));
     }
 
+    /**
+     * @param boolean $absolute
+     */
     private function getUrl($absolute)
     {
         $url = '/';

src/allejo/stakx/Manager/TrackingManager.php

Doc Comments +4 added lines, -4 removed lines

@@ -88,9 +88,9 @@ 
     }
 
     /**
-     * @param SplFileInfo|string $filePath
+     * @param string $filePath
      *
-     * @return mixed|null
+     * @return PageView
      */
     public function createNewItem($filePath)
     {
@@ -135,7 +135,7 @@ 
     /**
      * Update the contents of a specified file.
      *
-     * @param SplFileInfo|string $filePath The relative path of the file
+     * @param string $filePath The relative path of the file
      *
      * @return PageView
      */
@@ -286,7 +286,7 @@ 
     /**
      * Return an array of JailedDocuments created from the tracked items
      *
-     * @param array $elements
+     * @param TrackableDocument[] $elements
      *
      * @return JailedDocument[]|JailedDocument[][]
      */