spress / spress

src/Core/ContentManager/Renderizer/TwigRenderizer.php

Doc Comments +3 added lines, -1 removed lines

@@ -175,7 +175,6 @@ 
      * @see http://twig.sensiolabs.org/doc/advanced.html#tests Twig documentation.
      *
      * @param string   $name     Name of test
-     * @param callable $function Test implementation
      * @param array    $options
      */
     public function addTwigTest($name, callable $test, array $options = [])
@@ -207,6 +206,9 @@ 
         return '@layout/'.$name;
     }
 
+    /**
+     * @param string $layoutName
+     */
     protected function getLayoutWithExtension($layoutName, $contentName)
     {
         foreach ($this->layoutExtension as $extension) {

src/Core/DataSource/DataSourceManager.php

Doc Comments +1 added lines

@@ -111,6 +111,7 @@
     /**
      * Gets a data source.
      *
+     * @param string $name
      * @return \Yosymfony\Spress\Core\DataSource\AbstractDataSource
      *
      * @throws \RuntimeException If data source not found.

src/Core/DataSource/ItemInterface.php

Doc Comments +6 added lines, -2 removed lines

@@ -54,6 +54,7 @@ 
      * @param string $name The name of the collection.
      *
      * @throws RuntimeException If invalid collection name.
+     * @return void
      */
     public function setCollection($name);
 
@@ -77,8 +78,9 @@ 
     /**
      * Set the compiled content.
      *
-     * @param $content Mixed The compiled content.
+     * @param string $content Mixed The compiled content.
      * @param $snapshotName The name of the snapshot. The snapshot "last" is not valid.
+     * @return void
      */
     public function setContent($content, $snapshotName);
 
@@ -92,7 +94,8 @@ 
     /**
      * Set the attributes of this item.
      *
-     * @param array $value
+     * @param array $values
+     * @return void
      */
     public function setAttributes(array $values);
 
@@ -117,6 +120,7 @@ 
      *
      * @param string $value e.g: "index.html" or "my-page/index.html"
      * @param $snapshotName The name of the snapshot. The snapshot "last" is not valid.
+     * @return void
      */
     public function setPath($value, $snapshotName);
 

src/Core/Spress.php

Unused Use Statements -1 removed lines

@@ -28,7 +28,6 @@
 use Yosymfony\Spress\Core\DataSource\DataSourceManagerBuilder;
 use Yosymfony\Spress\Core\DataWriter\FilesystemDataWriter;
 use Yosymfony\Spress\Core\IO\NullIO;
-use Yosymfony\Spress\Core\Plugin\PluginManager;
 use Yosymfony\Spress\Core\Plugin\PluginManagerBuilder;
 
 /**

src/Scaffolding/PluginGenerator.php

Doc Comments -1 removed lines

@@ -113,7 +113,6 @@
     /**
      * Sets the license of the plugin. MIT by default.
      *
-     * @param string $value
      */
     public function setLicense($name)
     {

src/Core/DataSource/Filesystem/FilesystemDataSource.php

Doc Comments +3 added lines

@@ -263,6 +263,9 @@
         ]));
     }
 
+    /**
+     * @param string $path
+     */
     private function createItem($path, $attributes = [], $binary = false)
     {
         $item = new Item('', $path, $attributes, $binary);

src/HttpServer/ServerRequest.php

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
     /**
      * Constructor.
      * 
-     * @param Symfony\Component\HttpFoundation\Request $request
+     * @param Request $request
      * @param string                                   $documentroot
      */
     public function __construct(Request $request, $documentroot)

src/HttpServer/HttpServer.php

Doc Comments +12 added lines, -1 removed lines

@@ -36,7 +36,6 @@ 
      * Constructor.
      *
      * @param IOInterface $io
-     * @param TwigFactory $twigFactory
      * @param string      $serverroot
      * @param string      $documentroot
      * @param int         $port
@@ -160,6 +159,11 @@ 
         return $finalResponse;
     }
 
+    /**
+     * @param string $ip
+     * @param string $path
+     * @param integer $statusCode
+     */
     private function logRequest($ip, $path, $statusCode)
     {
         $date = new \Datetime();
@@ -176,6 +180,9 @@ 
         $this->io->write($data);
     }
 
+    /**
+     * @param string $templateDir
+     */
     private function buildTwig($templateDir)
     {
         $options = [
@@ -189,6 +196,10 @@ 
         $this->twig = new \Twig_Environment($loader, $options);
     }
 
+    /**
+     * @param integer $statusCode
+     * @param string $data
+     */
     private function getErrorModel($statusCode, $data)
     {
         switch ($statusCode) {

src/Core/DataWriter/FilesystemDataWriter.php

Doc Comments +4 added lines, -1 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * Constructor.
      *
-     * @param Symfony\Component\Filesystem\Filesystem $filesystem
+     * @param Filesystem $filesystem
      * @param string                                  $outputDir  The output folder. e.g: "build".
      */
     public function __construct(Filesystem $filesystem, $outputDir)
@@ -97,6 +97,9 @@ 
     {
     }
 
+    /**
+     * @param string $relativePath
+     */
     protected function composeOutputPath($relativePath)
     {
         $path = $this->outputDir.'/'.$relativePath;