stakx-io / stakx

src/allejo/stakx/FrontMatter/Parser.php

Doc Comments +1 added lines, -1 removed lines

@@ -197,7 +197,7 @@
      *
      * @param string $frontMatterKey     The current hierarchy of the Front Matter keys being used
      * @param string $expandableValue    The Front Matter value that will be expanded
-     * @param array  $arrayVariableNames The Front Matter variable names that reference arrays
+     * @param string[]  $arrayVariableNames The Front Matter variable names that reference arrays
      *
      * @throws YamlUnsupportedVariableException If a multidimensional array is given for value expansion
      *

src/allejo/stakx/FrontMatter/WritableDocumentInterface.php

Doc Comments +4 added lines

@@ -13,6 +13,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($variables = null);
 
@@ -36,6 +37,7 @@ 
      * Append a custom FrontMatter value.
      *
      * @param array $frontMatter
+     * @return void
      */
     public function appendFrontMatter(array $frontMatter);
 
@@ -45,6 +47,7 @@ 
      * This will not delete a FrontMatter value parsed from the file
      *
      * @param string $key
+     * @return void
      */
     public function deleteFrontMatter($key);
 
@@ -55,6 +58,7 @@ 
      * available to Twig templates
      *
      * @param array $frontMatter
+     * @return void
      */
     public function setFrontMatter(array $frontMatter);
 }

src/allejo/stakx/Website.php

Doc Comments +6 added lines

@@ -349,6 +349,9 @@ 
         $this->noClean = $noClean;
     }
 
+    /**
+     * @param string $filePath
+     */
     private function creationWatcher($filePath)
     {
         $this->output->writeln(sprintf('File creation detected: %s', $filePath));
@@ -390,6 +393,9 @@ 
         }
     }
 
+    /**
+     * @param string $filePath
+     */
     private function modificationWatcher($filePath)
     {
         $this->output->writeln(sprintf('File change detected: %s', $filePath));

src/allejo/stakx/Document/ContentItem.php

Spacing +1 added lines, -1 removed lines

@@ -185,7 +185,7 @@
             $this->bodyContentEvaluated = true;
         }
 
-        return (string)$this->bodyContent;
+        return (string) $this->bodyContent;
     }
 
     /**

src/allejo/stakx/Configuration.php

Doc Comments +13 added lines, -1 removed lines

@@ -66,6 +66,9 @@ 
         $this->fs = new Filesystem();
     }
 
+    /**
+     * @param string|null $filePath
+     */
     private static function readFile($filePath)
     {
         $fs = new Filesystem();
@@ -75,6 +78,9 @@ 
         return (null === $parsed) ? array() : $parsed;
     }
 
+    /**
+     * @param string $configFile
+     */
     public function parse($configFile = null)
     {
         $this->parentConfig = $configFile;
@@ -147,7 +153,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()
     {
@@ -218,6 +224,9 @@ 
         return $this->configuration['twig']['autoescape'];
     }
 
+    /**
+     * @return string|false
+     */
     public function getRedirectTemplate()
     {
         return $this->configuration['templates']['redirect'];
@@ -379,6 +388,9 @@ 
         return $noErrors;
     }
 
+    /**
+     * @param string|null $filePath
+     */
     private function isRecursiveImport($filePath)
     {
         if (in_array($filePath, self::$configImports))