(phpDocumentor 0.1+ )
@access -- public or private. Private prevents documentation of the following element (if enabled). Default is public@access controls phpDocumentor's documentation of the following element.
If @access is private, the element will not be documented unless specified by command-line switch or in phpdoc.inc
Here is an example of how to use @access:
/** * function func1, public access is assumed */ function func1() { } /** * function func2, access is private, will not be documented * @access private */ function func2() { } /** * This is possible, but redundant. An element has @access public by default * @access public */ class class1 { /** * all text in this DocBlock will be ignored, unless command-line switch or setting in phpdoc.inc enables documenting of private elements * @access private */ var $private_var; /** * this function is documented */ function publicmethod() { } } |
Tag Documentation written by Gregory Beaver <cellog@users.sourceforge.net>
Copyright © 2002, Gregory Beaver