[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Command / HelpCommandController.php
index 0f20eb7..e434e50 100644 (file)
@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Extbase\Command;
 /**
  * A Command Controller which provides help for available commands
  *
- * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
+ * @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0.
  */
 class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandController
 {
@@ -45,7 +45,6 @@ class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandCon
      * This only outputs the Extbase version number, context and some hint about how to
      * get more help about commands.
      *
-     * @return void
      * @internal
      */
     public function helpStubCommand()
@@ -61,10 +60,9 @@ class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandCon
      * Display help for a command
      *
      * The help command displays help for a given command:
-     * ./cli_dispatch.phpsh extbase help <command identifier>
+     * ./typo3/sysext/core/bin/typo3 extbase:help <command identifier>
      *
      * @param string $commandIdentifier Identifier of a command for more details
-     * @cli
      */
     public function helpCommand($commandIdentifier = null)
     {
@@ -82,7 +80,7 @@ class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandCon
     }
 
     /**
-     * @return void
+     * Builds an index of all commands that are available
      */
     protected function displayHelpIndex()
     {
@@ -112,7 +110,6 @@ class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandCon
      * Render help text for a single command
      *
      * @param \TYPO3\CMS\Extbase\Mvc\Cli\Command $command
-     * @return void
      */
     protected function displayHelpForCommand(\TYPO3\CMS\Extbase\Mvc\Cli\Command $command)
     {
@@ -187,7 +184,6 @@ class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandCon
      *
      * @internal
      * @param \TYPO3\CMS\Extbase\Mvc\Exception\CommandException $exception
-     * @return void
      */
     public function errorCommand(\TYPO3\CMS\Extbase\Mvc\Exception\CommandException $exception)
     {
@@ -206,8 +202,6 @@ class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandCon
     /**
      * Builds an index of available commands. For each of them a Command object is
      * added to the commands array of this class.
-     *
-     * @return void
      */
     protected function buildCommandsIndex()
     {