Add some docs

dnoegel · Aug 30, 2015 · d8eaa1a · d8eaa1a
1 parent f33175d
commit d8eaa1a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/src/ArgumentPopulator.php b/src/ArgumentPopulator.php
@@ -2,6 +2,11 @@
 
 namespace Argparse;
 
+/**
+ * Class ArgumentPopulator will iterate the tokens and populate the arguments corresponding to their configuration.
+ *
+ * @package Argparse
+ */
 class ArgumentPopulator
 {
     /** @var  $arguments Argument\ArgumentInterface[] */

diff --git a/src/ArgumentValidator.php b/src/ArgumentValidator.php
@@ -4,6 +4,10 @@
 
 use Argparse\Argument\ArgumentInterface;
 
+/**
+ * Class ArgumentValidator enforces, that all arguments with constraints (e.g. required, consume) are valid
+ * @package Argparse
+ */
 class ArgumentValidator
 {
     public function validate(ArgumentInterface $argument)

diff --git a/src/Token.php b/src/Token.php
@@ -2,6 +2,12 @@
 
 namespace Argparse;
 
+/**
+ * Class Token represents a single token of the commandline arguments passed to the script. E.g.
+ * "-f", "--filter" or "/home/user/test.zip"
+ *
+ * @package Argparse
+ */
 class Token
 {
     const TOKEN_VALUE = 'value';