Update doc blocks

Fixes #22

Author: hackzilla

Generator/AbstractPasswordGenerator.php

@@ -64,7 +64,7 @@ public function setOption($option, $optionSettings)
     /**
      * Remove Option.
      *
-     * @param $option
+     * @param string $option
      *
      * @return $this
      */

Generator/HumanPasswordGenerator.php

@@ -34,9 +34,9 @@ public function __construct()
     }
 
     /**
-     * Generate character list for us in generating passwords.
+     * Generate word list for us in generating passwords.
      *
-     * @return string[] Character list
+     * @return string[] Words
      *
      * @throws WordsNotFoundException
      */

Generator/PasswordGeneratorInterface.php

@@ -2,23 +2,119 @@
 
 namespace Hackzilla\PasswordGenerator\Generator;
 
+use Hackzilla\PasswordGenerator\Exception\InvalidOptionException;
+use Hackzilla\PasswordGenerator\Exception\InvalidOptionTypeException;
+use Hackzilla\PasswordGenerator\Model\Option\Option;
+use Hackzilla\PasswordGenerator\RandomGenerator\RandomGeneratorInterface;
+
 interface PasswordGeneratorInterface
 {
+    /**
+     * Possible options.
+     *
+     * @return array
+     */
     public function getOptions();
 
+    /**
+     * Set password generator option.
+     *
+     * @param string $option
+     * @param array  $optionSettings
+     *
+     * @return $this
+     * @throws InvalidOptionTypeException
+     */
     public function setOption($option, $optionSettings);
 
+    /**
+     * Get option.
+     *
+     * @param $option
+     *
+     * @return mixed
+     */
     public function getOption($option);
 
+//    /**
+//     * Remove Option.
+//     *
+//     * @param string $option
+//     *
+//     * @return $this
+//     */
+//    public function removeOption($option);
+
+    /**
+     * Set password generator option value.
+     *
+     * @param string $option
+     * @param $value
+     *
+     * @return $this
+     */
     public function setOptionValue($option, $value);
 
+    /**
+     * Get option value.
+     *
+     * @param $option
+     *
+     * @return mixed
+     */
     public function getOptionValue($option);
 
+    /**
+     * @param string $parameter
+     * @param mixed  $value
+     *
+     * @return $this
+     */
     public function setParameter($parameter, $value);
 
+    /**
+     * @param string $parameter
+     * @param mixed  $default
+     *
+     * @return null|mixed
+     */
     public function getParameter($parameter);
 
+    /**
+     * Generate $count number of passwords.
+     *
+     * @param int $count Number of passwords to return
+     *
+     * @return string[]
+     *
+     * @throws \InvalidArgumentException
+     */
     public function generatePasswords($count = 1);
 
+    /**
+     * Generate one password based on options.
+     *
+     * @return string password
+     */
     public function generatePassword();
+
+
+//    /**
+//     * Set source of randomness.
+//     *
+//     * @param RandomGeneratorInterface $randomGenerator
+//     *
+//     * @return $this
+//     */
+//    public function setRandomGenerator(RandomGeneratorInterface $randomGenerator);
+
+//    /**
+//     * Generate a random value
+//     *
+//     * @param int $min
+//     * @param int $max
+//     *
+//     * @return int
+//     */
+//    public function randomInteger($min, $max);
 }

Generator/RequirementPasswordGenerator.php

@@ -195,7 +195,7 @@ public function validLimits()
     }
 
     /**
-     * @param $option
+     * @param string $option
      *
      * @return bool
      */

Model/CharacterSet.php

@@ -6,16 +6,29 @@ class CharacterSet
 {
     private $characters;
 
+    /**
+     * CharacterSet constructor.
+     *
+     * @param string $characters
+     */
     public function __construct($characters)
     {
         $this->characters = $characters;
     }
 
+    /**
+     * Get Character set
+     *
+     * @return string
+     */
     public function getCharacters()
     {
         return $this->characters;
     }
 
+    /**
+     * @return string
+     */
     public function __toString()
     {
         if (!is_string($this->characters)) {

Model/Option/BooleanOption.php

@@ -7,11 +7,7 @@
 class BooleanOption extends Option
 {
     /**
-     * Set option boolean value.
-     *
-     * @param bool $value
-     *
-     * @throws \InvalidArgumentException
+     * {@inheritdoc}
      */
     public function setValue($value)
     {
@@ -22,6 +18,9 @@ public function setValue($value)
         parent::setValue($value);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getType()
     {
         return self::TYPE_BOOLEAN;

Model/Option/IntegerOption.php

@@ -9,6 +9,9 @@ class IntegerOption extends Option
     private $minRange;
     private $maxRange;
 
+    /**
+     * {@inheritdoc}
+     */
     public function __construct(array $settings = array())
     {
         parent::__construct($settings);
@@ -18,11 +21,7 @@ public function __construct(array $settings = array())
     }
 
     /**
-     * Set option integer value.
-     *
-     * @param int $value
-     *
-     * @throws \InvalidArgumentException
+     * {@inheritdoc}
      */
     public function setValue($value)
     {
@@ -37,6 +36,9 @@ public function setValue($value)
         parent::setValue($value);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getType()
     {
         return self::TYPE_INTEGER;

Model/Option/Option.php

@@ -10,28 +10,35 @@ abstract class Option implements OptionInterface
 
     private $value = null;
 
+    /**
+     * {@inheritdoc}
+     */
     public function __construct(array $settings = array())
     {
         if (isset($settings['default'])) {
             $this->value = $settings['default'];
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getValue()
     {
         return $this->value;
     }
 
     /**
-     * Set option value.
-     *
-     * @param mixed $value
+     * {@inheritdoc}
      */
     public function setValue($value)
     {
         $this->value = $value;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public static function createFromType($type, array $settings = array())
     {
         switch ($type) {

Model/Option/OptionInterface.php

@@ -4,11 +4,34 @@
 
 interface OptionInterface
 {
+    /**
+     * Option settings
+     * Things like default, min, and max
+     *
+     * @param array $settings
+     */
     public function __construct(array $settings);
 
+    /**
+     * Get option type
+     *
+     * @return string
+     */
     public function getType();
 
+    /**
+     * Get option value
+     *
+     * @return mixed
+     */
     public function getValue();
 
+    /**
+     * Set option string value.
+     *
+     * @param string $value
+     *
+     * @throws \InvalidArgumentException
+     */
     public function setValue($value);
 }

Model/Option/StringOption.php

@@ -9,6 +9,9 @@ class StringOption extends Option
     private $minRange;
     private $maxRange;
 
+    /**
+     * {@inheritdoc}
+     */
     public function __construct(array $settings = array())
     {
         parent::__construct($settings);
@@ -18,11 +21,7 @@ public function __construct(array $settings = array())
     }
 
     /**
-     * Set option string value.
-     *
-     * @param string $value
-     *
-     * @throws \InvalidArgumentException
+     * {@inheritdoc}
      */
     public function setValue($value)
     {
@@ -37,6 +36,9 @@ public function setValue($value)
         parent::setValue($value);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getType()
     {
         return self::TYPE_STRING;

RandomGenerator/RandomGeneratorInterface.php

@@ -4,5 +4,14 @@
 
 interface RandomGeneratorInterface
 {
+    /**
+     * Generates cryptographic random integers that are suitable for use where unbiased results are critical
+     * (i.e. shuffling a Poker deck).
+     *
+     * @param int $min
+     * @param int $max
+     *
+     * @return int
+     */
     public function randomInteger($min, $max);
 }