spress / spress

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/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/Configuration/Configuration.php

Doc Comments +6 added lines

@@ -100,6 +100,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $sitePath
+     */
     private function loadEnvironmentConfiguration($sitePath, $env)
     {
         $filename = $this->getConfigEnvFilename($env);
@@ -133,6 +136,9 @@ 
         return $filename;
     }
 
+    /**
+     * @param string $sitePath
+     */
     private function isSpressSite($sitePath)
     {
         return file_exists($sitePath.'/'.$this->configFilename);

src/Core/DataSource/ItemInterface.php

Doc Comments +6 added lines, -2 removed lines

@@ -57,6 +57,7 @@ 
      * @param string $name The name of the collection
      *
      * @throws RuntimeException If invalid collection name
+     * @return void
      */
     public function setCollection($name);
 
@@ -80,8 +81,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);
 
@@ -95,7 +97,8 @@ 
     /**
      * Set the attributes of this item.
      *
-     * @param array $value
+     * @param array $values
+     * @return void
      */
     public function setAttributes(array $values);
 
@@ -120,6 +123,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/Command/BaseCommand.php

Doc Comments +4 added lines, -1 removed lines

@@ -29,7 +29,7 @@ 
      * @param string $siteDir Root directory of an Spress site. "./" if this
      *                        value is null
      *
-     * @return Spress A Spress instance
+     * @return \Yosymfony\Spress\Core\Spress A Spress instance
      */
     public function getSpress($siteDir = null)
     {
@@ -55,6 +55,9 @@ 
     /**
      * Returns an EmbeddedComposer instance.
      *
+     * @param string $siteDir
+     * @param string $composerFilename
+     * @param string $vendorDir
      * @return Dflydev\EmbeddedComposer\Core\EmbeddedComposer
      */
     protected function getEmbeddedComposer($siteDir, $composerFilename, $vendorDir)

src/IO/ConsoleIO.php

Doc Comments +2 added lines, -2 removed lines

@@ -145,7 +145,7 @@ 
     /**
      * Formats a success result bar.
      *
-     * @param string|array $message The message
+     * @param string $message The message
      */
     public function success($message)
     {
@@ -165,7 +165,7 @@ 
     /**
      * Formats an warning result bar.
      *
-     * @param string|array $message The message
+     * @param string $message The message
      */
     public function warning($message)
     {

src/Scaffolding/Generator.php

Doc Comments +2 added lines, -2 removed lines

@@ -33,7 +33,7 @@ 
     /**
      * Sets a list of directories in which templates are located.
      *
-     * @param array $value
+     * @param string[] $value
      */
     public function setSkeletonDirs(array $value)
     {
@@ -58,7 +58,7 @@ 
     /**
      * Return an instance of Twig.
      *
-     * @return Twig_Environment The Twig instance
+     * @return \Twig_Environment The Twig instance
      */
     protected function getTwig()
     {

src/PackageManager/PackageManager.php

Doc Comments +2 added lines, -1 removed lines

@@ -208,6 +208,7 @@ 
     /**
      * Determines if package is a Spress theme.
      *
+     * @param string $packageName
      * @return bool
      *
      * @throws RuntimeException If the package doesn't exist
@@ -331,7 +332,7 @@ 
     /**
      * Returns a DownloadManager instance.
      *
-     * @return Composer\Downloader\DownloadManager
+     * @return \Composer\Downloader\DownloadManager
      */
     protected function createDownloadManager(Config $config)
     {

src/Command/NewThemeCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
      * Writes the staring messages.
      *
      * @param ConsoleIO $io       Spress IO
-     * @param string    $template The template
+     * @param string $siteDir
      */
     protected function startingMessage(ConsoleIO $io, $packageName, $siteDir)
     {