clean/phpdoc-md

<?php namespace Clean\PhpDocMd\Example;

/**
 * Example_Class is a sample class for demonstrating PHPDoc
 *
 * Example_Class is a class that has no real actual code, but merely
 * exists to help provide people with an understanding as to how the
 * various PHPDoc tags are used.
 */
class BasicClass
{
    /**
     * config
     *
     * @var array
     */
    public $config;

    /**
     * Constructs an object of some specific type with certain unspoken
     * defaults.
     *
     * @param array $options  the user's desired settings for the object being
     *      created.
     *
     * @return void
     */
    public function __construct(array $options)
    {
    }

    /**
     * Adds two arguments
     *
     * @param float $one First argument
     * @param float $two Second argument
     *
     * @return float
     *
     * @throws InvalidArgumentException Thrown when a param is invalid
     * @throws RuntimeException Thrown when something happens at runtime
     */
    public function addValues($one, $two)
    {
        // code...
    }

    /**
     * Returns one
     *
     * That is long description for one method
     * written in more then one line
     *
     * @return integer
     */
    final public static function one()
    {
        return 1;
    }

    protected function foo()
    {
        // code...
    }

    private function boo()
    {
        // code...
    }
}