Provides functions to access phpdoc xml documents that contain classes.Provides functions to access phpdoc xml documents that contain modules.Base of the class and module accessor.Provides a API to access Index xml documents.Extracts the warnings from PHPDoc warnings_* files.Provides an API to access PHPDoc XML files.Analyses a class.Analyses a modulegroup.Analyses parsing data.Coordinates several Phpdoc Object to parse and render source files.Calls the command line handler if necessary.Handles the "setup".Handles command line arguments.File handling functions in phpdoc.Builds Indexlists with the result from the"Main" class of the Parser collection.Creates an instance of PhpdocWarning and calls buildComplexRegExps() to initialize the object.Parses phpcode to extract classes and their documentation.Looks for documented and undocumented functions within a block of php code.Extract class variables and their documentation from phpcodeExtracts modules and their documentation from php code.Extracts define statements and their documentation from php code.Extracts use statements (include and friends) an thheir documentation from php code.Provides basic parser functions.Functions used to parse PHPDoc Tags.Defines all regular expressions.Array of phpdoc tags, indexed by the tagname.Basic RegExps used to analyse PHP Code.List of regular expressions used to grep complex php code elements.Renders classes.Sets the xml and template root directory.Renders modules.Sets the xml and template root directory.Provides functioninality to render modules and classes.Renders Index lists.Sets the xml and template root directory.Renders files with warnings.Sets the xml and template root directory.Default HTML Renderer based on templates.Superclass of all Renderer.Controls the HTML Renderer objects.Creates all necessary renderer objectsContainer for all kind of Warnings the parser/analyser recognizesExports the data of a class as an xml file.Exports the data of a module as an xml documentBase of the class and module exporter.Creates XML index files.Just call the parent class constructorExports a list of documentation warnings found by phpdocExporter used to export phpdoc internals data structures as xml documents.Creates a PhpdocXMLWriter object.Reads XML documents into a multi dimensional Array.Creates XML documents.Creates a new PhpdocFileHandlerCommon base class of all phpdoc classesPHPDoc Error Handling classSets the error message, filename and linenumber.Returns an array with the data of a class (no functions etc, just the class docs).Returns an array of inherited functions.Returns an array of inherited variables.Returns an array of inherited included files.Returns an array of inherited constants.Returns an array with the "path" of a class.Returns a classtree.Returns the current classtree and resets the internal classtree field.Returns a html string that shows the class tree.Returns an array with all subclasses of a class.Returns an array with the data of a module (no functions etc, just the module docs).Returns an array with all functions.Returns an array with all functions with a certain access (public, private) attribute.Returns an array with all variables.Returns an array with all variables with a certain access (public, private) attribute.Returns an array of all constants.Returns an array of all constants with a certain access (public, private) attribute.Returns an array of all included files.Returns an array of all included files with a certain type (include, require...) attribute.Returns elements from the internal $data array.Returns elements with a certain access type from the internal data.Adds a list of a certain element to the internal data array.Returns the element index list and resets the internal elements field.Returns a modulegroupReturns the current modulegroup and resets the internal modulegroup field.Returns the data of one module group.Returns an ordered list of all chapternames.Returns an ordered list of all chapters.Returns a list of all packagesReturns a hash of warnings in of the given XML file.Returns a list of warnings.Returns an analysed class or false if there're no classes any more.Returns a module from the modulegroup or false if there are no more modules.Adds a slash at the end of the given filename if neccessary.Returns the current help message of phpdocReads a list of files or one file.Returns a block with all replacements done.Reads a file.Reads a file from disk and returns its content.Returns a list of files in a specified directoryReturns the package list and resets the internal package field.Returns the data of one parentclass and all it's subclasses or false.Returns the mapping array from classnames to filenamesAnalyses a function head and returns an array of arguments.Scans code for documented and undocumented phpdoc keywords (classes, functions, class variables, uses, constants).Does a quick prescan to find modules an classes.Tries to extract a module doc.Returns a list of classes found in the given code.Extract the description from a PHPDoc doc comment.Scans a code passage for a value.Analyses a code snipped and returns the type and value of the first variable found.Extracts PHPDoc tags from a PHPDoc doc comment.Find the position of the next phpdoc tag.Returns a certain number of " "s.Converts the XML parameter array into formatted string.Builds all index files phpdoc needs assuming that the xml files have default namesReturns the total number of documentation warnings.Adds <global> container to the xml document.Attributes of the <global> container.Kind of array_intersect for xml attributes.Returns a string with the error message.Returns a list of allConverts a xml path array to a path that can be passed to the user.Ordered list of all chapternames.Ordered list of all chapters.Data of a classtreeCurrent classtree.Hash of all class trees.Array with classtree informationsChecks the function documentation of a certain class.Compares the param tags with the function head found.Compares the param tags with the function head found.Checks see references in the given element array (functions, variables...)Checks see references in the given element array (functions, variables...)Checks all see references in the given classes/modulegroup.Checks all see references in the given classes/modulegroup.Checks all see references in the given classes/modulegroup.Class data.Hash with the data of the current class tree (one parentclass with all children).Array of all classes in the given codeOrdered list of all classes.Copies fields from a brother or sister to the current element.Checks see references in the given elementlist.Compares the argument list generated from the function head with the param tags found.Checks the current status of the object. Are all necessary informations to start parsing available?Creates a new file.Name of the file currently parsed.Mapping from classnames to filenamesList of all files containing classes.Name of the base class of the current class tree.Array of tags that are allowed in front of the class keywordCompares the var tag informations with the analyse of the source code.Compares the data from the parser with the optional const[ant] tagsDoc Tags allowed with const[ant].Takes an array filled by analyseTags() and converts the parse errors into a single error message.Array of constants.Class container attributes.Adds all constants (define(), const) to the xml document.Attributes of the <constant> container.Chapter tag attributesCreates a PhpdocFileHandler object and saves it to $filehandler if it does not already exist.Name of the error object class used to construct the error messageRegExp used to test for a valid blockname.Clear cache on get()?Last character of a variable placeholder ( {VARIABLE_}_ ).Name of the current block.Builds a list of inherited elements.Builds a list of subclassesAdds a list of included files to the internal data array.Builds the internal packagelist.Builds the internal chapterlists.Extracts the modulegroup data of the xml file.Extracts the classtree data of the xml file.Build the internal list of warnings.Builds an internal list of all classes.Builds an array with all elements of a class and saves it to $this->elementlist.Builds an array with all elements of a class and saves it to $this->elementlist.Build a list of all elemente (functions, variables,...) of a certain class/moduleName of the baseclass of the given classes.Builds an internal list of all modules in the modulegroup.Basedir for all file operationsList of all parentclasses found.Builds complex regular expressions for the parser.Recursivly builds an HTML class tree using <ul><li></ul>.Adds a baseclass container to the generated xml.Build a list of all variables within a blockRegExp matching a block in the template.Full RegExp used to find blocks an their content, filled by the constructor.Array of all blocks and their content.Array with the parsed content of a block.Array of variables in a block.Array of inner blocks of a block.Future versions will use this...Reformats the xml result array from the PhpdocXMLReader.Reformats the xml result array from the PhpdocXMLReader.Resets the build flags.Reformats the xml result array from the PhpdocXMLReader.Reformats the xml result array from the PhpdocXMLReader.Clears all datafields of the object and rebuild the internal blocklistArray of inherited elementsAdds inherited elements to a class.Returns true if the requested element is undocumented and false if it's documented.Result from the indexerInternal array of " " strings to format HTML output.Handles inherited and overriden elements.Attributes of <inherited> and <overriden> container.Converts an xml_parse_into_struct value array to an array that's simmilar to phpdocs internal arrays.Dumps objects and arrays.Kind of top-level container in the xml document.Kind of top-level container in the xml document.Kind of top-level container in the xml document.Instance of PhpdocXMLReaderResult of the PhpdocXMLReaderGenerated XML document.Instance of PhpdocXMLWriter used to generate the xml document.Replaces some basic entities with their character counterparts.Encodes XML values.List of all packages.Array of all packages.Hash of all packages found.Packagelist from the PhpdocIndexAccessorSome container withing the packagelist.Some container in the package list.Starts the parser.Parses a given XML file and returns the data as a hash.Parses the given block.Filepath. The path is automatically added in front of all filenamesDirectory path prefix.Target directory where the xml documents get saved.Central parsing function.Array of PHP Sourcecode Files to examine.Writes the "path" (inheritance chain) of an element.Adds <parameter> container to the xml document.Attributes of the <param> container.Prints the error message.Print warnings?Parses the current blockPrint error messages?Data of a modulegroupModule dataCurrent modulegroup.List of all modules in the modulegroupList of all files containing modules.List of all module groups.Hash with the data of the current module group.List of tags allowed within a module doc comment.Hash of all module groupsIntegratedTemplateObject used by renderModulegroup()Module container attributesThe error message itself.Flag indicating that certain internal datafield have been filled.If set to true all get_xy() functions will free their resources.Free xml resources on calling a getXY() function?Flag used to detect if get_xy() was called.sLooks for undocumented elements in a certain classLooks for undocumented elements and adds a warning if neccessary.Looks for undocumented elements and adds a warning if neccessary.Flag indicating that getModule/getClass was called.Print status messagesFlag determining wheter to print some status messages or not (default: false)Builds the hash of module groups and the module file list.Builds a hash of all class trees.Flag indicating that getClassTree() was called.Flag indicating that getModulegroup was called.Array of tags that are allowed in front of the function keywordArray of functions found in the xml document.Saves the generated classtree summary to disk.Saves the generated report.Extension for generated files.Finishes the rendering process.Filename prefix for the generated xml document.Filename prefix for the generated xml document.Filename prefix for the generated xml document.Filename prefix for the generated xml document.Writes a <file> container.Adds a list of functions to the xml file.Attribues of the <function> container.PHPDocFileHandler object.Clears the internal xml data buffer so that a new document can be passed to the object.Clears all datafields of the object.Filehandler used for IO operationsFile where the error occured.Returns an array of blocknames where the given variable placeholder is used.Recusively builds a list of all blocks within the template.Root directory for all file operations.Internal flag indicating that a blockname was used multiple times.Flag indicating that the global block was parsed.Array of warnings.Use to save warnings.PHPDoc Warning objectUse to save warnings.Array with all warnings.Attributes of a warning container.Handles warnings, saves them to $warn and prints them or calls die() depending on the flagsLoads the specified xml file.Imports the packagelist from the PhpdocIndexAccessor if not done previously.Adds <link> container to the xml document.Attributes of the <link> container.Line number where the error occured.Reads a template file from the disk.Reformatted PhpdocXMLReader result arrayHash of documentation failures.Adds a documentation block (author, links, see, params...) to the xml documentMapping from internal result array index name to xml tag name.Deletes one or many variables from the block variable list.Sets the class data and the name of the baseclass.Sets the data of the modulegroup to analyse.Sets the name of the directory with the source to scan.Sets the name of the directory with the templates.Sets the name of your application.Suffix for all rendered files in the application (not for the xml files)Suffix of all source code files in the applicationSets the target where the generated files are saved.Suffix of all source code files in the applicationDirectory with the php sources to parse.Sets the filepath. The path is automatically added in front of all filenamesSets the list of PHP Soucecode Files to examine.Array of doc container fields that get mapped directly to templateblocks.Sets a directory path prefix.Sets the target path for the generated xml documents.Sets the template directory.Adds a list of subclasses to the generated xml.Adds <see> container to the xml document.Attributes of the <see> container.Strips all values out of the xml_parse_intro_struct() values array with the type "open".Values array from xml_parse_into_struct().Adds an open (or single) xml tag to the generated xml.Sets the output flag - if set to true out() and outl() print messagesPrint a certain block with all replacements done.Sets a variable value.Sets the name of the current block that is the block where variables are added.Sets the template.Sets the file root. The file root gets prefixed to all filenames passed to the object.Adds inherited functions, variables, constants or included files to a class.Starts the analysing of the raw parsing data.Starts the analysing of the raw parsing data.Starts the analysing of the raw parsing data.Adds a suffix to the number like 1st, 2nd and 3thName of the application parsedDefault applicationname for the generated HTML files.Appends a string to a file.Adds a class to the index lists (elements, packages, classtree).Analyses the given file and adds the result to the class list.Adds a module to the index lists (elements, packages, classtree).Analyses the given file and adds the result to the module list.Adds an element to the elementlist.Adds recursively subclasses to the specified class.Analyse a classAnalyses a class doc comment.Analyses a function doc comment.Analyses a variable doc commentCentral module parsing function.Extracts the allowed documentation tags out of a module doc comment.Scans the given constant doc comment.Takes the result from getPhpdocParagraphs() and interprets it.Extract the value from the given tags and copy the data to the $data array if its an allowed tagHelperfunction to analyse see tagsArray of access modifiers.Adds a classtree to the classtree summary template.Renders a modulegroup xml file.Adds file with warnings to the warning list.XML data accessor object.Adds a warning to the list of class documentation failures.Adds <author> container to the xml document.Attributes of the <author> container.Appends some values to an arrayAdds xml to the generated xml.Adds a complete xml container to the generated xml document.Adds a block to the template changing a variable placeholder to a block placeholder.Adds a block taken from a file to the template changing a variable placeholder to a block placeholder.Updates certain elements that use brother and sister.Updates access and return for certain elements.Updates access and return for certain elements.Updates access tags.Updates access tags.Handles brother and sister.Handles brother and sister.Handles brother and sister.Updates the access and return tag values.Updates the access and return tag values.Updates the access and return tag values.Puuuh - findUndocumented() needs this.Puuuh - findUndocumented() needs this.List of allowed tags in use doc comments.Message displayed if an object lacks documentation.Array of included files.Types of include statements.Adds a list of used files (include, require...) to the xml document.Attribues of the <uses> container.Updates the variable list of a block.List of not inherited elements.Counter containing the number of documentation warnings.Encodes an element name so that it can be used as a file name.List of all elements of a certain class/module.Array of all elements (functions, variables, constant, included files, classes, packages).Array of fields that get added to the elementlistDefault values of a classInternal structur of a function.Array with default values of a variableEmpty hash that shows the structure of a module.Internal structure use to save a constant.Structure of an empty use entry.Strips "/xx", "x/" and x from doc comments (x means asterix).Encodes the given string.Exports a modulegroup.Exports a packagelistExports a classtreeExports a list of all elementsElement tag attributes.Exports the given result array as xml document.Saves the xml to the specified file.Adds a closing xml tag to the generated xml document.Variable containing the latest exceptions.Contains the error objectsError message prefix.Error prepend, used for HTML formatting.Error append, used for HTML formatting.Array that describes how an error gets handled.Renders the PHPDoc XML files as HTML filesRenders the given xml file.Renders a class.Renders a list of inherited elements.Renders a list of a certain inherited element.Renders a list of direct known subclasses.Adds a summary and a detailed list of all variables to the template.Adds a summary of all variables to the template.Adds a detailed list of all variables to the template.Renders a moduleAdds a summary and a detailed list of all constants to the template.Adds a summary of all constants to the template.Adds a detailed list of all constants to the template.Adds a summary and a detailed list of included files to the template.Adds a detailed list of all included files to the template.Adds a summary of all included files to the template.Adds a summary and a detailed list of all functions to the template.Adds a function summary to the template.Adds a detailed list of functions to the template.Renders a detailed list of function parameters.Renders a block with references to other source elements.Renders an author list.Renders a list of external links.Renders a list of exceptions.Renders a list of global elements.Adds some tags to the template that are allowed nearly everywhere.Renders the element index list.Renders a complete packagelist.Renders files for the lower left frame with the elements of a certain file.Renders a Packagesummary for the frameset.Adds <return> container to the xml document.Attributes of the <return> container.Data to save as a xml document.Replaces an existing block with new content. Warning: not implemented yet.Replaces an existing block with new content from a file. Warning: not implemented yet.Controls the handling of unknown variables, default is remove.Controls the handling of empty blocks, default is remove.Name of the target directory.Suffix for all rendered files in the application (except for the xml files).IntegratedTemplate Object used be renderClasstree()Template objectRootpath for Templatefiles.Adds <throws> container to the xml document.Content of the template.Handle the command line valuesCall die() on warning?Error Handling function.Call die() on error?Message explaining the usage of phpdoc on the command line.Basis regular expressions used to compose complex expressions to grep doc comments.List of regular expressions used to grep complex doc comments.Array of tags that are allowed in front of the var keywordArray of variables found in the xml document.Adds class variables to the XMl document.Variable container attributes.RegExp matching a variable placeholder in the template.Full RegExp used to find variable placeholder, filled by the constructor.Variable cache.Array of RegExp matching the syntax of several complex tags.Print a string and flushes the output bufferPrint a string, the specified HTML line break sign and flushes the output bufferFirst character of a variable placeholder ( _{_VARIABLE} ).Integrated Template Extension - ITXBuilds some complex regexps and calls the constructor of the parent class.Integrated Template - ITBuilds some complex regular expressions and optinally sets the file root directory.