@access
Access control for an element. @access private prevents documentation of the following element (if enabled).
by Gregory Beaver
Copyright 2002, Gregory Beaver
(phpDocumentor 0.1+)
@access
private
protected
public
Description@access controls phpDocumentor's documentation of an element.
If @access is private, the element will not be documented unless specified by command-line switch --parseprivate.
Example/**
* 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 a user INI file enables documenting of private elements
* @access private
*/
var $private_var;
/**
* Protected is allowed, but does absolutely nothing. Use it to inform users
* that an element should only be referenced by this and child classes,
* and not directly
* @access protected
*/
/**
* this function is documented
*/
function publicmethod()
{
}
}
|
|