consolidation / site-process

src/Util/RealtimeOutputHandler.php

Doc Comments +2 added lines

@@ -109,6 +109,8 @@
 
     /**
      * Make sure that every line in $buffer begins with a MARKER_ERR.
+     * @param string $buffer
+     * @param string $marker
      */
     protected function addMarker($buffer, $marker)
     {

src/Util/ArgumentProcessor.php

Doc Comments +3 added lines, -3 removed lines

@@ -18,10 +18,10 @@
      * to be executed and orders them as needed.
      *
      * @param AliasRecord $siteAlias Description of
-     * @param array $args Command and arguments to execute (source)
-     * @param array $options key / value pair of option and value in include
+     * @param string[] $args Command and arguments to execute (source)
+     * @param string[] $options key / value pair of option and value in include
      *   in final arguments
-     * @param array $optionsPassedAsArgs key / value pair of option and value
+     * @param string[] $optionsPassedAsArgs key / value pair of option and value
      *   to include in final arguments after the '--' argument.
      * @return array Command and arguments to execute
      */

src/ProcessBase.php

Doc Comments +5 added lines, -2 removed lines

@@ -44,7 +44,7 @@ 
      * @param string|null $cwd     The working directory or null to use the working dir of the current PHP process
      * @param array|null $env     The environment variables or null to use the same environment as the current PHP process
      * @param mixed|null $input   The input as stream resource, scalar or \Traversable, or null for no input
-     * @param int|float|null $timeout The timeout in seconds or null to disable
+     * @param integer $timeout The timeout in seconds or null to disable
      * @return Process
      */
     public static function fromShellCommandline($command, $cwd = null, array $env = null, $input = null, $timeout = 60)
@@ -66,6 +66,9 @@ 
         return $this->output;
     }
 
+    /**
+     * @return OutputInterface
+     */
     protected function realtimeStderr()
     {
         if ($this->stderr) {
@@ -181,7 +184,7 @@ 
     /**
      * Return a realTime output object.
      *
-     * @return callable
+     * @return RealtimeOutputHandler
      */
     public function showRealtime()
     {

src/SiteProcess.php

Doc Comments +1 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
     }
 
     /**
-     * @param string $cwd
+     * @param string $cd
      */
     public function setCd($cd)
     {
@@ -170,7 +170,6 @@ 
      * It is possible to use dot notation in the keys to access nested elements
      * within the site alias record.
      *
-     * @param AliasRecord $siteAlias
      * @param type $args
      * @return type
      */

src/Transport/TransportInterface.php

Doc Comments +3 added lines, -1 removed lines

@@ -16,6 +16,7 @@ 
     /**
      * Configure ourselves based on the settings of the process object
      * (e.g. isTty()).
+     * @return void
      */
     public function configure(Process $process);
 
@@ -25,7 +26,6 @@ 
      * alias points at a remote system, though, then the arguments are
      * escaped and wrapped in an appropriate ssh command.
      *
-     * @param AliasRecord $siteAlias alias record of target site.
      * @param array $args arguments provided by caller.
      * @return array command and arguments to execute.
      */
@@ -33,6 +33,8 @@ 
 
     /**
      * addChdir adds an appropriate 'chdir' / 'cd' command for the transport.
+     * @param string $cd
+     * @param \Consolidation\SiteProcess\SiteProcess $process
      */
     public function addChdir($cd, $args, $process);
 }