$classpackage = 'default'
[line 233]
set to the name of the package of the current class being parsed
$classpackages = array()
[line 153]
used in Converter::getClassPackage() to inherit package from parent classes.
format: array(classname => array(array(package,subpackage), array(package1,subpackage1),.... If a name conflict exists between two packages, automatic inheritance will not work, and the packages will need to be documented separately.
$classsubpackage = ''
[line 239]
set to the name of the subpackage of the current class being parsed
$classtree = array()
[line 140]
a tree of class inheritance by name.
format: array(childname => parentname, childname1 => parentname1, rootname => 0, ... )
$class_children = array()
[line 183]
An array of extended classes by package and parent class Format: array(packagename => array(parentclass => array(childclassname1, childclassname2,...
) ) )
$data =
[line 227]
data contains parsed structures for the current page being parsed
$elements = array()
[line 185]
$event_handlers = array(
'docblock' => 'handleDocBlock',
'page' => 'handlePage',
'class' => 'handleClass',
'define' => 'handleDefine',
'function' => 'handleFunction',
'method' => 'handleMethod',
'var' => 'handleVar',
'packagepage' => 'handlePackagePage',
'include' => 'handleInclude',
)
[line 210]
the functions which handle output from the
Parser
$links = array()
[line 128]
the workhorse of linking.
This array is an array of link objects of format: [package][subpackage][eltype][elname] = descendant of abstractLink eltype can be page|include|function|define|class|method|var if eltype is method or var, the array format is: [package][subpackage][eltype][class][elname]
$methods = array()
[line 83]
array of methods by package, subpackage and class
format: array(packagename => array(subpackagename => array(classname => array(methodname1 => parserMethod class, methodname2 => parserMethod class,...) ) ) ) )
$packageoutput = false
[line 203]
array of packages to parser and output documentation for, if not all packages should be documented
Format: array(package1,package2,...) or false if not set Use this option to limit output similar to ignoring files. If you have some temporary files that you don't want to specify by name but don't want included in output, set a package name for all the elements in your project, and set packageoutput to that name. the default package will be ignored. Parsing speed does not improve. If you want to ignore files for speed reasons, use the ignore command-line option
$pages = array()
[line 189]
$parsePrivate = false
[line 107]
set in
phpdoc.inc to the value of the parserprivate commandline option.
If this option is true, elements with an @access private tag will be parsed and displayed
$pkg_elements = array()
[line 187]
$private_class = false
[line 116]
this variable is used to prevent parsing of private elements if $parsePrivate is false.
it is also used by the packageoutput setting to prevent parsing of elements that aren't in the desired output packages
$quietMode = false
[line 246]
set in
phpdoc.inc to the value of the quitemode commandline option.
If this option is true, informative output while parsing will not be displayed (documentation is unaffected)
$targetDir =
[line 159]
used to set the output directory
$vars = array()
[line 100]
array of class variables by package, subpackage and class
format: array(packagename => array(subpackagename => array(classname => array(variablename1 => parserMethod class, variablename2 => parserMethod class,...) ) ) ) )