как документировать приватную переменную в phpdoc

Question

Я пытаюсь задокументировать приватную переменную в phpdoc, но она не документируется.

Вот мой код:

class Content
{
    /**
    * simple db class variable
    * @access private
    */
    var $_db = null; // db
    private $_s3 = null; // s3

    /**
    * queue for mainting session queue1
    */
    public $queue = array();
}

$_db и $_s3 оба не включены в документацию.

Answer 1

Это то, что должно произойти - установка @access private предотвращает появление следующего блока кода в документации.

Чтобы он появился, вам нужно использовать переключатель командной строки --parseprivate

См. http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.access.pkg.html