Skip to content

Commit e8749eb

Browse files
Cleanup more @return annotations
1 parent 38f26c7 commit e8749eb

File tree

4 files changed

+25
-25
lines changed

4 files changed

+25
-25
lines changed

ExecutableFinder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public function addSuffix(string $suffix)
4444
* @param string|null $default The default to return if no executable is found
4545
* @param array $extraDirs Additional dirs to check into
4646
*
47-
* @return string|null The executable path or default value
47+
* @return string|null
4848
*/
4949
public function find(string $name, string $default = null, array $extraDirs = [])
5050
{

PhpExecutableFinder.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public function __construct()
2929
/**
3030
* Finds The PHP executable.
3131
*
32-
* @return string|false The PHP executable path or false if it cannot be found
32+
* @return string|false
3333
*/
3434
public function find(bool $includeArgs = true)
3535
{
@@ -85,7 +85,7 @@ public function find(bool $includeArgs = true)
8585
/**
8686
* Finds the PHP executable arguments.
8787
*
88-
* @return array The PHP executable arguments
88+
* @return array
8989
*/
9090
public function findArguments()
9191
{

Process.php

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -569,7 +569,7 @@ public function isOutputDisabled()
569569
/**
570570
* Returns the current output of the process (STDOUT).
571571
*
572-
* @return string The process output
572+
* @return string
573573
*
574574
* @throws LogicException in case the output has been disabled
575575
* @throws LogicException In case the process is not started
@@ -591,7 +591,7 @@ public function getOutput()
591591
* In comparison with the getOutput method which always return the whole
592592
* output, this one returns the new output since the last call.
593593
*
594-
* @return string The process output since the last call
594+
* @return string
595595
*
596596
* @throws LogicException in case the output has been disabled
597597
* @throws LogicException In case the process is not started
@@ -685,7 +685,7 @@ public function clearOutput()
685685
/**
686686
* Returns the current error output of the process (STDERR).
687687
*
688-
* @return string The process error output
688+
* @return string
689689
*
690690
* @throws LogicException in case the output has been disabled
691691
* @throws LogicException In case the process is not started
@@ -708,7 +708,7 @@ public function getErrorOutput()
708708
* whole error output, this one returns the new error output since the last
709709
* call.
710710
*
711-
* @return string The process error output since the last call
711+
* @return string
712712
*
713713
* @throws LogicException in case the output has been disabled
714714
* @throws LogicException In case the process is not started
@@ -776,7 +776,7 @@ public function getExitCodeText()
776776
/**
777777
* Checks if the process ended successfully.
778778
*
779-
* @return bool true if the process ended successfully, false otherwise
779+
* @return bool
780780
*/
781781
public function isSuccessful()
782782
{
@@ -855,7 +855,7 @@ public function getStopSignal()
855855
/**
856856
* Checks if the process is currently running.
857857
*
858-
* @return bool true if the process is currently running, false otherwise
858+
* @return bool
859859
*/
860860
public function isRunning()
861861
{
@@ -871,7 +871,7 @@ public function isRunning()
871871
/**
872872
* Checks if the process has been started with no regard to the current state.
873873
*
874-
* @return bool true if status is ready, false otherwise
874+
* @return bool
875875
*/
876876
public function isStarted()
877877
{
@@ -881,7 +881,7 @@ public function isStarted()
881881
/**
882882
* Checks if the process is terminated.
883883
*
884-
* @return bool true if process is terminated, false otherwise
884+
* @return bool
885885
*/
886886
public function isTerminated()
887887
{
@@ -895,7 +895,7 @@ public function isTerminated()
895895
*
896896
* The status is one of: ready, started, terminated.
897897
*
898-
* @return string The current process status
898+
* @return string
899899
*/
900900
public function getStatus()
901901
{
@@ -972,7 +972,7 @@ public function addErrorOutput(string $line)
972972
/**
973973
* Gets the last output time in seconds.
974974
*
975-
* @return float|null The last output time in seconds or null if it isn't started
975+
* @return float|null
976976
*/
977977
public function getLastOutputTime(): ?float
978978
{
@@ -982,27 +982,27 @@ public function getLastOutputTime(): ?float
982982
/**
983983
* Gets the command line to be executed.
984984
*
985-
* @return string The command to execute
985+
* @return string
986986
*/
987987
public function getCommandLine()
988988
{
989989
return \is_array($this->commandline) ? implode(' ', array_map([$this, 'escapeArgument'], $this->commandline)) : $this->commandline;
990990
}
991991

992992
/**
993-
* Gets the process timeout (max. runtime).
993+
* Gets the process timeout in seconds (max. runtime).
994994
*
995-
* @return float|null The timeout in seconds or null if it's disabled
995+
* @return float|null
996996
*/
997997
public function getTimeout()
998998
{
999999
return $this->timeout;
10001000
}
10011001

10021002
/**
1003-
* Gets the process idle timeout (max. time since last output).
1003+
* Gets the process idle timeout in seconds (max. time since last output).
10041004
*
1005-
* @return float|null The timeout in seconds or null if it's disabled
1005+
* @return float|null
10061006
*/
10071007
public function getIdleTimeout()
10081008
{
@@ -1071,7 +1071,7 @@ public function setTty(bool $tty)
10711071
/**
10721072
* Checks if the TTY mode is enabled.
10731073
*
1074-
* @return bool true if the TTY mode is enabled, false otherwise
1074+
* @return bool
10751075
*/
10761076
public function isTty()
10771077
{
@@ -1103,7 +1103,7 @@ public function isPty()
11031103
/**
11041104
* Gets the working directory.
11051105
*
1106-
* @return string|null The current working directory or null on failure
1106+
* @return string|null
11071107
*/
11081108
public function getWorkingDirectory()
11091109
{
@@ -1131,7 +1131,7 @@ public function setWorkingDirectory(string $cwd)
11311131
/**
11321132
* Gets the environment variables.
11331133
*
1134-
* @return array The current environment variables
1134+
* @return array
11351135
*/
11361136
public function getEnv()
11371137
{
@@ -1168,7 +1168,7 @@ public function setEnv(array $env)
11681168
/**
11691169
* Gets the Process input.
11701170
*
1171-
* @return resource|string|\Iterator|null The Process input
1171+
* @return resource|string|\Iterator|null
11721172
*/
11731173
public function getInput()
11741174
{
@@ -1321,7 +1321,7 @@ private function getDescriptors(): array
13211321
*
13221322
* @param callable|null $callback The user defined PHP callback
13231323
*
1324-
* @return \Closure A PHP closure
1324+
* @return \Closure
13251325
*/
13261326
protected function buildCallback(callable $callback = null)
13271327
{
@@ -1504,7 +1504,7 @@ private function resetProcessData()
15041504
* @param int $signal A valid POSIX signal (see https://php.net/pcntl.constants)
15051505
* @param bool $throwException Whether to throw exception in case signal failed
15061506
*
1507-
* @return bool True if the signal was sent successfully, false otherwise
1507+
* @return bool
15081508
*
15091509
* @throws LogicException In case the process is not running
15101510
* @throws RuntimeException In case --enable-sigchild is activated and the process can't be killed

ProcessUtils.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ private function __construct()
3535
* @param string $caller The name of method call that validates the input
3636
* @param mixed $input The input to validate
3737
*
38-
* @return mixed The validated input
38+
* @return mixed
3939
*
4040
* @throws InvalidArgumentException In case the input is not valid
4141
*/

0 commit comments

Comments
 (0)