Document exceptions

Author: dmolineus

src/Version10/Definition/Builder/ConsoleApplicationBuilderInterface.php

@@ -4,20 +4,15 @@
 
 namespace Phpcq\PluginApi\Version10\Definition\Builder;
 
+use Phpcq\PluginApi\Version10\Exception\RuntimeException;
+
 /**
  * Interface describes a console application provided by a plugin.
+ *
+ * An application may contain either commands or arguments.
  */
 interface ConsoleApplicationBuilderInterface
 {
-    /**
-     * Adds a description to the console application.
-     *
-     * @param string $description The description of the console application
-     *
-     * @return self
-     */
-    public function withDescription(string $description): self;
-
     /**
      * Describe which value separator is used.
      *
@@ -36,14 +31,27 @@ public function withOptionValueSeparator(string $separator): self;
      * @param string $description The command description.
      *
      * @return ConsoleCommandBuilderInterface
+     *
+     * @throws RuntimeException When a command with the name is already described or any argument is described.
      */
     public function describeCommand(string $name, string $description): ConsoleCommandBuilderInterface;
 
+    /**
+     * Adds a new argument to the command with a name and a description.
+     *
+     * The order of the arguments descriptions defines the order of the expected arguments.
+     *
+     * @throws RuntimeException When an argument with the name is already described or any command is described.
+     */
+    public function describeArgument(string $name, string $description): ConsoleArgumentBuilderInterface;
+
     /**
      * Adds a new option to the exec task which will be available independent of the concrete command.
      *
      * @param string $name        The option name.
      * @param string $description The option description.
+     *
+     * @throws RuntimeException When an option with the name is already described.
      */
     public function describeOption(string $name, string $description): ConsoleOptionBuilderInterface;
 }

src/Version10/Definition/Builder/ConsoleCommandBuilderInterface.php

@@ -4,6 +4,8 @@
 
 namespace Phpcq\PluginApi\Version10\Definition\Builder;
 
+use Phpcq\PluginApi\Version10\Exception\RuntimeException;
+
 /**
  * This interface describes a console command with it's supported arguments and options.
  */
@@ -13,11 +15,15 @@ interface ConsoleCommandBuilderInterface
      * Adds a new argument to the command with a name and a description.
      *
      * The order of the arguments descriptions defines the order of the exepected arguments.
+     *
+     * @throws RuntimeException When an argument with the name is already described.
      */
     public function describeArgument(string $name, string $description): ConsoleArgumentBuilderInterface;
 
     /**
      * Adds a new option to the command with a name and a description.
+     *
+     * @throws RuntimeException When an option with the name is already described.
      */
     public function describeOption(string $name, string $description): ConsoleOptionBuilderInterface;
 }