Index of all elements

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ x ]

a

$accessModifiers: in file PhpdocHTMLDocumentRenderer.php, variable PhpdocHTMLDocumentRenderer::$accessModifiers
Array of access modifiers.
$accessor: in file PhpdocHTMLRenderer.php, variable PhpdocHTMLRenderer::$accessor
XML data accessor object.
$accessor: in file PhpdocRendererObject.php, variable PhpdocRendererObject::$accessor
$application: in file PhpdocSetupHandler.php, variable PhpdocSetupHandler::$application
Name of the application parsed
$application: in file PhpdocObject.php, variable PhpdocObject::$application
Default applicationname for the generated HTML files.
$authorAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$authorAttributes
Attributes of the <author> container.
addBlock: in file ITX.php, method IntegratedTemplateExtension::addBlock()
Adds a block to the template changing a variable placeholder to a block placeholder.
addBlockfile: in file ITX.php, method IntegratedTemplateExtension::addBlockfile()
Adds a block taken from a file to the template changing a variable placeholder to a block placeholder.
addClass: in file PhpdocParser.php, method PhpdocParser::addClass()
Analyses the given file and adds the result to the class list.
addClass: in file PhpdocIndexer.php, method PhpdocIndexer::addClass()
Adds a class to the index lists (elements, packages, classtree).
addClasstree: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::addClasstree()
Adds a classtree to the classtree summary template.
addDocWarning: in file PhpdocWarning.php, method PhpdocWarning::addDocWarning()
Adds a warning to the list of class documentation failures.
addElement: in file PhpdocXMLWriter.php, method PhpdocXMLWriter::addElement()
Adds a complete xml container to the generated xml document.
addElements: in file PhpdocIndexer.php, method PhpdocIndexer::addElements()
Adds an element to the elementlist.
addInheritedElements: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::addInheritedElements()
Adds inherited functions, variables, constants or included files to a class.
addModule: in file PhpdocParser.php, method PhpdocParser::addModule()
Analyses the given file and adds the result to the module list.
addModule: in file PhpdocIndexer.php, method PhpdocIndexer::addModule()
Adds a module to the index lists (elements, packages, classtree).
addModulegroup: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::addModulegroup()
Renders a modulegroup xml file.
addNumberSuffix: in file PhpdocAnalyser.php, method PhpdocAnalyser::addNumberSuffix()
Adds a suffix to the number like 1st, 2nd and 3th
addSubclasses: in file PhpdocParser.php, method PhpdocParser::addSubclasses()
Adds recursively subclasses to the specified class.
addToArray: in file PhpdocXMLReader.php, method PhpdocXMLReader::addToArray()
Appends some values to an array
addWarnings: in file PhpdocHTMLWarningRenderer.php, method PhpdocHTMLWarningRenderer::addWarnings()
Adds file with warnings to the warning list.
addXML: in file PhpdocXMLWriter.php, method PhpdocXMLWriter::addXML()
Adds xml to the generated xml.
analyse: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::analyse()
analyse: in file PhpdocAnalyser.php, method PhpdocAnalyser::analyse()
Starts the analysing of the raw parsing data.
analyse: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::analyse()
analyseClass: in file PhpdocClassParser.php, method PhpdocClassParser::analyseClass()
Analyse a class
analyseClassDoc: in file PhpdocClassParser.php, method PhpdocClassParser::analyseClassDoc()
Analyses a class doc comment.
analyseConstant: in file PhpdocConstantParser.php, method PhpdocConstantParser::analyseConstant()
Scans the given constant doc comment.
analyseFunction: in file PhpdocFunctionParser.php, method PhpdocFunctionParser::analyseFunction()
Analyses a function doc comment.
analyseModule: in file PhpdocModuleParser.php, method PhpdocModuleParser::analyseModule()
Central module parsing function.
analyseModuleDoc: in file PhpdocModuleParser.php, method PhpdocModuleParser::analyseModuleDoc()
Extracts the allowed documentation tags out of a module doc comment.
analyseSeeTagRegs: in file PhpdocParserTags.php, method PhpdocParserTags::analyseSeeTagRegs()
Helperfunction to analyse see tags
analyseTags: in file PhpdocParserTags.php, method PhpdocParserTags::analyseTags()
Extract the value from the given tags and copy the data to the $data array if its an allowed tag
analyseUse: in file PhpdocUseParser.php, method PhpdocUseParser::analyseUse()
Takes the result from getPhpdocParagraphs() and interprets it.
analyseVariable: in file PhpdocVariableParser.php, method PhpdocVariableParser::analyseVariable()
Analyses a variable doc comment
appendToFile: in file PhpdocFileHandler.php, method PhpdocFileHandler::appendToFile()
Appends a string to a file.
authorXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::authorXML()
Adds <author> container to the xml document.

top

b

$baseclass

in file PhpdocClassAnalyser.php, variable PhpdocClassAnalyser::$baseclass
Name of the baseclass of the given classes.

$baseclasses

in file PhpdocParser.php, variable PhpdocParser::$baseclasses
List of all parentclasses found.

$basedir

in file PhpdocSetupHandler.php, variable PhpdocSetupHandler::$basedir
Basedir for all file operations

$blockdata

in file IT.php, variable IntegratedTemplate::$blockdata
Array with the parsed content of a block.

$blockinner

in file IT.php, variable IntegratedTemplate::$blockinner
Array of inner blocks of a block.

$blocklist

in file IT.php, variable IntegratedTemplate::$blocklist
Array of all blocks and their content.

$blocknameRegExp

in file IT.php, variable IntegratedTemplate::$blocknameRegExp
RegExp matching a block in the template.

$blockRegExp

in file IT.php, variable IntegratedTemplate::$blockRegExp
Full RegExp used to find blocks an their content, filled by the constructor.

$blocktypes

in file IT.php, variable IntegratedTemplate::$blocktypes
Future versions will use this...

$blockvariables

in file IT.php, variable IntegratedTemplate::$blockvariables
Array of variables in a block.

baseclassXML

in file PhpdocXMLClassExporter.php, method PhpdocXMLClassExporter::baseclassXML()
Adds a baseclass container to the generated xml.

buildBlockvariablelist

in file IT.php, method IntegratedTemplate::buildBlockvariablelist()
Build a list of all variables within a block

buildBottomUpClasslist

in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::buildBottomUpClasslist()
Builds an internal list of all classes.

buildChapterlist

in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::buildChapterlist()
Builds the internal chapterlists.

buildClasstree

in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::buildClasstree()
Extracts the classtree data of the xml file.

buildClasstreeHTML

in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::buildClasstreeHTML()
Recursivly builds an HTML class tree using

buildComplexRegExps

in file PhpdocParserRegExp.php, method PhpdocParserRegExp::buildComplexRegExps()
Builds complex regular expressions for the parser.

buildElementlist

in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::buildElementlist()
Builds an array with all elements of a class and saves it to $this->elementlist.

buildElementlist

in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::buildElementlist()
Builds an array with all elements of a class and saves it to $this->elementlist.

buildElementlist

in file PhpdocAnalyser.php, method PhpdocAnalyser::buildElementlist()
Build a list of all elemente (functions, variables,...) of a certain class/module

buildInheritedlist

in file PhpdocClassAccessor.php, method PhpdocClassAccessor::buildInheritedlist()
Builds a list of inherited elements.

buildModulegroup

in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::buildModulegroup()
Extracts the modulegroup data of the xml file.

buildModulelist

in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::buildModulelist()
Builds an internal list of all modules in the modulegroup.

buildPackagelist

in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::buildPackagelist()
Builds the internal packagelist.

buildSubclasslist

in file PhpdocClassAccessor.php, method PhpdocClassAccessor::buildSubclasslist()
Builds a list of subclasses

buildUseslist

in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::buildUseslist()
Adds a list of included files to the internal data array.

buildWarnings

in file PhpdocWarningAccessor.php, method PhpdocWarningAccessor::buildWarnings()
Build the internal list of warnings.

top

c

$chapterAttributes: in file PhpdocXMLIndexExporter.php, variable PhpdocXMLIndexExporter::$chapterAttributes
Chapter tag attributes
$chapternames: in file PhpdocIndexAccessor.php, variable PhpdocIndexAccessor::$chapternames
Ordered list of all chapternames.
$chapters: in file PhpdocIndexAccessor.php, variable PhpdocIndexAccessor::$chapters
Ordered list of all chapters.
$checkblocknameRegExp: in file ITX.php, variable IntegratedTemplateExtension::$checkblocknameRegExp
RegExp used to test for a valid blockname.
$classAttributes: in file PhpdocXMLClassExporter.php, variable PhpdocXMLClassExporter::$classAttributes
Class container attributes.
$classes: in file PhpdocClassParser.php, variable PhpdocClassParser::$classes
Array of all classes in the given code
$classes: in file PhpdocParser.php, variable PhpdocParser::$classes
Hash with the data of the current class tree (one parentclass with all children).
$classes: in file PhpdocClassAnalyser.php, variable PhpdocClassAnalyser::$classes
Class data.
$classfiles: in file PhpdocParser.php, variable PhpdocParser::$classfiles
List of all files containing classes.
$classlist: in file PhpdocClassAnalyser.php, variable PhpdocClassAnalyser::$classlist
Ordered list of all classes.
$classname: in file PhpdocError.php, variable PhpdocError::$classname
Name of the error object class used to construct the error message
$classnamesToFilenames: in file PhpdocParser.php, variable PhpdocParser::$classnamesToFilenames
Mapping from classnames to filenames
$classrenderer: in file PhpdocHTMLRendererManager.php, variable PhpdocHTMLRendererManager::$classrenderer
$classTags: in file PhpdocClassParser.php, variable PhpdocClassParser::$classTags
Array of tags that are allowed in front of the class keyword
$classtree: in file PhpdocHTMLIndexRenderer.php, variable PhpdocHTMLIndexRenderer::$classtree
Array with classtree informations
$classtree: in file PhpdocIndexer.php, variable PhpdocIndexer::$classtree
Current classtree.
$classtree: in file PhpdocParser.php, variable PhpdocParser::$classtree
Hash of all class trees.
$classtree: in file PhpdocIndexAccessor.php, variable PhpdocIndexAccessor::$classtree
Data of a classtree
$clearCache: in file IT.php, variable IntegratedTemplate::$clearCache
Clear cache on get()?
$clearCacheOnParse: in file IT.php, variable IntegratedTemplate::$clearCacheOnParse
$closingDelimiter: in file IT.php, variable IntegratedTemplate::$closingDelimiter
Last character of a variable placeholder ( {VARIABLE_}_ ).
$constants: in file PhpdocHTMLDocumentRenderer.php, variable PhpdocHTMLDocumentRenderer::$constants
Array of constants.
$constantTags: in file PhpdocConstantParser.php, variable PhpdocConstantParser::$constantTags
Doc Tags allowed with const[ant].
$constAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$constAttributes
Attributes of the <constant> container.
$currentBlock: in file IT.php, variable IntegratedTemplate::$currentBlock
Name of the current block.
$currentFile: in file PhpdocParser.php, variable PhpdocParser::$currentFile
Name of the file currently parsed.
$current_baseclass: in file PhpdocParser.php, variable PhpdocParser::$current_baseclass
Name of the base class of the current class tree.
$C_BASE: in file PhpdocParserRegExp.php, variable PhpdocParserRegExp::$C_BASE
Basis regular expressions used to compose complex expressions to grep doc comments.
$C_COMPLEX: in file PhpdocParserRegExp.php, variable PhpdocParserRegExp::$C_COMPLEX
List of regular expressions used to grep complex doc comments.
checkArgDocs: in file PhpdocAnalyser.php, method PhpdocAnalyser::checkArgDocs()
Compares the argument list generated from the function head with the param tags found.
checkConstantDoc: in file PhpdocConstantParser.php, method PhpdocConstantParser::checkConstantDoc()
Compares the data from the parser with the optional const[ant] tags
checkFunctionArgs: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::checkFunctionArgs()
checkFunctionArgs: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::checkFunctionArgs()
Checks the function documentation of a certain class.
checkFunctionArgs: in file PhpdocAnalyser.php, method PhpdocAnalyser::checkFunctionArgs()
Compares the param tags with the function head found.
checkParserErrors: in file PhpdocParserTags.php, method PhpdocParserTags::checkParserErrors()
Takes an array filled by analyseTags() and converts the parse errors into a single error message.
checkSee: in file PhpdocAnalyser.php, method PhpdocAnalyser::checkSee()
Checks all see references in the given classes/modulegroup.
checkSee: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::checkSee()
checkSee: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::checkSee()
checkSeeElement: in file PhpdocAnalyser.php, method PhpdocAnalyser::checkSeeElement()
Checks see references in the given elementlist.
checkSeeElements: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::checkSeeElements()
Checks see references in the given element array (functions, variables...)
checkSeeElements: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::checkSeeElements()
Checks see references in the given element array (functions, variables...)
checkStatus: in file PhpdocSetupHandler.php, method PhpdocSetupHandler::checkStatus()
Checks the current status of the object. Are all necessary informations to start parsing available?
checkVarDocs: in file PhpdocVariableParser.php, method PhpdocVariableParser::checkVarDocs()
Compares the var tag informations with the analyse of the source code.
constsXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::constsXML()
Adds all constants (define(), const) to the xml document.
convertPath: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::convertPath()
Converts a xml path array to a path that can be passed to the user.
copyBrotherSisterFields: in file PhpdocAnalyser.php, method PhpdocAnalyser::copyBrotherSisterFields()
Copies fields from a brother or sister to the current element.
create: in file PhpdocXMLModuleExporter.php, method PhpdocXMLModuleExporter::create()
create: in file PhpdocXMLWarningExporter.php, method PhpdocXMLWarningExporter::create()
create: in file PhpdocXMLClassExporter.php, method PhpdocXMLClassExporter::create()
createFile: in file PhpdocFileHandler.php, method PhpdocFileHandler::createFile()
Creates a new file.
createFilehandler: in file PhpdocXMLReader.php, method PhpdocXMLReader::createFilehandler()
Creates a PhpdocFileHandler object and saves it to $filehandler if it does not already exist.

top

d

$data: in file PhpdocAccessor.php, variable PhpdocAccessor::$data
Reformatted PhpdocXMLReader result array
$docTags: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$docTags
Mapping from internal result array index name to xml tag name.
$doc_warnings: in file PhpdocWarning.php, variable PhpdocWarning::$doc_warnings
Hash of documentation failures.
deleteFromBlockvariablelist: in file ITX.php, method IntegratedTemplateExtension::deleteFromBlockvariablelist()
Deletes one or many variables from the block variable list.
docXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::docXML()
Adds a documentation block (author, links, see, params...) to the xml document

top

e

$elementAttributes: in file PhpdocXMLIndexExporter.php, variable PhpdocXMLIndexExporter::$elementAttributes
Element tag attributes.
$elementFields: in file PhpdocIndexer.php, variable PhpdocIndexer::$elementFields
Array of fields that get added to the elementlist
$elementlist: in file PhpdocAnalyser.php, variable PhpdocAnalyser::$elementlist
List of all elements of a certain class/module.
$elements: in file PhpdocIndexer.php, variable PhpdocIndexer::$elements
Array of all elements (functions, variables, constant, included files, classes, packages).
$emptyClass: in file PhpdocClassParser.php, variable PhpdocClassParser::$emptyClass
Default values of a class
$emptyConstant: in file PhpdocConstantParser.php, variable PhpdocConstantParser::$emptyConstant
Internal structure use to save a constant.
$emptyFunction: in file PhpdocFunctionParser.php, variable PhpdocFunctionParser::$emptyFunction
Internal structur of a function.
$emptyModule: in file PhpdocModuleParser.php, variable PhpdocModuleParser::$emptyModule
Empty hash that shows the structure of a module.
$emptyUse: in file PhpdocUseParser.php, variable PhpdocUseParser::$emptyUse
Structure of an empty use entry.
$emptyVariable: in file PhpdocVariableParser.php, variable PhpdocVariableParser::$emptyVariable
Array with default values of a variable
$err: in file IT.php, variable IntegratedTemplate::$err
Contains the error objects
$err: in file PhpdocObject.php, variable PhpdocObject::$err
Variable containing the latest exceptions.
$errorHandling: in file PhpdocError.php, variable PhpdocError::$errorHandling
Array that describes how an error gets handled.
$error_append: in file PhpdocError.php, variable PhpdocError::$error_append
Error append, used for HTML formatting.
$error_message_prefix: in file PhpdocError.php, variable PhpdocError::$error_message_prefix
Error message prefix.
$error_prepend: in file PhpdocError.php, variable PhpdocError::$error_prepend
Error prepend, used for HTML formatting.
encode: in file PhpdocHTMLRenderer.php, method PhpdocHTMLRenderer::encode()
Encodes the given string.
endElement: in file PhpdocXMLWriter.php, method PhpdocXMLWriter::endElement()
Adds a closing xml tag to the generated xml document.
export: in file PhpdocXMLWriter.php, method PhpdocXMLWriter::export()
Saves the xml to the specified file.
export: in file PhpdocXMLExporter.php, method PhpdocXMLExporter::export()
Exports the given result array as xml document.
exportClasstree: in file PhpdocXMLIndexExporter.php, method PhpdocXMLIndexExporter::exportClasstree()
Exports a classtree
exportElementlist: in file PhpdocXMLIndexExporter.php, method PhpdocXMLIndexExporter::exportElementlist()
Exports a list of all elements
exportModulegroup: in file PhpdocXMLIndexExporter.php, method PhpdocXMLIndexExporter::exportModulegroup()
Exports a modulegroup.
exportPackagelist: in file PhpdocXMLIndexExporter.php, method PhpdocXMLIndexExporter::exportPackagelist()
Exports a packagelist
extractPhpdoc: in file PhpdocParserCore.php, method PhpdocParserCore::extractPhpdoc()
Strips '/xx', 'x/' and x from doc comments (x means asterix).

top

f

$file: in file PhpdocError.php, variable PhpdocError::$file
File where the error occured.
$filehandler: in file PhpdocXMLReader.php, variable PhpdocXMLReader::$filehandler
PHPDocFileHandler object.
$fileHandler: in file PhpdocXMLWriter.php, variable PhpdocXMLWriter::$fileHandler
Filehandler used for IO operations
$fileprefix: in file PhpdocXMLClassExporter.php, variable PhpdocXMLClassExporter::$fileprefix
$fileprefix: in file PhpdocXMLExporter.php, variable PhpdocXMLExporter::$fileprefix
Filename prefix for the generated xml document.
$fileprefix: in file PhpdocXMLWarningExporter.php, variable PhpdocXMLWarningExporter::$fileprefix
$fileprefix: in file PhpdocXMLModuleExporter.php, variable PhpdocXMLModuleExporter::$fileprefix
$fileRoot: in file IT.php, variable IntegratedTemplate::$fileRoot
Root directory for all file operations.
$file_extension: in file PhpdocRendererObject.php, variable PhpdocRendererObject::$file_extension
Extension for generated files.
$flagBlocktrouble: in file IT.php, variable IntegratedTemplate::$flagBlocktrouble
Internal flag indicating that a blockname was used multiple times.
$flagBuild: in file PhpdocIndexAccessor.php, variable PhpdocIndexAccessor::$flagBuild
Flag indicating that certain internal datafield have been filled.
$flagGlobalParsed: in file IT.php, variable IntegratedTemplate::$flagGlobalParsed
Flag indicating that the global block was parsed.
$flag_build: in file PhpdocWarningAccessor.php, variable PhpdocWarningAccessor::$flag_build
Flag used to detect if get_xy() was called.
$flag_classtree: in file PhpdocParser.php, variable PhpdocParser::$flag_classtree
Flag indicating that getClassTree() was called.
$flag_get: in file PhpdocAnalyser.php, variable PhpdocAnalyser::$flag_get
Flag indicating that getModule/getClass was called.
$flag_modulegroup: in file PhpdocParser.php, variable PhpdocParser::$flag_modulegroup
Flag indicating that getModulegroup was called.
$flag_output: in file PhpdocObject.php, variable PhpdocObject::$flag_output
Flag determining wheter to print some status messages or not (default: false)
$flag_output: in file Phpdoc.php, variable Phpdoc::$flag_output
Print status messages
$freeOnGet: in file PhpdocWarningAccessor.php, variable PhpdocWarningAccessor::$freeOnGet
If set to true all get_xy() functions will free their resources.
$freeOnGet: in file PhpdocAccessor.php, variable PhpdocAccessor::$freeOnGet
Free xml resources on calling a getXY() function?
$functionAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$functionAttributes
Attribues of the <function> container.
$functions: in file PhpdocHTMLDocumentRenderer.php, variable PhpdocHTMLDocumentRenderer::$functions
Array of functions found in the xml document.
$functionTags: in file PhpdocFunctionParser.php, variable PhpdocFunctionParser::$functionTags
Array of tags that are allowed in front of the function keyword
filenameXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::filenameXML()
Writes a <file> container.
findClassTrees: in file PhpdocParser.php, method PhpdocParser::findClassTrees()
Builds a hash of all class trees.
findModulegroups: in file PhpdocParser.php, method PhpdocParser::findModulegroups()
Builds the hash of module groups and the module file list.
findPlaceholderBlocks: in file ITX.php, method IntegratedTemplateExtension::findPlaceholderBlocks()
Returns an array of blocknames where the given variable placeholder is used.
findUndocumented: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::findUndocumented()
findUndocumented: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::findUndocumented()
Looks for undocumented elements in a certain class
findUndocumented: in file PhpdocAnalyser.php, method PhpdocAnalyser::findUndocumented()
Looks for undocumented elements and adds a warning if neccessary.
finish: in file PhpdocHTMLRendererManager.php, method PhpdocHTMLRendererManager::finish()
Finishes the rendering process.
finishClasstree: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::finishClasstree()
Saves the generated classtree summary to disk.
finishModulegroup: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::finishModulegroup()
finishWarnings: in file PhpdocHTMLWarningRenderer.php, method PhpdocHTMLWarningRenderer::finishWarnings()
Saves the generated report.
free: in file IT.php, method IntegratedTemplate::free()
Clears all datafields of the object.
free: in file PhpdocXMLWriter.php, method PhpdocXMLWriter::free()
Clears the internal xml data buffer so that a new document can be passed to the object.
functionsXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::functionsXML()
Adds a list of functions to the xml file.

top

g

$globalAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$globalAttributes
Attributes of the <global> container.
generate: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::generate()
Builds all index files phpdoc needs assuming that the xml files have default names
get: in file PhpdocFileHandler.php, method PhpdocFileHandler::get()
Reads a list of files or one file.
get: in file IT.php, method IntegratedTemplate::get()
Returns a block with all replacements done.
getAttributes: in file PhpdocXMLExporter.php, method PhpdocXMLExporter::getAttributes()
Kind of array_intersect for xml attributes.
getChapternames: in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::getChapternames()
Returns an ordered list of all chapternames.
getChapters: in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::getChapters()
Returns an ordered list of all chapters.
getCheckedDirname: in file PhpdocSetupHandler.php, method PhpdocSetupHandler::getCheckedDirname()
Adds a slash at the end of the given filename if neccessary.
getClass: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::getClass()
Returns an analysed class or false if there're no classes any more.
getClassdata: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::getClassdata()
Returns an array with the data of a class (no functions etc, just the class docs).
getClasses: in file PhpdocParserCore.php, method PhpdocParserCore::getClasses()
Returns a list of classes found in the given code.
getClassnamesToFilenames: in file PhpdocParser.php, method PhpdocParser::getClassnamesToFilenames()
Returns the mapping array from classnames to filenames
getClasstree: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::getClasstree()
Returns an array with the "path" of a class.
getClasstree: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::getClasstree()
Returns a html string that shows the class tree.
getClasstree: in file PhpdocIndexer.php, method PhpdocIndexer::getClasstree()
Returns the current classtree and resets the internal classtree field.
getClassTree: in file PhpdocParser.php, method PhpdocParser::getClassTree()
Returns the data of one parentclass and all it's subclasses or false.
getClasstree: in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::getClasstree()
Returns a classtree.
getConstants: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getConstants()
Returns an array of all constants.
getConstantsByAccess: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getConstantsByAccess()
Returns an array of all constants with a certain access (public, private) attribute.
getDescription: in file PhpdocParserCore.php, method PhpdocParserCore::getDescription()
Extract the description from a PHPDoc doc comment.
getElementlist: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getElementlist()
Adds a list of a certain element to the internal data array.
getElementlist: in file PhpdocIndexer.php, method PhpdocIndexer::getElementlist()
Returns the element index list and resets the internal elements field.
getElements: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getElements()
Returns elements from the internal $data array.
getElementsByAccess: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getElementsByAccess()
Returns elements with a certain access type from the internal data.
getFile: in file PhpdocFileHandler.php, method PhpdocFileHandler::getFile()
Reads a file.
getFile: in file IT.php, method IntegratedTemplate::getFile()
Reads a file from disk and returns its content.
getFilesInDirectory: in file PhpdocFileHandler.php, method PhpdocFileHandler::getFilesInDirectory()
Returns a list of files in a specified directory
getFunctionArgs: in file PhpdocFunctionParser.php, method PhpdocFunctionParser::getFunctionArgs()
Analyses a function head and returns an array of arguments.
getFunctions: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getFunctions()
Returns an array with all functions.
getFunctionsByAccess: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getFunctionsByAccess()
Returns an array with all functions with a certain access (public, private) attribute.
getGlobalvariables: in file IT.php, method IntegratedTemplate::getGlobalvariables()
Returns a list of all
getIndent: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::getIndent()
Returns a certain number of " "s.
getInheritedConstants: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::getInheritedConstants()
Returns an array of inherited constants.
getInheritedFunctions: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::getInheritedFunctions()
Returns an array of inherited functions.
getInheritedUses: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::getInheritedUses()
Returns an array of inherited included files.
getInheritedVariables: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::getInheritedVariables()
Returns an array of inherited variables.
getMessage: in file PhpdocError.php, method PhpdocError::getMessage()
Returns a string with the error message.
getModule: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::getModule()
Returns a module from the modulegroup or false if there are no more modules.
getModuledata: in file PhpdocModuleAccessor.php, method PhpdocModuleAccessor::getModuledata()
Returns an array with the data of a module (no functions etc, just the module docs).
getModuleDoc: in file PhpdocParserCore.php, method PhpdocParserCore::getModuleDoc()
Tries to extract a module doc.
getModulegroup: in file PhpdocParser.php, method PhpdocParser::getModulegroup()
Returns the data of one module group.
getModulegroup: in file PhpdocIndexer.php, method PhpdocIndexer::getModulegroup()
Returns the current modulegroup and resets the internal modulegroup field.
getModulegroup: in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::getModulegroup()
Returns a modulegroup
getModulesAndClasses: in file PhpdocParserCore.php, method PhpdocParserCore::getModulesAndClasses()
Does a quick prescan to find modules and classes.
getNumDocWarnings: in file PhpdocWarning.php, method PhpdocWarning::getNumDocWarnings()
Returns the total number of documentation warnings.
getPackagelist: in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::getPackagelist()
Returns a list of all packages
getPackages: in file PhpdocIndexer.php, method PhpdocIndexer::getPackages()
Returns the package list and resets the internal package field.
getParameter: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::getParameter()
Converts the XML parameter array into formatted string.
getPhpdocParagraphs: in file PhpdocParserCore.php, method PhpdocParserCore::getPhpdocParagraphs()
Scans code for documented and undocumented phpdoc keywords (classes, functions, class variables, uses, constants).
getSubclasses: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::getSubclasses()
Returns an array with all subclasses of a class.
getTagPos: in file PhpdocParserTags.php, method PhpdocParserTags::getTagPos()
Find the position of the next phpdoc tag.
getTags: in file PhpdocParserTags.php, method PhpdocParserTags::getTags()
Extracts PHPDoc tags from a PHPDoc doc comment.
getUses: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getUses()
Returns an array of all included files.
getUsesByType: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getUsesByType()
Returns an array of all included files with a certain type (include, require...) attribute.
getValue: in file PhpdocParserCore.php, method PhpdocParserCore::getValue()
Scans a code passage for a value.
getVariables: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getVariables()
Returns an array with all variables.
getVariablesByAccess: in file PhpdocDocumentAccessor.php, method PhpdocDocumentAccessor::getVariablesByAccess()
Returns an array with all variables with a certain access (public, private) attribute.
getVariableTypeAndValue: in file PhpdocParserCore.php, method PhpdocParserCore::getVariableTypeAndValue()
Analyses a code snipped and returns the type and value of the first variable found.
getWarnings: in file PhpdocWarningAccessor.php, method PhpdocWarningAccessor::getWarnings()
Returns a hash of warnings in of the given XML file.
getWarnings: in file PhpdocWarning.php, method PhpdocWarning::getWarnings()
Returns a list of warnings.
globalsXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::globalsXML()
Adds <global> container to the xml document.

top

h

$haltOnError: in file IT.php, variable IntegratedTemplate::$haltOnError
Call die() on error?
$haltOnWarning: in file ITX.php, variable IntegratedTemplateExtension::$haltOnWarning
Call die() on warning?
halt: in file IT.php, method IntegratedTemplate::halt()
Error Handling function.
handleArgv: in file PhpdocArgvHandler.php, method PhpdocArgvHandler::handleArgv()
Handle the command line values

top

i

$indent: in file PhpdocHTMLClassRenderer.php, variable PhpdocHTMLClassRenderer::$indent
Internal array of " " strings to format HTML output.
$indexer_result: in file Phpdoc.php, variable Phpdoc::$indexer_result
Result from the indexer
$indexrenderer: in file PhpdocHTMLRendererManager.php, variable PhpdocHTMLRendererManager::$indexrenderer
$inherited: in file PhpdocClassAccessor.php, variable PhpdocClassAccessor::$inherited
Array of inherited elements
$inheritedOverridenAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$inheritedOverridenAttributes
Attributes of <inherited> and <overriden> container.
importXML: in file PhpdocXMLReader.php, method PhpdocXMLReader::importXML()
Converts an xml_parse_into_struct value array to an array that's simmilar to phpdocs internal arrays.
inheritClassElements: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::inheritClassElements()
Adds inherited elements to a class.
inheritedOverridenXML: in file PhpdocXMLClassExporter.php, method PhpdocXMLClassExporter::inheritedOverridenXML()
Handles inherited and overriden elements.
init: in file PhpdocModuleAccessor.php, method PhpdocModuleAccessor::init()
init: in file PhpdocWarningAccessor.php, method PhpdocWarningAccessor::init()
init: in file PhpdocAccessor.php, method PhpdocAccessor::init()
Reformats the xml result array from the PhpdocXMLReader.
init: in file IT.php, method IntegratedTemplate::init()
Clears all datafields of the object and rebuild the internal blocklist
init: in file PhpdocIndexAccessor.php, method PhpdocIndexAccessor::init()
Resets the build flags.
init: in file PhpdocClassAccessor.php, method PhpdocClassAccessor::init()
IntegratedTemplate: in file IT.php, class IntegratedTemplate
Integrated Template - IT
IntegratedTemplate: in file IT.php, method IntegratedTemplate::IntegratedTemplate()
Builds some complex regular expressions and optinally sets the file root directory.
IntegratedTemplateExtension: in file ITX.php, method IntegratedTemplateExtension::IntegratedTemplateExtension()
Builds some complex regexps and calls the constructor of the parent class.
IntegratedTemplateExtension: in file ITX.php, class IntegratedTemplateExtension
Integrated Template Extension - ITX
introspection: in file PhpdocObject.php, method PhpdocObject::introspection()
Dumps objects and arrays.
isUndocumented: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::isUndocumented()
Returns true if the requested element is undocumented and false if it's documented.
ITX.php: procedural page ITX.php
IT.php: procedural page IT.php

top

l

$line: in file PhpdocError.php, variable PhpdocError::$line
Line number where the error occured.
$linkAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$linkAttributes
Attributes of the <link> container.
linkXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::linkXML()
Adds <link> container to the xml document.
loadPackagelist: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::loadPackagelist()
Imports the packagelist from the PhpdocIndexAccessor if not done previously.
loadTemplatefile: in file IT.php, method IntegratedTemplate::loadTemplatefile()
Reads a template file from the disk.
loadXMLFile: in file PhpdocAccessor.php, method PhpdocAccessor::loadXMLFile()
Loads the specified xml file.

top

m

$message: in file PhpdocError.php, variable PhpdocError::$message
The error message itself.
$moduleAttributes: in file PhpdocXMLModuleExporter.php, variable PhpdocXMLModuleExporter::$moduleAttributes
Module container attributes
$modulefiles: in file PhpdocParser.php, variable PhpdocParser::$modulefiles
List of all files containing modules.
$modulegroup: in file PhpdocModuleAnalyser.php, variable PhpdocModuleAnalyser::$modulegroup
Module data
$modulegroup: in file PhpdocIndexAccessor.php, variable PhpdocIndexAccessor::$modulegroup
Data of a modulegroup
$modulegroup: in file PhpdocIndexer.php, variable PhpdocIndexer::$modulegroup
Current modulegroup.
$modulegroups: in file PhpdocParser.php, variable PhpdocParser::$modulegroups
List of all module groups.
$moduleGroups: in file PhpdocModuleParser.php, variable PhpdocModuleParser::$moduleGroups
Hash of all module groups
$modulelist: in file PhpdocModuleAnalyser.php, variable PhpdocModuleAnalyser::$modulelist
List of all modules in the modulegroup
$modulerenderer: in file PhpdocHTMLRendererManager.php, variable PhpdocHTMLRendererManager::$modulerenderer
$modules: in file PhpdocParser.php, variable PhpdocParser::$modules
Hash with the data of the current module group.
$moduleTags: in file PhpdocModuleParser.php, variable PhpdocModuleParser::$moduleTags
List of tags allowed within a module doc comment.
$moduleTpl: in file PhpdocHTMLIndexRenderer.php, variable PhpdocHTMLIndexRenderer::$moduleTpl
IntegratedTemplateObject used by renderModulegroup()
mainPageFooter: in file prepend.php, function mainPageFooter()
The main page footer for PHPDoc
mainPageHeader: in file prepend.php, function mainPageHeader()
The main page header for PHPDoc

top

n

$notinherited: in file PhpdocClassAnalyser.php, variable PhpdocClassAnalyser::$notinherited
List of not inherited elements.
$num_doc_warnings: in file PhpdocWarning.php, variable PhpdocWarning::$num_doc_warnings
Counter containing the number of documentation warnings.
nameToUrl: in file PhpdocObject.php, method PhpdocObject::nameToUrl()
Encodes an element name so that it can be used as a file name.

top

o

$openingDelimiter: in file IT.php, variable IntegratedTemplate::$openingDelimiter
First character of a variable placeholder ( _{_VARIABLE} ).
out: in file PhpdocObject.php, method PhpdocObject::out()
Print a string and flush the output buffer
outl: in file PhpdocObject.php, method PhpdocObject::outl()
Print a string, the specified HTML line break sign and flushes the output buffer

top

p

$packageFields: in file PhpdocHTMLIndexRenderer.php, variable PhpdocHTMLIndexRenderer::$packageFields
Some container in the package list.
$packageFields: in file PhpdocIndexAccessor.php, variable PhpdocIndexAccessor::$packageFields
Some container withing the packagelist.
$packages: in file PhpdocIndexer.php, variable PhpdocIndexer::$packages
Array of all packages.
$packages: in file PhpdocIndexAccessor.php, variable PhpdocIndexAccessor::$packages
List of all packages.
$packages: in file PhpdocParser.php, variable PhpdocParser::$packages
Hash of all packages found.
$packages: in file PhpdocHTMLIndexRenderer.php, variable PhpdocHTMLIndexRenderer::$packages
Packagelist from the PhpdocIndexAccessor
$paramAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$paramAttributes
Attributes of the <param> container.
$path: in file PhpdocXMLExporter.php, variable PhpdocXMLExporter::$path
Target directory where the xml documents get saved.
$path: in file PhpdocFileHandler.php, variable PhpdocFileHandler::$path
Filepath. The path is automatically added in front of all filenames
$path: in file PhpdocHTMLRenderer.php, variable PhpdocHTMLRenderer::$path
Directory path prefix.
$PHPDOC_TAGS: in file PhpdocParserRegExp.php, variable PhpdocParserRegExp::$PHPDOC_TAGS
Array of phpdoc tags, indexed by the tagname.
$phpfiles: in file PhpdocParser.php, variable PhpdocParser::$phpfiles
Array of PHP Sourcecode Files to examine.
$PHP_BASE: in file PhpdocParserRegExp.php, variable PhpdocParserRegExp::$PHP_BASE
Basic RegExps used to analyse PHP Code.
$PHP_COMPLEX: in file PhpdocParserRegExp.php, variable PhpdocParserRegExp::$PHP_COMPLEX
List of regular expressions used to grep complex php code elements.
$printError: in file IT.php, variable IntegratedTemplate::$printError
Print error messages?
$printWarning: in file ITX.php, variable IntegratedTemplateExtension::$printWarning
Print warnings?
paramsXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::paramsXML()
Adds <parameter> container to the xml document.
parse: in file IT.php, method IntegratedTemplate::parse()
Parses the given block.
parse: in file PhpdocXMLReader.php, method PhpdocXMLReader::parse()
Parses a given XML file and returns the data as a hash.
parse: in file Phpdoc.php, method Phpdoc::parse()
Starts the parser.
parseCurrentBlock: in file IT.php, method IntegratedTemplate::parseCurrentBlock()
Parses the current block
pathXML: in file PhpdocXMLClassExporter.php, method PhpdocXMLClassExporter::pathXML()
Writes the "path" (inheritance chain) of an element.
Phpdoc: in file Phpdoc.php, method Phpdoc::Phpdoc()
Calls the command line handler if necessary.
Phpdoc: in file Phpdoc.php, class Phpdoc
Coordinates several Phpdoc Object to parse and render source files.
PhpdocAccessor.php: procedural page PhpdocAccessor.php
PhpdocClassAccessor.php: procedural page PhpdocClassAccessor.php
PhpdocDocumentAccessor.php: procedural page PhpdocDocumentAccessor.php
PhpdocIndexAccessor.php: procedural page PhpdocIndexAccessor.php
PhpdocModuleAccessor.php: procedural page PhpdocModuleAccessor.php
PhpdocWarningAccessor.php: procedural page PhpdocWarningAccessor.php
PhpdocAnalyser.php: procedural page PhpdocAnalyser.php
PhpdocClassAnalyser.php: procedural page PhpdocClassAnalyser.php
PhpdocModuleAnalyser.php: procedural page PhpdocModuleAnalyser.php
PhpdocArgvHandler.php: procedural page PhpdocArgvHandler.php
PhpdocObject.php: procedural page PhpdocObject.php
PhpdocSetupHandler.php: procedural page PhpdocSetupHandler.php
Phpdoc.php: procedural page Phpdoc.php
PhpdocError.php: procedural page PhpdocError.php
PhpdocFileHandler.php: procedural page PhpdocFileHandler.php
PhpdocIndexer.php: procedural page PhpdocIndexer.php
PhpdocClassParser.php: procedural page PhpdocClassParser.php
PhpdocConstantParser.php: procedural page PhpdocConstantParser.php
PhpdocFunctionParser.php: procedural page PhpdocFunctionParser.php
PhpdocModuleParser.php: procedural page PhpdocModuleParser.php
PhpdocParserCore.php: procedural page PhpdocParserCore.php
PhpdocParserRegExp.php: procedural page PhpdocParserRegExp.php
PhpdocParserTags.php: procedural page PhpdocParserTags.php
PhpdocParser.php: procedural page PhpdocParser.php
PhpdocUseParser.php: procedural page PhpdocUseParser.php
PhpdocVariableParser.php: procedural page PhpdocVariableParser.php
prepend.php: procedural page prepend.php
PhpdocHTMLClassRenderer.php: procedural page PhpdocHTMLClassRenderer.php
PhpdocHTMLDocumentRenderer.php: procedural page PhpdocHTMLDocumentRenderer.php
PhpdocHTMLIndexRenderer.php: procedural page PhpdocHTMLIndexRenderer.php
PhpdocHTMLModuleRenderer.php: procedural page PhpdocHTMLModuleRenderer.php
PhpdocHTMLRendererManager.php: procedural page PhpdocHTMLRendererManager.php
PhpdocHTMLRenderer.php: procedural page PhpdocHTMLRenderer.php
PhpdocHTMLWarningRenderer.php: procedural page PhpdocHTMLWarningRenderer.php
PhpdocRendererObject.php: procedural page PhpdocRendererObject.php
PhpdocWarning.php: procedural page PhpdocWarning.php
PhpdocXMLClassExporter.php: procedural page PhpdocXMLClassExporter.php
PhpdocXMLDocumentExporter.php: procedural page PhpdocXMLDocumentExporter.php
PhpdocXMLExporter.php: procedural page PhpdocXMLExporter.php
PhpdocXMLIndexExporter.php: procedural page PhpdocXMLIndexExporter.php
PhpdocXMLModuleExporter.php: procedural page PhpdocXMLModuleExporter.php
PhpdocXMLWarningExporter.php: procedural page PhpdocXMLWarningExporter.php
PhpdocXMLReader.php: procedural page PhpdocXMLReader.php
PhpdocXMLWriter.php: procedural page PhpdocXMLWriter.php
PhpdocAccessor: in file PhpdocAccessor.php, class PhpdocAccessor
Provides an API to access PHPDoc XML files.
PhpdocAnalyser: in file PhpdocAnalyser.php, class PhpdocAnalyser
Analyses parsing data.
PhpdocArgvHandler: in file PhpdocArgvHandler.php, class PhpdocArgvHandler
Handles command line arguments.
PhpdocClassAccessor: in file PhpdocClassAccessor.php, class PhpdocClassAccessor
Provides functions to access phpdoc xml documents that contain classes.
PhpdocClassAnalyser: in file PhpdocClassAnalyser.php, class PhpdocClassAnalyser
Analyses a class.
PhpdocClassParser: in file PhpdocClassParser.php, class PhpdocClassParser
Parses phpcode to extract classes and their documentation.
PhpdocConstantParser: in file PhpdocConstantParser.php, class PhpdocConstantParser
Extracts define statements and their documentation from php code.
PhpdocDocumentAccessor: in file PhpdocDocumentAccessor.php, class PhpdocDocumentAccessor
Base of the class and module accessor.
PhpdocError: in file PhpdocError.php, method PhpdocError::PhpdocError()
Sets the error message, filename and linenumber.
PhpdocError: in file PhpdocError.php, class PhpdocError
PHPDoc Error Handling class
PhpdocFileHandler: in file PhpdocFileHandler.php, class PhpdocFileHandler
File handling functions in phpdoc.
PhpdocFunctionParser: in file PhpdocFunctionParser.php, class PhpdocFunctionParser
Looks for documented and undocumented functions within a block of php code.
PhpdocHTMLClassRenderer: in file PhpdocHTMLClassRenderer.php, class PhpdocHTMLClassRenderer
Renders classes.
PhpdocHTMLClassRenderer: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::PhpdocHTMLClassRenderer()
Sets the xml and template root directory.
PhpdocHTMLDocumentRenderer: in file PhpdocHTMLDocumentRenderer.php, class PhpdocHTMLDocumentRenderer
Provides functioninality to render modules and classes.
PhpdocHTMLIndexRenderer: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::PhpdocHTMLIndexRenderer()
Sets the xml and template root directory.
PhpdocHTMLIndexRenderer: in file PhpdocHTMLIndexRenderer.php, class PhpdocHTMLIndexRenderer
Renders Index lists.
PhpdocHTMLModuleRenderer: in file PhpdocHTMLModuleRenderer.php, class PhpdocHTMLModuleRenderer
Renders modules.
PhpdocHTMLModuleRenderer: in file PhpdocHTMLModuleRenderer.php, method PhpdocHTMLModuleRenderer::PhpdocHTMLModuleRenderer()
Sets the xml and template root directory.
PhpdocHTMLRenderer: in file PhpdocHTMLRenderer.php, class PhpdocHTMLRenderer
Default HTML Renderer based on templates.
PhpdocHTMLRendererManager: in file PhpdocHTMLRendererManager.php, method PhpdocHTMLRendererManager::PhpdocHTMLRendererManager()
Creates all necessary renderer objects
PhpdocHTMLRendererManager: in file PhpdocHTMLRendererManager.php, class PhpdocHTMLRendererManager
Controls the HTML Renderer objects.
PhpdocHTMLWarningRenderer: in file PhpdocHTMLWarningRenderer.php, class PhpdocHTMLWarningRenderer
Renders files with warnings.
PhpdocHTMLWarningRenderer: in file PhpdocHTMLWarningRenderer.php, method PhpdocHTMLWarningRenderer::PhpdocHTMLWarningRenderer()
Sets the xml and template root directory.
PhpdocIndexAccessor: in file PhpdocIndexAccessor.php, class PhpdocIndexAccessor
Provides a API to access Index xml documents.
PhpdocIndexer: in file PhpdocIndexer.php, class PhpdocIndexer
Builds Indexlists with the result from the
PhpdocModuleAccessor: in file PhpdocModuleAccessor.php, class PhpdocModuleAccessor
Provides functions to access phpdoc xml documents that contain modules.
PhpdocModuleAnalyser: in file PhpdocModuleAnalyser.php, class PhpdocModuleAnalyser
Analyses a modulegroup.
PhpdocModuleParser: in file PhpdocModuleParser.php, class PhpdocModuleParser
Extracts modules and their documentation from php code.
PhpdocObject: in file PhpdocObject.php, class PhpdocObject
Common base class of all phpdoc classes
PhpdocParser: in file PhpdocParser.php, method PhpdocParser::PhpdocParser()
Creates an instance of PhpdocWarning and calls buildComplexRegExps() to initialize the object.
PhpdocParser: in file PhpdocParser.php, class PhpdocParser
"Main" class of the Parser collection.
PhpdocParserCore: in file PhpdocParserCore.php, class PhpdocParserCore
Provides basic parser functions.
PhpdocParserRegExp: in file PhpdocParserRegExp.php, class PhpdocParserRegExp
Defines all regular expressions.
PhpdocParserTags: in file PhpdocParserTags.php, class PhpdocParserTags
Functions used to parse PHPDoc Tags.
PhpdocRendererObject: in file PhpdocRendererObject.php, class PhpdocRendererObject
Superclass of all Renderer.
PhpdocSetupHandler: in file PhpdocSetupHandler.php, class PhpdocSetupHandler
Handles the "setup".
PhpdocUseParser: in file PhpdocUseParser.php, class PhpdocUseParser
Extracts use statements (include and friends) an thheir documentation from php code.
PhpdocVariableParser: in file PhpdocVariableParser.php, class PhpdocVariableParser
Extract class variables and their documentation from phpcode
PhpdocWarning: in file PhpdocWarning.php, class PhpdocWarning
Container for all kind of Warnings the parser/analyser recognizes
PhpdocWarningAccessor: in file PhpdocWarningAccessor.php, class PhpdocWarningAccessor
Extracts the warnings from PHPDoc warnings_* files.
PhpdocXMLClassExporter: in file PhpdocXMLClassExporter.php, method PhpdocXMLClassExporter::PhpdocXMLClassExporter()
PhpdocXMLClassExporter: in file PhpdocXMLClassExporter.php, class PhpdocXMLClassExporter
Exports the data of a class as an xml file.
PhpdocXMLDocumentExporter: in file PhpdocXMLDocumentExporter.php, class PhpdocXMLDocumentExporter
Base of the class and module exporter.
PhpdocXMLExporter: in file PhpdocXMLExporter.php, method PhpdocXMLExporter::PhpdocXMLExporter()
Creates a PhpdocXMLWriter object.
PhpdocXMLExporter: in file PhpdocXMLExporter.php, class PhpdocXMLExporter
Exporter used to export phpdoc internals data structures as xml documents.
PhpdocXMLIndexExporter: in file PhpdocXMLIndexExporter.php, class PhpdocXMLIndexExporter
Creates XML index files.
PhpdocXMLIndexExporter: in file PhpdocXMLIndexExporter.php, method PhpdocXMLIndexExporter::PhpdocXMLIndexExporter()
Just call the parent class constructor
PhpdocXMLModuleExporter: in file PhpdocXMLModuleExporter.php, method PhpdocXMLModuleExporter::PhpdocXMLModuleExporter()
PhpdocXMLModuleExporter: in file PhpdocXMLModuleExporter.php, class PhpdocXMLModuleExporter
Exports the data of a module as an xml document
PhpdocXMLReader: in file PhpdocXMLReader.php, class PhpdocXMLReader
Reads XML documents into a multi dimensional Array.
PhpdocXMLWarningExporter: in file PhpdocXMLWarningExporter.php, method PhpdocXMLWarningExporter::PhpdocXMLWarningExporter()
PhpdocXMLWarningExporter: in file PhpdocXMLWarningExporter.php, class PhpdocXMLWarningExporter
Exports a list of documentation warnings found by phpdoc
PhpdocXMLWriter: in file PhpdocXMLWriter.php, class PhpdocXMLWriter
Creates XML documents.
PhpdocXMLWriter: in file PhpdocXMLWriter.php, method PhpdocXMLWriter::PhpdocXMLWriter()
Creates a new PhpdocFileHandler
PHPDOC_GENERATED_DATE: in file prepend.php, constant PHPDOC_GENERATED_DATE
PHPDOC_LINEBREAK: in file prepend.php, constant PHPDOC_LINEBREAK
PHPDOC_LINK: in file prepend.php, constant PHPDOC_LINK
PHPDOC_SEPARATE_DESCRIPTIONS: in file prepend.php, constant PHPDOC_SEPARATE_DESCRIPTIONS
PHPDOC_VERSION: in file prepend.php, constant PHPDOC_VERSION
preparse: in file PhpdocParser.php, method PhpdocParser::preparse()
Central parsing function.
printMessage: in file PhpdocError.php, method PhpdocError::printMessage()
Prints the error message.

top

r

$removeEmptyBlocks: in file IT.php, variable IntegratedTemplate::$removeEmptyBlocks
Controls the handling of empty blocks, default is remove.
$removeUnknownVariables: in file IT.php, variable IntegratedTemplate::$removeUnknownVariables
Controls the handling of unknown variables, default is remove.
$result: in file PhpdocXMLExporter.php, variable PhpdocXMLExporter::$result
Data to save as a xml document.
$returnAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$returnAttributes
Attributes of the <return> container.
render: in file Phpdoc.php, method Phpdoc::render()
Renders the PHPDoc XML files as HTML files
render: in file PhpdocHTMLRendererManager.php, method PhpdocHTMLRendererManager::render()
Renders the given xml file.
renderAuthors: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderAuthors()
Renders an author list.
renderClass: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::renderClass()
Renders a class.
renderCommonDocfields: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderCommonDocfields()
Adds some tags to the template that are allowed nearly everywhere.
renderConstantDetail: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderConstantDetail()
Adds a detailed list of all constants to the template.
renderConstants: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderConstants()
Adds a summary and a detailed list of all constants to the template.
renderConstantSummary: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderConstantSummary()
Adds a summary of all constants to the template.
renderElementlist: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::renderElementlist()
Renders the element index list.
renderFrameElementlist: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::renderFrameElementlist()
Renders files for the lower left frame with the elements of a certain file.
renderFramePackagesummary: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::renderFramePackagesummary()
Renders a Packagesummary for the frameset.
renderFunctionDetail: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderFunctionDetail()
Adds a detailed list of functions to the template.
renderFunctions: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderFunctions()
Adds a summary and a detailed list of all functions to the template.
renderFunctionSummary: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderFunctionSummary()
Adds a function summary to the template.
renderGlobals: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderGlobals()
Renders a list of global elements.
renderInherited: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::renderInherited()
Renders a list of inherited elements.
renderInheritedElements: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::renderInheritedElements()
Renders a list of a certain inherited element.
renderLinks: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderLinks()
Renders a list of external links.
renderModule: in file PhpdocHTMLModuleRenderer.php, method PhpdocHTMLModuleRenderer::renderModule()
Renders a module
renderPackagelist: in file PhpdocHTMLIndexRenderer.php, method PhpdocHTMLIndexRenderer::renderPackagelist()
Renders a complete packagelist.
renderParameterDetail: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderParameterDetail()
Renders a detailed list of function parameters.
renderSee: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderSee()
Renders a block with references to other source elements.
renderSubclasses: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::renderSubclasses()
Renders a list of direct known subclasses.
renderThrows: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderThrows()
Renders a list of exceptions.
renderUses: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderUses()
Adds a summary and a detailed list of included files to the template.
renderUsesDetail: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderUsesDetail()
Adds a detailed list of all included files to the template.
renderUsesSummary: in file PhpdocHTMLDocumentRenderer.php, method PhpdocHTMLDocumentRenderer::renderUsesSummary()
Adds a summary of all included files to the template.
renderVariableDetail: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::renderVariableDetail()
Adds a detailed list of all variables to the template.
renderVariables: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::renderVariables()
Adds a summary and a detailed list of all variables to the template.
renderVariableSummary: in file PhpdocHTMLClassRenderer.php, method PhpdocHTMLClassRenderer::renderVariableSummary()
Adds a summary of all variables to the template.
replaceBlock: in file ITX.php, method IntegratedTemplateExtension::replaceBlock()
Replaces an existing block with new content. Warning: not implemented yet.
replaceBlockfile: in file ITX.php, method IntegratedTemplateExtension::replaceBlockfile()
Replaces an existing block with new content from a file. Warning: not implemented yet.
returnXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::returnXML()
Adds <return> container to the xml document.

top

s

$seeAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$seeAttributes
Attributes of the <see> container.
$simpleDocfields: in file PhpdocHTMLDocumentRenderer.php, variable PhpdocHTMLDocumentRenderer::$simpleDocfields
Array of doc container fields that get mapped directly to templateblocks.
$sourceDirectory: in file PhpdocSetupHandler.php, variable PhpdocSetupHandler::$sourceDirectory
Directory with the php sources to parse.
$sourceFileSuffix: in file PhpdocSetupHandler.php, variable PhpdocSetupHandler::$sourceFileSuffix
Suffix of all source code files in the application
$structvalues: in file PhpdocXMLReader.php, variable PhpdocXMLReader::$structvalues
Values array from xml_parse_into_struct().
seeXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::seeXML()
Adds <see> container to the xml document.
setApplication: in file PhpdocSetupHandler.php, method PhpdocSetupHandler::setApplication()
Sets the name of your application.
setClasses: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::setClasses()
Sets the class data and the name of the baseclass.
setCurrentBlock: in file IT.php, method IntegratedTemplate::setCurrentBlock()
Sets the name of the current block that is the block where variables are added.
setFilePath: in file PhpdocFileHandler.php, method PhpdocFileHandler::setFilePath()
Sets the filepath. The path is automatically added in front of all filenames
setFlagOutput: in file PhpdocObject.php, method PhpdocObject::setFlagOutput()
Sets the output flag - if set to true out() and outl() print messages
setModulegroup: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::setModulegroup()
Sets the data of the modulegroup to analyse.
setPath: in file PhpdocHTMLRenderer.php, method PhpdocHTMLRenderer::setPath()
Sets a directory path prefix.
setPath: in file PhpdocXMLExporter.php, method PhpdocXMLExporter::setPath()
Sets the target path for the generated xml documents.
setPhpSourcecodeFiles: in file PhpdocParser.php, method PhpdocParser::setPhpSourcecodeFiles()
Sets the list of PHP Soucecode Files to examine.
setResult: in file PhpdocXMLExporter.php, method PhpdocXMLExporter::setResult()
setRoot: in file IT.php, method IntegratedTemplate::setRoot()
Sets the file root. The file root gets prefixed to all filenames passed to the object.
setSourceDirectory: in file PhpdocSetupHandler.php, method PhpdocSetupHandler::setSourceDirectory()
Sets the name of the directory with the source to scan.
setSourceFileSuffix: in file PhpdocSetupHandler.php, method PhpdocSetupHandler::setSourceFileSuffix()
Suffix of all source code files in the application
setTarget: in file PhpdocSetupHandler.php, method PhpdocSetupHandler::setTarget()
Sets the target where the generated files are saved.
setTargetFileSuffix: in file PhpdocSetupHandler.php, method PhpdocSetupHandler::setTargetFileSuffix()
Suffix for all rendered files in the application (not for the xml files)
setTemplate: in file IT.php, method IntegratedTemplate::setTemplate()
Sets the template.
setTemplateDirectory: in file PhpdocSetupHandler.php, method PhpdocSetupHandler::setTemplateDirectory()
Sets the name of the directory with the templates.
setTemplateRoot: in file PhpdocHTMLRenderer.php, method PhpdocHTMLRenderer::setTemplateRoot()
Sets the template directory.
setVariable: in file IT.php, method IntegratedTemplate::setVariable()
Sets a variable value.
show: in file IT.php, method IntegratedTemplate::show()
Print a certain block with all replacements done.
startElement: in file PhpdocXMLWriter.php, method PhpdocXMLWriter::startElement()
Adds an open (or single) xml tag to the generated xml.
stripCloseFromStructvalues: in file PhpdocXMLReader.php, method PhpdocXMLReader::stripCloseFromStructvalues()
Strips all values out of the xml_parse_intro_struct() values array with the type "open".
subclassesXML: in file PhpdocXMLClassExporter.php, method PhpdocXMLClassExporter::subclassesXML()
Adds a list of subclasses to the generated xml.

top

t

$TAGS: in file PhpdocParserRegExp.php, variable PhpdocParserRegExp::$TAGS
Array of RegExp matching the syntax of several complex tags.
$targetFileSuffix: in file PhpdocSetupHandler.php, variable PhpdocSetupHandler::$targetFileSuffix
Suffix for all rendered files in the application (except for the xml files).
$template: in file IT.php, variable IntegratedTemplate::$template
Content of the template.
$templateRoot: in file PhpdocHTMLRenderer.php, variable PhpdocHTMLRenderer::$templateRoot
Rootpath for Templatefiles.
$tpl: in file PhpdocHTMLRenderer.php, variable PhpdocHTMLRenderer::$tpl
Template object
$treeTpl: in file PhpdocHTMLIndexRenderer.php, variable PhpdocHTMLIndexRenderer::$treeTpl
IntegratedTemplate Object used be renderClasstree()
templates.php: procedural page templates.php
throwsXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::throwsXML()
Adds <throws> container to the xml document.

top

u

$undocumented: in file PhpdocHTMLDocumentRenderer.php, variable PhpdocHTMLDocumentRenderer::$undocumented
Message displayed if an object lacks documentation.
$undocumentedFields: in file PhpdocModuleAnalyser.php, variable PhpdocModuleAnalyser::$undocumentedFields
Puuuh - findUndocumented() needs this.
$undocumentedFields: in file PhpdocClassAnalyser.php, variable PhpdocClassAnalyser::$undocumentedFields
Puuuh - findUndocumented() needs this.
$uses: in file PhpdocHTMLDocumentRenderer.php, variable PhpdocHTMLDocumentRenderer::$uses
Array of included files.
$usesAttributes: in file PhpdocXMLDocumentExporter.php, variable PhpdocXMLDocumentExporter::$usesAttributes
Attribues of the <uses> container.
$usesTypes: in file PhpdocHTMLDocumentRenderer.php, variable PhpdocHTMLDocumentRenderer::$usesTypes
Types of include statements.
$useTags: in file PhpdocUseParser.php, variable PhpdocUseParser::$useTags
List of allowed tags in use doc comments.
updateAccessElements: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::updateAccessElements()
updateAccessElements: in file PhpdocAnalyser.php, method PhpdocAnalyser::updateAccessElements()
Updates access tags.
updateAccessElements: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::updateAccessElements()
Updates access tags.
updateAccessReturn: in file PhpdocAnalyser.php, method PhpdocAnalyser::updateAccessReturn()
Updates the access and return tag values.
updateAccessReturn: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::updateAccessReturn()
updateAccessReturn: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::updateAccessReturn()
updateAccessReturnElements: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::updateAccessReturnElements()
updateAccessReturnElements: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::updateAccessReturnElements()
Updates access and return for certain elements.
updateAccessReturnElements: in file PhpdocAnalyser.php, method PhpdocAnalyser::updateAccessReturnElements()
Updates access and return for certain elements.
updateBlockvariablelist: in file ITX.php, method IntegratedTemplateExtension::updateBlockvariablelist()
Updates the variable list of a block.
updateBrotherSisterElements: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::updateBrotherSisterElements()
updateBrotherSisterElements: in file PhpdocAnalyser.php, method PhpdocAnalyser::updateBrotherSisterElements()
Updates certain elements that use brother and sister.
updateBrotherSisterElements: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::updateBrotherSisterElements()
updateBrothersSisters: in file PhpdocClassAnalyser.php, method PhpdocClassAnalyser::updateBrothersSisters()
updateBrothersSisters: in file PhpdocModuleAnalyser.php, method PhpdocModuleAnalyser::updateBrothersSisters()
updateBrothersSisters: in file PhpdocAnalyser.php, method PhpdocAnalyser::updateBrothersSisters()
Handles brother and sister.
usesXML: in file PhpdocXMLDocumentExporter.php, method PhpdocXMLDocumentExporter::usesXML()
Adds a list of used files (include, require...) to the xml document.

top

v

$variableAttributes: in file PhpdocXMLClassExporter.php, variable PhpdocXMLClassExporter::$variableAttributes
Variable container attributes.
$variableCache: in file IT.php, variable IntegratedTemplate::$variableCache
Variable cache.
$variablenameRegExp: in file IT.php, variable IntegratedTemplate::$variablenameRegExp
RegExp matching a variable placeholder in the template.
$variables: in file PhpdocHTMLClassRenderer.php, variable PhpdocHTMLClassRenderer::$variables
Array of variables found in the xml document.
$variablesRegExp: in file IT.php, variable IntegratedTemplate::$variablesRegExp
Full RegExp used to find variable placeholder, filled by the constructor.
$variableTags: in file PhpdocVariableParser.php, variable PhpdocVariableParser::$variableTags
Array of tags that are allowed in front of the var keyword
variablesXML: in file PhpdocXMLClassExporter.php, method PhpdocXMLClassExporter::variablesXML()
Adds class variables to the XMl document.

top

w

$warn: in file PhpdocRendererObject.php, variable PhpdocRendererObject::$warn
$warn: in file PhpdocXMLWriter.php, variable PhpdocXMLWriter::$warn
PHPDoc Warning object
$warn: in file ITX.php, variable IntegratedTemplateExtension::$warn
Array with all warnings.
$warn: in file PhpdocObject.php, variable PhpdocObject::$warn
Use to save warnings.
$warningAttributes: in file PhpdocXMLWarningExporter.php, variable PhpdocXMLWarningExporter::$warningAttributes
Attributes of a warning container.
$warningrenderer: in file PhpdocHTMLRendererManager.php, variable PhpdocHTMLRendererManager::$warningrenderer
$warnings: in file PhpdocWarningAccessor.php, variable PhpdocWarningAccessor::$warnings
Array of warnings.
warning: in file ITX.php, method IntegratedTemplateExtension::warning()
Handles warnings, saves them to $warn and prints them or calls die() depending on the flags

top

x

$xml: in file PhpdocAccessor.php, variable PhpdocAccessor::$xml
Result of the PhpdocXMLReader
$xml: in file PhpdocXMLWriter.php, variable PhpdocXMLWriter::$xml
Generated XML document.
$xmlkey: in file PhpdocDocumentAccessor.php, variable PhpdocDocumentAccessor::$xmlkey
Kind of top-level container in the xml document.
$xmlkey: in file PhpdocModuleAccessor.php, variable PhpdocModuleAccessor::$xmlkey
$xmlkey: in file PhpdocClassAccessor.php, variable PhpdocClassAccessor::$xmlkey
TODO: add documentation
$xmlreader: in file PhpdocAccessor.php, variable PhpdocAccessor::$xmlreader
Instance of PhpdocXMLReader
$xmlwriter: in file PhpdocXMLExporter.php, variable PhpdocXMLExporter::$xmlwriter
Instance of PhpdocXMLWriter used to generate the xml document.
xmldecode: in file PhpdocXMLReader.php, method PhpdocXMLReader::xmldecode()
Replaces some basic entities with their character counterparts.
xmlencode: in file PhpdocXMLWriter.php, method PhpdocXMLWriter::xmlencode()
Encodes XML values.

top