Merge pull request #6388 from kenjis/fix-phpdocs-CLI

kenjis · web-flow · commit f5ed714a59b6 · 2022-08-19T06:15:43.000+09:00
docs: add/fix @return types in CLI
diff --git a/system/CLI/BaseCommand.php b/system/CLI/BaseCommand.php
@@ -97,6 +97,8 @@ public function __construct(LoggerInterface $logger, Commands $commands)
      * Actually execute a command.
      *
      * @param array<int|string, string|null> $params
+     *
+     * @return int|void
      */
     abstract public function run(array $params);
 
diff --git a/system/CLI/Commands.php b/system/CLI/Commands.php
@@ -48,6 +48,8 @@ public function __construct($logger = null)
 
     /**
      * Runs a command given
+     *
+     * @return int|void
      */
     public function run(string $command, array $params)
     {
diff --git a/system/CLI/Console.php b/system/CLI/Console.php
@@ -25,7 +25,7 @@ class Console
      *
      * @throws Exception
      *
-     * @return mixed
+     * @return int|void
      */
     public function run()
     {

Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,8 @@ public function __construct(LoggerInterface $logger, Commands $commands)`
`97`	`97`	`* Actually execute a command.`
`98`	`98`	`*`
`99`	`99`	`* @param array<int\|string, string\|null> $params`
	`100`	`+ *`
	`101`	`+ * @return int\|void`
`100`	`102`	`*/`
`101`	`103`	`abstract public function run(array $params);`
`102`	`104`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,8 @@ public function __construct($logger = null)`
`48`	`48`
`49`	`49`	`/**`
`50`	`50`	`* Runs a command given`
	`51`	`+ *`
	`52`	`+ * @return int\|void`
`51`	`53`	`*/`
`52`	`54`	`public function run(string $command, array $params)`
`53`	`55`	`{`