Packageindex Classtrees Modulegroups Elementlist Report XML Files
a b c C d e f g h i I l m n o P p r s t T u v w x
a
addInheritedElements	Function in class PhpdocClassAnalyser Adds inherited functions, variables, constants or included files to a class.
analyse	Function in class PhpdocClassAnalyser Starts the analysing of the raw parsing data.
analyse	Function in class PhpdocModuleAnalyser Starts the analysing of the raw parsing data.
analyse	Function in class PhpdocAnalyser Starts the analysing of the raw parsing data.
addNumberSuffix	Function in class PhpdocAnalyser Adds a suffix to the number like 1st, 2nd and 3th
$application	Variable in Class PhpdocSetupHandler Name of the application parsed
$application	Variable in Class PhpdocObject Default applicationname for the generated HTML files.
appendToFile	Function in class PhpdocFileHandler Appends a string to a file.
addClass	Function in class PhpdocIndexer Adds a class to the index lists (elements, packages, classtree).
addClass	Function in class PhpdocParser Analyses the given file and adds the result to the class list.
addModule	Function in class PhpdocIndexer Adds a module to the index lists (elements, packages, classtree).
addModule	Function in class PhpdocParser Analyses the given file and adds the result to the module list.
addElements	Function in class PhpdocIndexer Adds an element to the elementlist.
addSubclasses	Function in class PhpdocParser Adds recursively subclasses to the specified class.
analyseClass	Function in class PhpdocClassParser Analyse a class
analyseClassDoc	Function in class PhpdocClassParser Analyses a class doc comment.
analyseFunction	Function in class PhpdocFunctionParser Analyses a function doc comment.
analyseVariable	Function in class PhpdocVariableParser Analyses a variable doc comment
analyseModule	Function in class PhpdocModuleParser Central module parsing function.
analyseModuleDoc	Function in class PhpdocModuleParser Extracts the allowed documentation tags out of a module doc comment.
analyseConstant	Function in class PhpdocConstantParser Scans the given constant doc comment.
analyseUse	Function in class PhpdocUseParser Takes the result from getPhpdocParagraphs() and interprets it.
analyseTags	Function in class PhpdocParserTags Extract the value from the given tags and copy the data to the $data array if its an allowed tag
analyseSeeTagRegs	Function in class PhpdocParserTags Helperfunction to analyse see tags
$accessModifiers	Variable in Class PhpdocHTMLDocumentRenderer Array of access modifiers.
addClasstree	Function in class PhpdocHTMLIndexRenderer Adds a classtree to the classtree summary template.
addModulegroup	Function in class PhpdocHTMLIndexRenderer Renders a modulegroup xml file.
addWarnings	Function in class PhpdocHTMLWarningRenderer Adds file with warnings to the warning list.
$accessor	Variable in Class PhpdocHTMLRenderer XML data accessor object.
$accessor	Variable in Class PhpdocRendererObject
addDocWarning	Function in class PhpdocWarning Adds a warning to the list of class documentation failures.
authorXML	Function in class PhpdocXMLDocumentExporter Adds container to the xml document.
$authorAttributes	Variable in Class PhpdocXMLDocumentExporter Attributes of the container.
addToArray	Function in class PhpdocXMLReader Appends some values to an array
addXML	Function in class PhpdocXMLWriter Adds xml to the generated xml.
addElement	Function in class PhpdocXMLWriter Adds a complete xml container to the generated xml document.
addBlock	Function in class IntegratedTemplateExtension Adds a block to the template changing a variable placeholder to a block placeholder.
addBlockfile	Function in class IntegratedTemplateExtension Adds a block taken from a file to the template changing a variable placeholder to a block placeholder.
b
buildInheritedlist	Function in class PhpdocClassAccessor Builds a list of inherited elements.
buildSubclasslist	Function in class PhpdocClassAccessor Builds a list of subclasses
buildUseslist	Function in class PhpdocDocumentAccessor Adds a list of included files to the internal data array.
buildPackagelist	Function in class PhpdocIndexAccessor Builds the internal packagelist.
buildChapterlist	Function in class PhpdocIndexAccessor Builds the internal chapterlists.
buildModulegroup	Function in class PhpdocIndexAccessor Extracts the modulegroup data of the xml file.
buildClasstree	Function in class PhpdocIndexAccessor Extracts the classtree data of the xml file.
buildWarnings	Function in class PhpdocWarningAccessor Build the internal list of warnings.
buildBottomUpClasslist	Function in class PhpdocClassAnalyser Builds an internal list of all classes.
buildElementlist	Function in class PhpdocClassAnalyser Builds an array with all elements of a class and saves it to $this->elementlist.
buildElementlist	Function in class PhpdocModuleAnalyser Builds an array with all elements of a class and saves it to $this->elementlist.
buildElementlist	Function in class PhpdocAnalyser Build a list of all elemente (functions, variables,...) of a certain class/module
$baseclass	Variable in Class PhpdocClassAnalyser Name of the baseclass of the given classes.
buildModulelist	Function in class PhpdocModuleAnalyser Builds an internal list of all modules in the modulegroup.
$basedir	Variable in Class PhpdocSetupHandler Basedir for all file operations
$baseclasses	Variable in Class PhpdocParser List of all parentclasses found.
buildComplexRegExps	Function in class PhpdocParserRegExp Builds complex regular expressions for the parser.
buildClasstreeHTML	Function in class PhpdocHTMLIndexRenderer Recursivly builds an HTML class tree using .
baseclassXML	Function in class PhpdocXMLClassExporter Adds a baseclass container to the generated xml.
buildBlockvariablelist	Function in class IntegratedTemplate Build a list of all variables within a block
$blocknameRegExp	Variable in Class IntegratedTemplate RegExp matching a block in the template.
$blockRegExp	Variable in Class IntegratedTemplate Full RegExp used to find blocks an their content, filled by the constructor.
$blocklist	Variable in Class IntegratedTemplate Array of all blocks and their content.
$blockdata	Variable in Class IntegratedTemplate Array with the parsed content of a block.
$blockvariables	Variable in Class IntegratedTemplate Array of variables in a block.
$blockinner	Variable in Class IntegratedTemplate Array of inner blocks of a block.
$blocktypes	Variable in Class IntegratedTemplate Future versions will use this...
c
convertPath	Function in class PhpdocClassAccessor Converts a xml path array to a path that can be passed to the user.
$chapternames	Variable in Class PhpdocIndexAccessor Ordered list of all chapternames.
$chapters	Variable in Class PhpdocIndexAccessor Ordered list of all chapters.
$classtree	Variable in Class PhpdocIndexAccessor Data of a classtree
$classtree	Variable in Class PhpdocIndexer Current classtree.
$classtree	Variable in Class PhpdocParser Hash of all class trees.
$classtree	Variable in Class PhpdocHTMLIndexRenderer Array with classtree informations
checkFunctionArgs	Function in class PhpdocClassAnalyser Checks the function documentation of a certain class.
checkFunctionArgs	Function in class PhpdocModuleAnalyser Compares the param tags with the function head found.
checkFunctionArgs	Function in class PhpdocAnalyser Compares the param tags with the function head found.
checkSeeElements	Function in class PhpdocClassAnalyser Checks see references in the given element array (functions, variables...)
checkSeeElements	Function in class PhpdocModuleAnalyser Checks see references in the given element array (functions, variables...)
checkSee	Function in class PhpdocClassAnalyser Checks all see references in the given classes/modulegroup.
checkSee	Function in class PhpdocModuleAnalyser Checks all see references in the given classes/modulegroup.
checkSee	Function in class PhpdocAnalyser Checks all see references in the given classes/modulegroup.
$classes	Variable in Class PhpdocClassAnalyser Class data.
$classes	Variable in Class PhpdocParser Hash with the data of the current class tree (one parentclass with all children).
$classes	Variable in Class PhpdocClassParser Array of all classes in the given code
$classlist	Variable in Class PhpdocClassAnalyser Ordered list of all classes.
copyBrotherSisterFields	Function in class PhpdocAnalyser Copies fields from a brother or sister to the current element.
checkSeeElement	Function in class PhpdocAnalyser Checks see references in the given elementlist.
checkArgDocs	Function in class PhpdocAnalyser Compares the argument list generated from the function head with the param tags found.
checkStatus	Function in class PhpdocSetupHandler Checks the current status of the object. Are all necessary informations to start parsing available?
createFile	Function in class PhpdocFileHandler Creates a new file.
$currentFile	Variable in Class PhpdocParser Name of the file currently parsed.
$classnamesToFilenames	Variable in Class PhpdocParser Mapping from classnames to filenames
$classfiles	Variable in Class PhpdocParser List of all files containing classes.
$current_baseclass	Variable in Class PhpdocParser Name of the base class of the current class tree.
$classTags	Variable in Class PhpdocClassParser Array of tags that are allowed in front of the class keyword
checkVarDocs	Function in class PhpdocVariableParser Compares the var tag informations with the analyse of the source code.
checkConstantDoc	Function in class PhpdocConstantParser Compares the data from the parser with the optional const[ant] tags
$constantTags	Variable in Class PhpdocConstantParser Doc Tags allowed with const[ant].
checkParserErrors	Function in class PhpdocParserTags Takes an array filled by analyseTags() and converts the parse errors into a single error message.
$constants	Variable in Class PhpdocHTMLDocumentRenderer Array of constants.
$classrenderer	Variable in Class PhpdocHTMLRendererManager
create	Function in class PhpdocXMLClassExporter
create	Function in class PhpdocXMLModuleExporter
create	Function in class PhpdocXMLWarningExporter
$classAttributes	Variable in Class PhpdocXMLClassExporter Class container attributes.
constsXML	Function in class PhpdocXMLDocumentExporter Adds all constants (define(), const) to the xml document.
$constAttributes	Variable in Class PhpdocXMLDocumentExporter Attributes of the container.
$chapterAttributes	Variable in Class PhpdocXMLIndexExporter Chapter tag attributes
createFilehandler	Function in class PhpdocXMLReader Creates a PhpdocFileHandler object and saves it to $filehandler if it does not already exist.
$classname	Variable in Class PhpdocError Name of the error object class used to construct the error message
$checkblocknameRegExp	Variable in Class IntegratedTemplateExtension RegExp used to test for a valid blockname.
$clearCache	Variable in Class IntegratedTemplate Clear cache on get()?
$closingDelimiter	Variable in Class IntegratedTemplate Last character of a variable placeholder ( _ ).
$currentBlock	Variable in Class IntegratedTemplate Name of the current block.
$clearCacheOnParse	Variable in Class IntegratedTemplate
C
$COMMANDS	Variable in Class PhpdocArgvHandler Message explaining the usage of phpdoc on the command line.
$C_BASE	Variable in Class PhpdocParserRegExp Basis regular expressions used to compose complex expressions to grep doc comments.
$C_COMPLEX	Variable in Class PhpdocParserRegExp List of regular expressions used to grep complex doc comments.
d
$data	Variable in Class PhpdocAccessor Reformatted PhpdocXMLReader result array
$doc_warnings	Variable in Class PhpdocWarning Hash of documentation failures.
docXML	Function in class PhpdocXMLDocumentExporter Adds a documentation block (author, links, see, params...) to the xml document
$docTags	Variable in Class PhpdocXMLDocumentExporter Mapping from internal result array index name to xml tag name.
deleteFromBlockvariablelist	Function in class IntegratedTemplateExtension Deletes one or many variables from the block variable list.
e
$elementlist	Variable in Class PhpdocAnalyser List of all elements of a certain class/module.
$elements	Variable in Class PhpdocIndexer Array of all elements (functions, variables, constant, included files, classes, packages).
$elementFields	Variable in Class PhpdocIndexer Array of fields that get added to the elementlist
$emptyClass	Variable in Class PhpdocClassParser Default values of a class
$emptyFunction	Variable in Class PhpdocFunctionParser Internal structur of a function.
$emptyVariable	Variable in Class PhpdocVariableParser Array with default values of a variable
$emptyModule	Variable in Class PhpdocModuleParser Empty hash that shows the structure of a module.
$emptyConstant	Variable in Class PhpdocConstantParser Internal structure use to save a constant.
$emptyUse	Variable in Class PhpdocUseParser Structure of an empty use entry.
extractPhpdoc	Function in class PhpdocParserCore Strips "/xx", "x/" and x from doc comments (x means asterix).
encode	Function in class PhpdocHTMLRenderer Encodes the given string.
exportModulegroup	Function in class PhpdocXMLIndexExporter Exports a modulegroup.
exportPackagelist	Function in class PhpdocXMLIndexExporter Exports a packagelist
exportClasstree	Function in class PhpdocXMLIndexExporter Exports a classtree
exportElementlist	Function in class PhpdocXMLIndexExporter Exports a list of all elements
$elementAttributes	Variable in Class PhpdocXMLIndexExporter Element tag attributes.
export	Function in class PhpdocXMLExporter Exports the given result array as xml document.
export	Function in class PhpdocXMLWriter Saves the xml to the specified file.
endElement	Function in class PhpdocXMLWriter Adds a closing xml tag to the generated xml document.
$err	Variable in Class PhpdocObject Variable containing the latest exceptions.
$err	Variable in Class IntegratedTemplate Contains the error objects
$error_message_prefix	Variable in Class PhpdocError Error message prefix.
$error_prepend	Variable in Class PhpdocError Error prepend, used for HTML formatting.
$error_append	Variable in Class PhpdocError Error append, used for HTML formatting.
$errorHandling	Variable in Class PhpdocError Array that describes how an error gets handled.
f
$flagBuild	Variable in Class PhpdocIndexAccessor Flag indicating that certain internal datafield have been filled.
$freeOnGet	Variable in Class PhpdocWarningAccessor If set to true all get_xy() functions will free their resources.
$freeOnGet	Variable in Class PhpdocAccessor Free xml resources on calling a getXY() function?
$flag_build	Variable in Class PhpdocWarningAccessor Flag used to detect if get_xy() was called.s
findUndocumented	Function in class PhpdocClassAnalyser Looks for undocumented elements in a certain class
findUndocumented	Function in class PhpdocModuleAnalyser Looks for undocumented elements and adds a warning if neccessary.
findUndocumented	Function in class PhpdocAnalyser Looks for undocumented elements and adds a warning if neccessary.
$flag_get	Variable in Class PhpdocAnalyser Flag indicating that getModule/getClass was called.
$flag_output	Variable in Class Phpdoc Print status messages
$flag_output	Variable in Class PhpdocObject Flag determining wheter to print some status messages or not (default: false)
findModulegroups	Function in class PhpdocParser Builds the hash of module groups and the module file list.
findClassTrees	Function in class PhpdocParser Builds a hash of all class trees.
$flag_classtree	Variable in Class PhpdocParser Flag indicating that getClassTree() was called.
$flag_modulegroup	Variable in Class PhpdocParser Flag indicating that getModulegroup was called.
$functionTags	Variable in Class PhpdocFunctionParser Array of tags that are allowed in front of the function keyword
$functions	Variable in Class PhpdocHTMLDocumentRenderer Array of functions found in the xml document.
finishClasstree	Function in class PhpdocHTMLIndexRenderer Saves the generated classtree summary to disk.
finishModulegroup	Function in class PhpdocHTMLIndexRenderer
finishWarnings	Function in class PhpdocHTMLWarningRenderer Saves the generated report.
$file_extension	Variable in Class PhpdocRendererObject Extension for generated files.
finish	Function in class PhpdocHTMLRendererManager Finishes the rendering process.
$fileprefix	Variable in Class PhpdocXMLClassExporter Filename prefix for the generated xml document.
$fileprefix	Variable in Class PhpdocXMLModuleExporter Filename prefix for the generated xml document.
$fileprefix	Variable in Class PhpdocXMLWarningExporter Filename prefix for the generated xml document.
$fileprefix	Variable in Class PhpdocXMLExporter Filename prefix for the generated xml document.
filenameXML	Function in class PhpdocXMLDocumentExporter Writes a container.
functionsXML	Function in class PhpdocXMLDocumentExporter Adds a list of functions to the xml file.
$functionAttributes	Variable in Class PhpdocXMLDocumentExporter Attribues of the container.
$filehandler	Variable in Class PhpdocXMLReader PHPDocFileHandler object.
free	Function in class PhpdocXMLWriter Clears the internal xml data buffer so that a new document can be passed to the object.
free	Function in class IntegratedTemplate Clears all datafields of the object.
$fileHandler	Variable in Class PhpdocXMLWriter Filehandler used for IO operations
$file	Variable in Class PhpdocError File where the error occured.
findPlaceholderBlocks	Function in class IntegratedTemplateExtension Returns an array of blocknames where the given variable placeholder is used.
findBlocks	Function in class IntegratedTemplate Recusively builds a list of all blocks within the template.
$fileRoot	Variable in Class IntegratedTemplate Root directory for all file operations.
$flagBlocktrouble	Variable in Class IntegratedTemplate Internal flag indicating that a blockname was used multiple times.
$flagGlobalParsed	Variable in Class IntegratedTemplate Flag indicating that the global block was parsed.
g
getClassdata	Function in class PhpdocClassAccessor Returns an array with the data of a class (no functions etc, just the class docs).
getInheritedFunctions	Function in class PhpdocClassAccessor Returns an array of inherited functions.
getInheritedVariables	Function in class PhpdocClassAccessor Returns an array of inherited variables.
getInheritedUses	Function in class PhpdocClassAccessor Returns an array of inherited included files.
getInheritedConstants	Function in class PhpdocClassAccessor Returns an array of inherited constants.
getClasstree	Function in class PhpdocClassAccessor Returns an array with the "path" of a class.
getClasstree	Function in class PhpdocIndexAccessor Returns a classtree.
getClasstree	Function in class PhpdocIndexer Returns the current classtree and resets the internal classtree field.
getClasstree	Function in class PhpdocHTMLClassRenderer Returns a html string that shows the class tree.
getSubclasses	Function in class PhpdocClassAccessor Returns an array with all subclasses of a class.
getModuledata	Function in class PhpdocModuleAccessor Returns an array with the data of a module (no functions etc, just the module docs).
getFunctions	Function in class PhpdocDocumentAccessor Returns an array with all functions.
getFunctionsByAccess	Function in class PhpdocDocumentAccessor Returns an array with all functions with a certain access (public, private) attribute.
getVariables	Function in class PhpdocDocumentAccessor Returns an array with all variables.
getVariablesByAccess	Function in class PhpdocDocumentAccessor Returns an array with all variables with a certain access (public, private) attribute.
getConstants	Function in class PhpdocDocumentAccessor Returns an array of all constants.
getConstantsByAccess	Function in class PhpdocDocumentAccessor Returns an array of all constants with a certain access (public, private) attribute.
getUses	Function in class PhpdocDocumentAccessor Returns an array of all included files.
getUsesByType	Function in class PhpdocDocumentAccessor Returns an array of all included files with a certain type (include, require...) attribute.
getElements	Function in class PhpdocDocumentAccessor Returns elements from the internal $data array.
getElementsByAccess	Function in class PhpdocDocumentAccessor Returns elements with a certain access type from the internal data.
getElementlist	Function in class PhpdocDocumentAccessor Adds a list of a certain element to the internal data array.
getElementlist	Function in class PhpdocIndexer Returns the element index list and resets the internal elements field.
getModulegroup	Function in class PhpdocIndexAccessor Returns a modulegroup
getModulegroup	Function in class PhpdocIndexer Returns the current modulegroup and resets the internal modulegroup field.
getModulegroup	Function in class PhpdocParser Returns the data of one module group.
getChapternames	Function in class PhpdocIndexAccessor Returns an ordered list of all chapternames.
getChapters	Function in class PhpdocIndexAccessor Returns an ordered list of all chapters.
getPackagelist	Function in class PhpdocIndexAccessor Returns a list of all packages
getWarnings	Function in class PhpdocWarningAccessor Returns a hash of warnings in of the given XML file.
getWarnings	Function in class PhpdocWarning Returns a list of warnings.
getClass	Function in class PhpdocClassAnalyser Returns an analysed class or false if there're no classes any more.
getModule	Function in class PhpdocModuleAnalyser Returns a module from the modulegroup or false if there are no more modules.
getCheckedDirname	Function in class PhpdocSetupHandler Adds a slash at the end of the given filename if neccessary.
getArgvHelpMessage	Function in class PhpdocArgvHandler Returns the current help message of phpdoc
get	Function in class PhpdocFileHandler Reads a list of files or one file.
get	Function in class IntegratedTemplate Returns a block with all replacements done.
getFile	Function in class PhpdocFileHandler Reads a file.
getFile	Function in class IntegratedTemplate Reads a file from disk and returns its content.
getFilesInDirectory	Function in class PhpdocFileHandler Returns a list of files in a specified directory
getPackages	Function in class PhpdocIndexer Returns the package list and resets the internal package field.
getClassTree	Function in class PhpdocParser Returns the data of one parentclass and all it's subclasses or false.
getClassnamesToFilenames	Function in class PhpdocParser Returns the mapping array from classnames to filenames
getFunctionArgs	Function in class PhpdocFunctionParser Analyses a function head and returns an array of arguments.
getPhpdocParagraphs	Function in class PhpdocParserCore Scans code for documented and undocumented phpdoc keywords (classes, functions, class variables, uses, constants).
getModulesAndClasses	Function in class PhpdocParserCore Does a quick prescan to find modules an classes.
getModuleDoc	Function in class PhpdocParserCore Tries to extract a module doc.
getClasses	Function in class PhpdocParserCore Returns a list of classes found in the given code.
getDescription	Function in class PhpdocParserCore Extract the description from a PHPDoc doc comment.
getValue	Function in class PhpdocParserCore Scans a code passage for a value.
getVariableTypeAndValue	Function in class PhpdocParserCore Analyses a code snipped and returns the type and value of the first variable found.
getTags	Function in class PhpdocParserTags Extracts PHPDoc tags from a PHPDoc doc comment.
getTagPos	Function in class PhpdocParserTags Find the position of the next phpdoc tag.
getIndent	Function in class PhpdocHTMLClassRenderer Returns a certain number of " "s.
getParameter	Function in class PhpdocHTMLDocumentRenderer Converts the XML parameter array into formatted string.
generate	Function in class PhpdocHTMLIndexRenderer Builds all index files phpdoc needs assuming that the xml files have default names
getNumDocWarnings	Function in class PhpdocWarning Returns the total number of documentation warnings.
globalsXML	Function in class PhpdocXMLDocumentExporter Adds container to the xml document.
$globalAttributes	Variable in Class PhpdocXMLDocumentExporter Attributes of the container.
getAttributes	Function in class PhpdocXMLExporter Kind of array_intersect for xml attributes.
getMessage	Function in class PhpdocError Returns a string with the error message.
getGlobalvariables	Function in class IntegratedTemplate Returns a list of all
h
handleArgv	Function in class PhpdocArgvHandler Handle the command line values
$haltOnWarning	Variable in Class IntegratedTemplateExtension Call die() on warning?
halt	Function in class IntegratedTemplate Error Handling function.
$haltOnError	Variable in Class IntegratedTemplate Call die() on error?
i
init	Function in class PhpdocClassAccessor Reformats the xml result array from the PhpdocXMLReader.
init	Function in class PhpdocModuleAccessor Reformats the xml result array from the PhpdocXMLReader.
init	Function in class PhpdocIndexAccessor Resets the build flags.
init	Function in class PhpdocWarningAccessor Reformats the xml result array from the PhpdocXMLReader.
init	Function in class PhpdocAccessor Reformats the xml result array from the PhpdocXMLReader.
init	Function in class IntegratedTemplate Clears all datafields of the object and rebuild the internal blocklist
$inherited	Variable in Class PhpdocClassAccessor Array of inherited elements
inheritClassElements	Function in class PhpdocClassAnalyser Adds inherited elements to a class.
isUndocumented	Function in class PhpdocClassAnalyser Returns true if the requested element is undocumented and false if it's documented.
$indexer_result	Variable in Class Phpdoc Result from the indexer
$indent	Variable in Class PhpdocHTMLClassRenderer Internal array of " " strings to format HTML output.
$indexrenderer	Variable in Class PhpdocHTMLRendererManager
inheritedOverridenXML	Function in class PhpdocXMLClassExporter Handles inherited and overriden elements.
$inheritedOverridenAttributes	Variable in Class PhpdocXMLDocumentExporter Attributes of and container.
importXML	Function in class PhpdocXMLReader Converts an xml_parse_into_struct value array to an array that's simmilar to phpdocs internal arrays.
introspection	Function in class PhpdocObject Dumps objects and arrays.
I
IntegratedTemplateExtension	Class IntegratedTemplateExtension. Integrated Template Extension - ITX
IntegratedTemplateExtension	Function in class IntegratedTemplateExtension Builds some complex regexps and calls the constructor of the parent class.
IntegratedTemplate	Class IntegratedTemplate. Integrated Template - IT
IntegratedTemplate	Function in class IntegratedTemplate Builds some complex regular expressions and optinally sets the file root directory.
l
loadXMLFile	Function in class PhpdocAccessor Loads the specified xml file.
loadPackagelist	Function in class PhpdocHTMLIndexRenderer Imports the packagelist from the PhpdocIndexAccessor if not done previously.
linkXML	Function in class PhpdocXMLDocumentExporter Adds container to the xml document.
$linkAttributes	Variable in Class PhpdocXMLDocumentExporter Attributes of the container.
$line	Variable in Class PhpdocError Line number where the error occured.
loadTemplatefile	Function in class IntegratedTemplate Reads a template file from the disk.
m
$modulegroup	Variable in Class PhpdocIndexAccessor Data of a modulegroup
$modulegroup	Variable in Class PhpdocModuleAnalyser Module data
$modulegroup	Variable in Class PhpdocIndexer Current modulegroup.
$modulelist	Variable in Class PhpdocModuleAnalyser List of all modules in the modulegroup
$modulefiles	Variable in Class PhpdocParser List of all files containing modules.
$modulegroups	Variable in Class PhpdocParser List of all module groups.
$modules	Variable in Class PhpdocParser Hash with the data of the current module group.
$moduleTags	Variable in Class PhpdocModuleParser List of tags allowed within a module doc comment.
$moduleGroups	Variable in Class PhpdocModuleParser Hash of all module groups
$moduleTpl	Variable in Class PhpdocHTMLIndexRenderer IntegratedTemplateObject used by renderModulegroup()
$modulerenderer	Variable in Class PhpdocHTMLRendererManager
$moduleAttributes	Variable in Class PhpdocXMLModuleExporter Module container attributes
$message	Variable in Class PhpdocError The error message itself.
n
$notinherited	Variable in Class PhpdocClassAnalyser List of not inherited elements.
$num_doc_warnings	Variable in Class PhpdocWarning Counter containing the number of documentation warnings.
nameToUrl	Function in class PhpdocObject Encodes an element name so that it can be used as a file name.
o
out	Function in class PhpdocObject Print a string and flushes the output buffer
outl	Function in class PhpdocObject Print a string, the specified HTML line break sign and flushes the output buffer
$openingDelimiter	Variable in Class IntegratedTemplate First character of a variable placeholder ( _ ).
P
PhpdocClassAccessor	Class PhpdocClassAccessor. Provides functions to access phpdoc xml documents that contain classes.
PhpdocModuleAccessor	Class PhpdocModuleAccessor. Provides functions to access phpdoc xml documents that contain modules.
PhpdocDocumentAccessor	Class PhpdocDocumentAccessor. Base of the class and module accessor.
PhpdocIndexAccessor	Class PhpdocIndexAccessor. Provides a API to access Index xml documents.
PhpdocWarningAccessor	Class PhpdocWarningAccessor. Extracts the warnings from PHPDoc warnings_* files.
PhpdocAccessor	Class PhpdocAccessor. Provides an API to access PHPDoc XML files.
PhpdocClassAnalyser	Class PhpdocClassAnalyser. Analyses a class.
PhpdocModuleAnalyser	Class PhpdocModuleAnalyser. Analyses a modulegroup.
PhpdocAnalyser	Class PhpdocAnalyser. Analyses parsing data.
Phpdoc	Class Phpdoc. Coordinates several Phpdoc Object to parse and render source files.
Phpdoc	Function in class Phpdoc Calls the command line handler if necessary.
PhpdocSetupHandler	Class PhpdocSetupHandler. Handles the "setup".
PhpdocArgvHandler	Class PhpdocArgvHandler. Handles command line arguments.
PhpdocFileHandler	Class PhpdocFileHandler. File handling functions in phpdoc.
PhpdocIndexer	Class PhpdocIndexer. Builds Indexlists with the result from the
PhpdocParser	Class PhpdocParser. "Main" class of the Parser collection.
PhpdocParser	Function in class PhpdocParser Creates an instance of PhpdocWarning and calls buildComplexRegExps() to initialize the object.
PhpdocClassParser	Class PhpdocClassParser. Parses phpcode to extract classes and their documentation.
PhpdocFunctionParser	Class PhpdocFunctionParser. Looks for documented and undocumented functions within a block of php code.
PhpdocVariableParser	Class PhpdocVariableParser. Extract class variables and their documentation from phpcode
PhpdocModuleParser	Class PhpdocModuleParser. Extracts modules and their documentation from php code.
PhpdocConstantParser	Class PhpdocConstantParser. Extracts define statements and their documentation from php code.
PhpdocUseParser	Class PhpdocUseParser. Extracts use statements (include and friends) an thheir documentation from php code.
PhpdocParserCore	Class PhpdocParserCore. Provides basic parser functions.
PhpdocParserTags	Class PhpdocParserTags. Functions used to parse PHPDoc Tags.
PhpdocParserRegExp	Class PhpdocParserRegExp. Defines all regular expressions.
$PHPDOC_TAGS	Variable in Class PhpdocParserRegExp Array of phpdoc tags, indexed by the tagname.
$PHP_BASE	Variable in Class PhpdocParserRegExp Basic RegExps used to analyse PHP Code.
$PHP_COMPLEX	Variable in Class PhpdocParserRegExp List of regular expressions used to grep complex php code elements.
PhpdocHTMLClassRenderer	Class PhpdocHTMLClassRenderer. Renders classes.
PhpdocHTMLClassRenderer	Function in class PhpdocHTMLClassRenderer Sets the xml and template root directory.
PhpdocHTMLModuleRenderer	Class PhpdocHTMLModuleRenderer. Renders modules.
PhpdocHTMLModuleRenderer	Function in class PhpdocHTMLModuleRenderer Sets the xml and template root directory.
PhpdocHTMLDocumentRenderer	Class PhpdocHTMLDocumentRenderer. Provides functioninality to render modules and classes.
PhpdocHTMLIndexRenderer	Class PhpdocHTMLIndexRenderer. Renders Index lists.
PhpdocHTMLIndexRenderer	Function in class PhpdocHTMLIndexRenderer Sets the xml and template root directory.
PhpdocHTMLWarningRenderer	Class PhpdocHTMLWarningRenderer. Renders files with warnings.
PhpdocHTMLWarningRenderer	Function in class PhpdocHTMLWarningRenderer Sets the xml and template root directory.
PhpdocHTMLRenderer	Class PhpdocHTMLRenderer. Default HTML Renderer based on templates.
PhpdocRendererObject	Class PhpdocRendererObject. Superclass of all Renderer.
PhpdocHTMLRendererManager	Class PhpdocHTMLRendererManager. Controls the HTML Renderer objects.
PhpdocHTMLRendererManager	Function in class PhpdocHTMLRendererManager Creates all necessary renderer objects
PhpdocWarning	Class PhpdocWarning. Container for all kind of Warnings the parser/analyser recognizes
PhpdocXMLClassExporter	Class PhpdocXMLClassExporter. Exports the data of a class as an xml file.
PhpdocXMLClassExporter	Function in class PhpdocXMLClassExporter
PhpdocXMLModuleExporter	Class PhpdocXMLModuleExporter. Exports the data of a module as an xml document
PhpdocXMLModuleExporter	Function in class PhpdocXMLModuleExporter
PhpdocXMLDocumentExporter	Class PhpdocXMLDocumentExporter. Base of the class and module exporter.
PhpdocXMLIndexExporter	Class PhpdocXMLIndexExporter. Creates XML index files.
PhpdocXMLIndexExporter	Function in class PhpdocXMLIndexExporter Just call the parent class constructor
PhpdocXMLWarningExporter	Class PhpdocXMLWarningExporter. Exports a list of documentation warnings found by phpdoc
PhpdocXMLWarningExporter	Function in class PhpdocXMLWarningExporter
PhpdocXMLExporter	Class PhpdocXMLExporter. Exporter used to export phpdoc internals data structures as xml documents.
PhpdocXMLExporter	Function in class PhpdocXMLExporter Creates a PhpdocXMLWriter object.
PhpdocXMLReader	Class PhpdocXMLReader. Reads XML documents into a multi dimensional Array.
PhpdocXMLWriter	Class PhpdocXMLWriter. Creates XML documents.
PhpdocXMLWriter	Function in class PhpdocXMLWriter Creates a new PhpdocFileHandler
PhpdocObject	Class PhpdocObject. Common base class of all phpdoc classes
PhpdocError	Class PhpdocError. PHPDoc Error Handling class
PhpdocError	Function in class PhpdocError Sets the error message, filename and linenumber.
PHPDoc	Package
p
$packages	Variable in Class PhpdocIndexAccessor List of all packages.
$packages	Variable in Class PhpdocIndexer Array of all packages.
$packages	Variable in Class PhpdocParser Hash of all packages found.
$packages	Variable in Class PhpdocHTMLIndexRenderer Packagelist from the PhpdocIndexAccessor
$packageFields	Variable in Class PhpdocIndexAccessor Some container withing the packagelist.
$packageFields	Variable in Class PhpdocHTMLIndexRenderer Some container in the package list.
parse	Function in class Phpdoc Starts the parser.
parse	Function in class PhpdocXMLReader Parses a given XML file and returns the data as a hash.
parse	Function in class IntegratedTemplate Parses the given block.
$path	Variable in Class PhpdocFileHandler Filepath. The path is automatically added in front of all filenames
$path	Variable in Class PhpdocHTMLRenderer Directory path prefix.
$path	Variable in Class PhpdocXMLExporter Target directory where the xml documents get saved.
preparse	Function in class PhpdocParser Central parsing function.
$phpfiles	Variable in Class PhpdocParser Array of PHP Sourcecode Files to examine.
pathXML	Function in class PhpdocXMLClassExporter Writes the "path" (inheritance chain) of an element.
paramsXML	Function in class PhpdocXMLDocumentExporter Adds container to the xml document.
$paramAttributes	Variable in Class PhpdocXMLDocumentExporter Attributes of the container.
printMessage	Function in class PhpdocError Prints the error message.
$printWarning	Variable in Class IntegratedTemplateExtension Print warnings?
parseCurrentBlock	Function in class IntegratedTemplate Parses the current block
$printError	Variable in Class IntegratedTemplate Print error messages?
r
render	Function in class Phpdoc Renders the PHPDoc XML files as HTML files
render	Function in class PhpdocHTMLRendererManager Renders the given xml file.
renderClass	Function in class PhpdocHTMLClassRenderer Renders a class.
renderInherited	Function in class PhpdocHTMLClassRenderer Renders a list of inherited elements.
renderInheritedElements	Function in class PhpdocHTMLClassRenderer Renders a list of a certain inherited element.
renderSubclasses	Function in class PhpdocHTMLClassRenderer Renders a list of direct known subclasses.
renderVariables	Function in class PhpdocHTMLClassRenderer Adds a summary and a detailed list of all variables to the template.
renderVariableSummary	Function in class PhpdocHTMLClassRenderer Adds a summary of all variables to the template.
renderVariableDetail	Function in class PhpdocHTMLClassRenderer Adds a detailed list of all variables to the template.
renderModule	Function in class PhpdocHTMLModuleRenderer Renders a module
renderConstants	Function in class PhpdocHTMLDocumentRenderer Adds a summary and a detailed list of all constants to the template.
renderConstantSummary	Function in class PhpdocHTMLDocumentRenderer Adds a summary of all constants to the template.
renderConstantDetail	Function in class PhpdocHTMLDocumentRenderer Adds a detailed list of all constants to the template.
renderUses	Function in class PhpdocHTMLDocumentRenderer Adds a summary and a detailed list of included files to the template.
renderUsesDetail	Function in class PhpdocHTMLDocumentRenderer Adds a detailed list of all included files to the template.
renderUsesSummary	Function in class PhpdocHTMLDocumentRenderer Adds a summary of all included files to the template.
renderFunctions	Function in class PhpdocHTMLDocumentRenderer Adds a summary and a detailed list of all functions to the template.
renderFunctionSummary	Function in class PhpdocHTMLDocumentRenderer Adds a function summary to the template.
renderFunctionDetail	Function in class PhpdocHTMLDocumentRenderer Adds a detailed list of functions to the template.
renderParameterDetail	Function in class PhpdocHTMLDocumentRenderer Renders a detailed list of function parameters.
renderSee	Function in class PhpdocHTMLDocumentRenderer Renders a block with references to other source elements.
renderAuthors	Function in class PhpdocHTMLDocumentRenderer Renders an author list.
renderLinks	Function in class PhpdocHTMLDocumentRenderer Renders a list of external links.
renderThrows	Function in class PhpdocHTMLDocumentRenderer Renders a list of exceptions.
renderGlobals	Function in class PhpdocHTMLDocumentRenderer Renders a list of global elements.
renderCommonDocfields	Function in class PhpdocHTMLDocumentRenderer Adds some tags to the template that are allowed nearly everywhere.
renderElementlist	Function in class PhpdocHTMLIndexRenderer Renders the element index list.
renderPackagelist	Function in class PhpdocHTMLIndexRenderer Renders a complete packagelist.
renderFrameElementlist	Function in class PhpdocHTMLIndexRenderer Renders files for the lower left frame with the elements of a certain file.
renderFramePackagesummary	Function in class PhpdocHTMLIndexRenderer Renders a Packagesummary for the frameset.
returnXML	Function in class PhpdocXMLDocumentExporter Adds container to the xml document.
$returnAttributes	Variable in Class PhpdocXMLDocumentExporter Attributes of the container.
$result	Variable in Class PhpdocXMLExporter Data to save as a xml document.
replaceBlock	Function in class IntegratedTemplateExtension Replaces an existing block with new content. Warning: not implemented yet.
replaceBlockfile	Function in class IntegratedTemplateExtension Replaces an existing block with new content from a file. Warning: not implemented yet.
$removeUnknownVariables	Variable in Class IntegratedTemplate Controls the handling of unknown variables, default is remove.
$removeEmptyBlocks	Variable in Class IntegratedTemplate Controls the handling of empty blocks, default is remove.
s
setClasses	Function in class PhpdocClassAnalyser Sets the class data and the name of the baseclass.
setModulegroup	Function in class PhpdocModuleAnalyser Sets the data of the modulegroup to analyse.
setSourceDirectory	Function in class PhpdocSetupHandler Sets the name of the directory with the source to scan.
setTemplateDirectory	Function in class PhpdocSetupHandler Sets the name of the directory with the templates.
setApplication	Function in class PhpdocSetupHandler Sets the name of your application.
setTargetFileSuffix	Function in class PhpdocSetupHandler Suffix for all rendered files in the application (not for the xml files)
setSourceFileSuffix	Function in class PhpdocSetupHandler Suffix of all source code files in the application
setTarget	Function in class PhpdocSetupHandler Sets the target where the generated files are saved.
$sourceFileSuffix	Variable in Class PhpdocSetupHandler Suffix of all source code files in the application
$sourceDirectory	Variable in Class PhpdocSetupHandler Directory with the php sources to parse.
setFilePath	Function in class PhpdocFileHandler Sets the filepath. The path is automatically added in front of all filenames
setPhpSourcecodeFiles	Function in class PhpdocParser Sets the list of PHP Soucecode Files to examine.
$simpleDocfields	Variable in Class PhpdocHTMLDocumentRenderer Array of doc container fields that get mapped directly to templateblocks.
setPath	Function in class PhpdocHTMLRenderer Sets a directory path prefix.
setPath	Function in class PhpdocXMLExporter Sets the target path for the generated xml documents.
setTemplateRoot	Function in class PhpdocHTMLRenderer Sets the template directory.
subclassesXML	Function in class PhpdocXMLClassExporter Adds a list of subclasses to the generated xml.
seeXML	Function in class PhpdocXMLDocumentExporter Adds container to the xml document.
$seeAttributes	Variable in Class PhpdocXMLDocumentExporter Attributes of the container.
setResult	Function in class PhpdocXMLExporter
stripCloseFromStructvalues	Function in class PhpdocXMLReader Strips all values out of the xml_parse_intro_struct() values array with the type "open".
$structvalues	Variable in Class PhpdocXMLReader Values array from xml_parse_into_struct().
startElement	Function in class PhpdocXMLWriter Adds an open (or single) xml tag to the generated xml.
setFlagOutput	Function in class PhpdocObject Sets the output flag - if set to true out() and outl() print messages
show	Function in class IntegratedTemplate Print a certain block with all replacements done.
setVariable	Function in class IntegratedTemplate Sets a variable value.
setCurrentBlock	Function in class IntegratedTemplate Sets the name of the current block that is the block where variables are added.
setTemplate	Function in class IntegratedTemplate Sets the template.
setRoot	Function in class IntegratedTemplate Sets the file root. The file root gets prefixed to all filenames passed to the object.
t
$target	Variable in Class PhpdocSetupHandler Name of the target directory.
$targetFileSuffix	Variable in Class PhpdocSetupHandler Suffix for all rendered files in the application (except for the xml files).
$treeTpl	Variable in Class PhpdocHTMLIndexRenderer IntegratedTemplate Object used be renderClasstree()
$tpl	Variable in Class PhpdocHTMLRenderer Template object
$templateRoot	Variable in Class PhpdocHTMLRenderer Rootpath for Templatefiles.
throwsXML	Function in class PhpdocXMLDocumentExporter Adds container to the xml document.
$template	Variable in Class IntegratedTemplate Content of the template.
T
$TAGS	Variable in Class PhpdocParserRegExp Array of RegExp matching the syntax of several complex tags.
u
updateBrotherSisterElements	Function in class PhpdocClassAnalyser
updateBrotherSisterElements	Function in class PhpdocModuleAnalyser
updateBrotherSisterElements	Function in class PhpdocAnalyser Updates certain elements that use brother and sister.
updateAccessReturnElements	Function in class PhpdocClassAnalyser Updates access and return for certain elements.
updateAccessReturnElements	Function in class PhpdocModuleAnalyser
updateAccessReturnElements	Function in class PhpdocAnalyser Updates access and return for certain elements.
updateAccessElements	Function in class PhpdocClassAnalyser Updates access tags.
updateAccessElements	Function in class PhpdocModuleAnalyser
updateAccessElements	Function in class PhpdocAnalyser Updates access tags.
updateBrothersSisters	Function in class PhpdocClassAnalyser Handles brother and sister.
updateBrothersSisters	Function in class PhpdocModuleAnalyser Handles brother and sister.
updateBrothersSisters	Function in class PhpdocAnalyser Handles brother and sister.
updateAccessReturn	Function in class PhpdocClassAnalyser Updates the access and return tag values.
updateAccessReturn	Function in class PhpdocModuleAnalyser Updates the access and return tag values.
updateAccessReturn	Function in class PhpdocAnalyser Updates the access and return tag values.
$undocumentedFields	Variable in Class PhpdocClassAnalyser Puuuh - findUndocumented() needs this.
$undocumentedFields	Variable in Class PhpdocModuleAnalyser Puuuh - findUndocumented() needs this.
$useTags	Variable in Class PhpdocUseParser List of allowed tags in use doc comments.
$undocumented	Variable in Class PhpdocHTMLDocumentRenderer Message displayed if an object lacks documentation.
$uses	Variable in Class PhpdocHTMLDocumentRenderer Array of included files.
$usesTypes	Variable in Class PhpdocHTMLDocumentRenderer Types of include statements.
usesXML	Function in class PhpdocXMLDocumentExporter Adds a list of used files (include, require...) to the xml document.
$usesAttributes	Variable in Class PhpdocXMLDocumentExporter Attribues of the container.
updateBlockvariablelist	Function in class IntegratedTemplateExtension Updates the variable list of a block.
v
$variableTags	Variable in Class PhpdocVariableParser Array of tags that are allowed in front of the var keyword
$variables	Variable in Class PhpdocHTMLClassRenderer Array of variables found in the xml document.
variablesXML	Function in class PhpdocXMLClassExporter Adds class variables to the XMl document.
$variableAttributes	Variable in Class PhpdocXMLClassExporter Variable container attributes.
$variablenameRegExp	Variable in Class IntegratedTemplate RegExp matching a variable placeholder in the template.
$variablesRegExp	Variable in Class IntegratedTemplate Full RegExp used to find variable placeholder, filled by the constructor.
$variableCache	Variable in Class IntegratedTemplate Variable cache.
w
$warnings	Variable in Class PhpdocWarningAccessor Array of warnings.
$warn	Variable in Class PhpdocRendererObject Use to save warnings.
$warn	Variable in Class PhpdocXMLWriter PHPDoc Warning object
$warn	Variable in Class PhpdocObject Use to save warnings.
$warn	Variable in Class IntegratedTemplateExtension Array with all warnings.
$warningrenderer	Variable in Class PhpdocHTMLRendererManager
$warningAttributes	Variable in Class PhpdocXMLWarningExporter Attributes of a warning container.
warning	Function in class IntegratedTemplateExtension Handles warnings, saves them to $warn and prints them or calls die() depending on the flags
x
$xmlkey	Variable in Class PhpdocClassAccessor Kind of top-level container in the xml document.
$xmlkey	Variable in Class PhpdocModuleAccessor Kind of top-level container in the xml document.
$xmlkey	Variable in Class PhpdocDocumentAccessor Kind of top-level container in the xml document.
$xmlreader	Variable in Class PhpdocAccessor Instance of PhpdocXMLReader
$xml	Variable in Class PhpdocAccessor Result of the PhpdocXMLReader
$xml	Variable in Class PhpdocXMLWriter Generated XML document.
$xmlwriter	Variable in Class PhpdocXMLExporter Instance of PhpdocXMLWriter used to generate the xml document.
xmldecode	Function in class PhpdocXMLReader Replaces some basic entities with their character counterparts.
xmlencode	Function in class PhpdocXMLWriter Encodes XML values.
Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta