how to document private variable in phpdoc

Question

I am trying to document the private variable in phpdoc but its not documenting.

Here is my code:

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

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

The $_db and $_s3 both are not coming in documentation.

darklion · Accepted Answer · 2011-03-03 03:45:33Z

9

That's what supposed to happen - setting @access private prevents the following code block from appearing in the documentation.

To get it to appear you need to use the command line switch --parseprivate

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

edited Mar 3, 2011 at 3:45

answered Mar 2, 2011 at 9:23

darklion

1,0557 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

ashnazg Over a year ago

It's actually -pp or --parseprivate, but otherwise this answer is correct. Private items are not included in documentation by default.

Collectives™ on Stack Overflow

how to document private variable in phpdoc

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related