phpDocumentor

phpDocumentor (opens new window)

Install

Change the version if this version out of date.

composer require phpdocumentor/phpdocumentor:v2.9.0

Usage

vendor/bin/phpdoc -d ../stcg/codecualeo -t ./docs/api

• -d : Source directory
• -t : Target directory

How to write docs

Example: Glossary (opens new window)

Mix

/** @var mixed  */
private $var;

String Or Null

/** @var string|null  */
private $var;

Array

/** @var int[] this is an array of int */
private $var;

/**
* This class acts as an example on where to position a DocBlock.
*/
class Foo extends FooParent
{
    /** @var string|null Should contain a description if available */
    protected $description = null;

    /**
    * This method sets a description.
    * @param string $description A text with a maximum of 80 characters.
    * @return void
    * @throws NullDescriptionException
    */
    public function setDescription($description)
    {
        // implement ...
    }

    /**
     * {@inheritdoc}
     */
    public function overrideMethod() 
    {
        // implement ...
    }
}

Reference

PHPDoc reference (opens new window)

Basic Syntax (opens new window)