[TASK] Streamline command help (#256)

TYPO3-Console · Jul 28, 2016 · 365609f · 365609f
1 parent 621d54a
commit 365609f
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 14 deletions.
diff --git a/Classes/Command/CacheCommandController.php b/Classes/Command/CacheCommandController.php
@@ -30,7 +30,7 @@ class CacheCommandController extends CommandController
     protected $cacheService;
 
     /**
-     * Flush all caches.
+     * Flush all caches
      *
      * Flushes TYPO3 core caches first and after that, flushes caches from extensions.
      *
@@ -50,7 +50,7 @@ public function flushCommand($force = false)
     }
 
     /**
-     * Flush all caches in specified groups.
+     * Flush all caches in specified groups
      *
      * Flushes all caches in specified groups.
      * Valid group names are by default:

diff --git a/Classes/Command/ConfigurationCommandController.php b/Classes/Command/ConfigurationCommandController.php
@@ -34,7 +34,7 @@ class ConfigurationCommandController extends CommandController implements Single
     protected $consoleRenderer;
 
     /**
-     * Remove configuration option.
+     * Remove configuration option
      *
      * Removes a system configuration option by path.
      *
@@ -68,7 +68,7 @@ public function removeCommand(array $paths, $force = false)
     }
 
     /**
-     * Show configuration value.
+     * Show configuration value
      *
      * Shows system configuration value by path.
      * If the currently active configuration differs from the value in LocalConfiguration.php
@@ -101,7 +101,7 @@ public function showCommand($path)
     }
 
     /**
-     * Show active configuration value.
+     * Show active configuration value
      *
      * Shows active system configuration by path.
      * Shows the configuration value that is currently effective, no matter where and how it is set.
@@ -121,7 +121,7 @@ public function showActiveCommand($path)
     }
 
     /**
-     * Show local configuration value.
+     * Show local configuration value
      *
      * Shows local configuration option value by path.
      * Shows the value which is stored in LocalConfiguration.php.
@@ -143,7 +143,7 @@ public function showLocalCommand($path)
     }
 
     /**
-     * Set configuration value.
+     * Set configuration value
      *
      * Set system configuration option value by path.
      *

diff --git a/Classes/Command/DatabaseCommandController.php b/Classes/Command/DatabaseCommandController.php
@@ -124,7 +124,7 @@ public function importCommand($interactive = false)
     }
 
     /**
-     * Export database.
+     * Export database to stdout
      *
      * Export the database (all tables) directly to stdout.
      * The mysqldump binary must be available in the path for this command to work.

diff --git a/Classes/Command/ExtensionCommandController.php b/Classes/Command/ExtensionCommandController.php
@@ -44,7 +44,7 @@ class ExtensionCommandController extends CommandController
     protected $packageManager;
 
     /**
-     * Activate extension(s).
+     * Activate extension(s)
      *
      * Activates one or more extensions by key.
      * Marks extensions as active, sets them up and clears caches for every activated extension.
@@ -67,7 +67,7 @@ public function activateCommand(array $extensionKeys)
     }
 
     /**
-     * Deactivate extension(s).
+     * Deactivate extension(s)
      *
      * Deactivates one or more extensions by key.
      * Marks extensions as inactive in the system and clears caches for every deactivated extension.

diff --git a/Classes/Command/FrontendCommandController.php b/Classes/Command/FrontendCommandController.php
@@ -23,7 +23,7 @@
 class FrontendCommandController extends CommandController
 {
     /**
-     * Submit frontend request.
+     * Submit frontend request
      *
      * Submits a frontend request to TYPO3 on the specified URL.
      *

diff --git a/Classes/Command/HelpCommandController.php b/Classes/Command/HelpCommandController.php
@@ -16,6 +16,7 @@
 use Helhum\Typo3Console\Core\Booting\RunLevel;
 use Helhum\Typo3Console\Core\ConsoleBootstrap;
 use Helhum\Typo3Console\Mvc\Controller\CommandController;
+use TYPO3\CMS\Extbase\Mvc\Cli\Command;
 
 /**
  * A Command Controller which provides help for available commands
@@ -31,7 +32,7 @@ class HelpCommandController extends CommandController
     protected $commandManager;
 
     /**
-     * @var array
+     * @var Command[]
      */
     protected $commands = array();
 

diff --git a/Classes/Command/InstallCommandController.php b/Classes/Command/InstallCommandController.php
@@ -41,8 +41,9 @@ class InstallCommandController extends CommandController
     protected $packageStatesGenerator;
 
     /**
-     * TYPO3 Setup. Use as command line replacement for the web installation process.
+     * TYPO3 Setup
      *
+     * Use as command line replacement for the web installation process.
      * Manually enter details on the command line or non interactive for automated setups.
      *
      * @param bool $nonInteractive If specified, optional arguments are not requested, but default values are assumed.
@@ -82,7 +83,7 @@ public function setupCommand(
     }
 
     /**
-     * Generate PackageStates.php file.
+     * Generate PackageStates.php file
      *
      * Generates and writes <code>typo3conf/PackageStates.php</code> file.
      * Goal is to not have this file in version control, but generate it on <code>composer install</code>.