Updated class DocBlocks - prepare for phpDocumentor

.gitignore

@@ -25,3 +25,5 @@ act.secrets
 # Local Magento src
 /magento
 
+# phpDocumentor
+/docs/

phpdoc.dist.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdocumentor
+        configVersion="3"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="https://www.phpdoc.org"
+        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd"
+>
+    <setting name="template.color" value="blue"/>
+    <paths>
+        <output>docs/api</output>
+        <cache>docs/cache</cache>
+    </paths>
+    <version number="3.0.0">
+        <api>
+            <source dsn=".">
+                <path>src</path>
+            </source>
+        </api>
+    </version>
+</phpdocumentor>

src/N98/Magento/Application.php

@@ -29,6 +29,11 @@
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use UnexpectedValueException;
 
+/**
+ * Class Application
+ *
+ * @package N98\Magento
+ */
 class Application extends BaseApplication
 {
     /**

src/N98/Magento/Command/AbstractMagentoStoreConfigCommand.php

@@ -16,6 +16,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * Class AbstractMagentoStoreConfigCommand
+ *
+ * @package N98\Magento\Command
+ */
 abstract class AbstractMagentoStoreConfigCommand extends AbstractMagentoCommand
 {
     /**

src/N98/Magento/Command/Admin/DisableNotificationsCommand.php

@@ -4,6 +4,11 @@
 
 use N98\Magento\Command\AbstractMagentoStoreConfigCommand;
 
+/**
+ * Toggle admin notification command
+ *
+ * @package N98\Magento\Command\Admin
+ */
 class DisableNotificationsCommand extends AbstractMagentoStoreConfigCommand
 {
     /**

src/N98/Magento/Command/Admin/User/AbstractAdminUserCommand.php

@@ -4,6 +4,11 @@
 
 use N98\Magento\Command\AbstractMagentoCommand;
 
+/**
+ * Class AbstractAdminUserCommand
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 abstract class AbstractAdminUserCommand extends AbstractMagentoCommand
 {
     /**

src/N98/Magento/Command/Admin/User/ChangePasswordCommand.php

@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * Change admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class ChangePasswordCommand extends AbstractAdminUserCommand
 {
     protected function configure()

src/N98/Magento/Command/Admin/User/ChangeStatusCommand.php

@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Change admin user status command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class ChangeStatusCommand extends AbstractAdminUserCommand
 {
     protected function configure()

src/N98/Magento/Command/Admin/User/CreateUserCommand.php

@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * Create admin user command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class CreateUserCommand extends AbstractAdminUserCommand
 {
     protected function configure()

src/N98/Magento/Command/Admin/User/DeleteUserCommand.php

@@ -11,7 +11,9 @@
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 
 /**
- * Class DeleteUserCommand
+ * Delete admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
  */
 class DeleteUserCommand extends AbstractAdminUserCommand
 {

src/N98/Magento/Command/Admin/User/ListCommand.php

@@ -6,6 +6,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * List admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class ListCommand extends AbstractAdminUserCommand
 {
     protected function configure()

src/N98/Magento/Command/Admin/User/LockCommand.php

@@ -7,6 +7,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Lock admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class LockCommand extends AbstractAdminUserCommand
 {
     /**

src/N98/Magento/Command/Admin/User/LockdownCommand.php

@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 
+/**
+ * Lockdown admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class LockdownCommand extends LockCommand
 {
     /**

src/N98/Magento/Command/Admin/User/UnlockCommand.php

@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 
+/**
+ * Unlock admin user password command
+ *
+ * @package N98\Magento\Command\Admin\User
+ */
 class UnlockCommand extends AbstractAdminUserCommand
 {
     /**

src/N98/Magento/Command/Cache/AbstractCacheCommand.php

@@ -9,6 +9,11 @@
 use N98\Magento\Command\AbstractMagentoCommand;
 use RuntimeException;
 
+/**
+ * Class AbstractCacheCommand
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class AbstractCacheCommand extends AbstractMagentoCommand
 {
     /**

src/N98/Magento/Command/Cache/CleanCommand.php

@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Clean cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class CleanCommand extends AbstractCacheCommand
 {
     protected function configure()

src/N98/Magento/Command/Cache/Dir/FlushCommand.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * this file is part of magerun
- *
- * @author Tom Klingenberg <https://github.com/ktomk>
- */
 
 namespace N98\Magento\Command\Cache\Dir;
 
@@ -15,9 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * Class FlushCommand
+ * Flush cache directory command
+ *
+ * @package N98\Magento\Command\Cache\Dir
  *
- * @package N98\Magento\Command\Cache
+ * @author Tom Klingenberg (https://github.com/ktomk)
  */
 class FlushCommand extends AbstractMagentoCommand
 {

src/N98/Magento/Command/Cache/DisableCommand.php

@@ -7,6 +7,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Disable cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class DisableCommand extends AbstractCacheCommand
 {
     protected function configure()

src/N98/Magento/Command/Cache/EnableCommand.php

@@ -7,6 +7,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Enable cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class EnableCommand extends AbstractCacheCommand
 {
     protected function configure()

src/N98/Magento/Command/Cache/FlushCommand.php

@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Flush cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class FlushCommand extends AbstractCacheCommand
 {
     protected function configure()

src/N98/Magento/Command/Cache/ListCommand.php

@@ -6,6 +6,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * List cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class ListCommand extends AbstractCacheCommand
 {
     protected function configure()

src/N98/Magento/Command/Cache/ReportCommand.php

@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Report cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class ReportCommand extends AbstractCacheCommand
 {
     protected function configure()

src/N98/Magento/Command/Cache/ViewCommand.php

@@ -10,6 +10,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Validator\Exception\RuntimeException;
 
+/**
+ * View cache command
+ *
+ * @package N98\Magento\Command\Cache
+ */
 class ViewCommand extends AbstractCacheCommand
 {
     protected function configure()

src/N98/Magento/Command/Category/Create/DummyCommand.php

@@ -13,6 +13,11 @@
 use Symfony\Component\Console\Question\ChoiceQuestion;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * Create category dummy command
+ *
+ * @package N98\Magento\Command\Category\Create
+ */
 class DummyCommand extends AbstractMagentoCommand
 {
     public const DEFAULT_CATEGORY_NAME = "My Awesome Category";

src/N98/Magento/Command/Cms/Banner/ToggleCommand.php

@@ -8,7 +8,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * Class ToggleCommand
+ * Toggle CMS banner command
  *
  * Only testable with closed source enterprise edition
  *

src/N98/Magento/Command/Cms/Block/ListCommand.php

@@ -8,7 +8,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * CMS Block ListCommand
+ * List CMS block command
  *
  * @package N98\Magento\Command\Cms\Block
  */

src/N98/Magento/Command/Cms/Block/ToggleCommand.php

@@ -8,7 +8,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * CMS Block ToggleCommand
+ * Toggle CMS block command
  *
  * @package N98\Magento\Command\Cms\Block
  */

src/N98/Magento/Command/Cms/Page/PublishCommand.php

@@ -8,7 +8,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * Class PublishCommand
+ * Publish CMS page command
  *
  * Only testable with closed source enterprise edition
  *

src/N98/Magento/Command/CommandAware.php

@@ -4,6 +4,11 @@
 
 use Symfony\Component\Console\Command\Command;
 
+/**
+ * Interface CommandAware
+ *
+ * @package N98\Magento\Command
+ */
 interface CommandAware
 {
     /**

src/N98/Magento/Command/CommandConfigAware.php

@@ -2,6 +2,11 @@
 
 namespace N98\Magento\Command;
 
+/**
+ * Interface CommandConfigAware
+ *
+ * @package N98\Magento\Command
+ */
 interface CommandConfigAware
 {
     /**

src/N98/Magento/Command/ComposerWrapper/EventSubscriber.php

@@ -7,6 +7,11 @@
 use Symfony\Component\Console\Event\ConsoleEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
+/**
+ * Class EventSubscriber
+ *
+ * @package N98\Magento\Command\ComposerWrapper
+ */
 class EventSubscriber implements EventSubscriberInterface
 {
     /**

src/N98/Magento/Command/Config/AbstractConfigCommand.php

@@ -6,6 +6,11 @@
 use Mage;
 use N98\Magento\Command\AbstractMagentoCommand;
 
+/**
+ * Class AbstractConfigCommand
+ *
+ * @package N98\Magento\Command\Config
+ */
 abstract class AbstractConfigCommand extends AbstractMagentoCommand
 {
     public const DISPLAY_NULL_UNKNOWN_VALUE = "NULL (NULL/\"unknown\" value)";

src/N98/Magento/Command/Config/DeleteCommand.php

@@ -9,6 +9,11 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Delete config command
+ *
+ * @package N98\Magento\Command\Config
+ */
 class DeleteCommand extends AbstractConfigCommand
 {
     protected function configure()