-
$category
-
category of the {@id}
-
$category
-
-
$category
-
-
$category
-
peardoc2 Category
-
$category
-
-
$category
-
peardoc2 Category
-
$children
-
links to the child tutorials, or false if none
-
$class
-
set to a classname if currently parsing a class, false if not
-
$class
-
-
$class
-
-
$class
-
name of current class being converted
-
$class
-
name of current class being converted
-
$class
-
-
$class
-
-
$classelements
-
array of parsed class elements
-
$classes
-
All class information, organized by path, and by package
-
$classes
-
used to keep track of inheritance at the smartest level possible for a
-
$classpackage_pagenums
-
-
$class_contents
-
alphabetical index of all methods and vars in a class by package/subpackage
-
$class_data
-
template for the class currently being processed
-
$class_data
-
template for the class currently being processed
-
$class_data
-
template for the class currently being processed
-
$class_dir
-
output directory for the current class being processed
-
$class_dir
-
output directory for the current class being processed
-
$class_dir
-
output directory for the current class being processed
-
$class_dir
-
output directory for the current class being processed
-
$class_dir
-
output directory for the current class being processed
-
$class_elements
-
alphabetized index of classes by package
-
$clean
-
-
$conflicts
-
-
$context
-
-
$converted_returnType
-
contains a link to the documentation for a class passed as a type in @return, @var or @param
-
$converter
-
-
$converters
-
an array of template names indexed by converter name
-
$curclasspackage
-
-
$curfile
-
full path of the current file being converted
-
$curfile
-
-
$curfile
-
file being parsed, used in every add function to match up elements with the file that contains them
-
$curfile
-
-
$curpage
-
current procedural page being processed
-
$curpagepackage
-
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
$cur_class
-
Name of the class currently being parsed.
-
canSource
-
Tells the DocBlock it can have a @filesource tag
-
cantSource
-
Tells the DocBlock it can't have a @filesource tag
-
categoryTagHandler
-
handles @category
-
changeGlobal
-
-
changeParam
-
-
changeStatic
-
-
checkEventPop
-
This function checks whether parameter $word is a token for popping the current event off of the Event Stack.
-
checkEventPop
-
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
-
checkEventPop
-
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
-
checkEventPush
-
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
-
checkEventPush
-
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
-
checkEventPush
-
This function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
-
checkForBugCondition
-
Crash in case of known, dangerous bug condition
-
checkIgnore
-
Tell whether to ignore a file or a directory allows * and ? wildcards
-
checkIgnoreTag
-
-
checkState
-
Compare parserStringWithInlineTags::Convert() cache state to $state
-
CHMdefaultConverter
-
sets $base_dir to $targetDir
-
CHMdefaultConverter
-
Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)
-
ClasselementCmp
-
-
Classes
-
Intermediate class parsing structure.
-
classLink
-
class link
-
cleanup
-
Finish up parsing/cleanup directories
-
concatTokens
-
Utility function to convert a series of tokens into a string
-
configWordParser
-
Give the word parser necessary data to begin a new parse
-
configWordParser
-
Tell the parser's WordParser $wp to set up tokens to parse words by.
-
configWordParser
-
tell the parser's WordParser $wp to set up tokens to parse words by.
-
configWordParser
-
tell the parser's WordParser $wp to set up tokens to parse words by.
-
constLink
-
class constant link
-
Convert
-
converter
-
Convert
-
converter method
-
Convert
-
convert part of the tag
-
Convert
-
Interface to the Converter
-
Convert
-
convert the tag
-
Convert
-
calls the output conversion
-
Convert
-
calls the output conversion
-
Convert
-
calls the output conversion
-
Convert
-
only sets a warning and returns empty
-
Convert
-
calls the output conversion
-
Convert
-
performs the conversion of sample tags
-
Convert
-
performs the conversion of keyboard tags
-
Convert
-
Use to convert the string to a real string with all inline tags parsed and linked
-
Convert
-
performs the conversion of list tags
-
Convert
-
performs the conversion of code tags
-
Convert
-
Return a link to the highlighted source and generate the source
-
Convert
-
process this tag through the given output converter
-
Convert
-
performs the conversion of variable tags
-
Convert
-
performs the conversion of code tags
-
Convert
-
Convert all elements to output format
-
Convert
-
-
Convert
-
-
Convert
-
performs the conversion of bold tags
-
Convert
-
performs the conversion of linebreak tags
-
Convert
-
process this tag through the given output converter
-
Convert
-
performs the conversion of italic tags
-
Convert
-
process this tag through the given output converter
-
Convert
-
Return a link to documentation for other element, and description of how it is used
-
Convert
-
process this tag through the given output converter (sets up the $converted_returnType)
-
Convert
-
-
Convert
-
process this tag through the given output converter
-
Convert
-
process this tag through the given output converter
-
convertClass
-
-
convertClass
-
Converts class for template output
-
convertClass
-
Default Class Handler
-
convertClass
-
Converts class for template output
-
convertClass
-
Converts class for template output
-
convertClass
-
Converts class for template output
-
convertClass
-
Converts class for template output
-
convertConst
-
Converts class constants for template output
-
convertConst
-
-
convertConst
-
Converts class constants for template output.
-
convertConst
-
Converts class variables for template output
-
convertConst
-
Converts class variables for template output
-
convertDefine
-
-
convertDefine
-
Converts defines for template output
-
convertDefine
-
Converts defines for template output
-
convertDefine
-
Converts defines for template output
-
convertDefine
-
Converts defines for template output
-
convertDefine
-
Converts defines for template output
-
convertDefine
-
Converts defines for template output
-
convertDocBlock
-
-
Converter
-
Base class for all output converters.
-
Converter
-
Initialize Converter data structures
-
ConvertErrorLog
-
Create errors.html template file output
-
ConvertErrorLog
-
Create errors.html template file output
-
ConvertErrorLog
-
Create errors.html template file output
-
ConvertErrorLog
-
Create errors.html template file output
-
ConvertErrorLog
-
Create errors.html template file output
-
ConvertErrorLog
-
Convert the phpDocumentor parsing/conversion error log
-
convertFunction
-
Converts function for template output
-
convertFunction
-
Converts function for template output
-
convertFunction
-
Converts function for template output - does nothing in peardoc2!
-
convertFunction
-
-
convertFunction
-
Converts function for template output
-
convertFunction
-
Converts function for template output
-
convertFunction
-
Converts function for template output
-
convertGlobal
-
Converts global variables for template output
-
convertGlobal
-
-
convertGlobal
-
Converts global variables for template output
-
convertGlobal
-
Converts global variables for template output
-
convertGlobal
-
Converts global variables for template output
-
convertGlobal
-
Converts global variables for template output
-
convertGlobal
-
Converts global variables for template output
-
convertInclude
-
Converts include elements for template output
-
convertInclude
-
Converts includes for template output
-
convertInclude
-
Converts include elements for template output
-
convertInclude
-
-
convertInclude
-
Converts include elements for template output
-
convertInclude
-
Converts include elements for template output
-
convertInclude
-
Converts include elements for template output
-
convertMethod
-
Converts class methods for template output
-
convertMethod
-
-
convertMethod
-
Converts class methods for template output
-
convertMethod
-
Converts class methods for template output
-
convertMethod
-
Converts method for template output
-
convertMethod
-
Converts method for template output
-
convertMethod
-
Converts method for template output
-
convertPackagepage
-
-
convertPackagePage
-
Does nothing - use tutorials for DocBook
-
convertPackagepage
-
Converts package page and sets its package as used in $package_pages
-
convertPackagePage
-
Converts package page and sets its package as used in $package_pages
-
convertPackagepage
-
Converts package page and sets its package as used in $package_pages
-
convertPackagepage
-
Converts package page and sets its package as used in $package_pages
-
convertPage
-
converts procedural pages for template output
-
convertPage
-
converts procedural pages for template output
-
convertPage
-
converts procedural pages for template output
-
convertPage
-
Default Page Handler
-
convertPage
-
converts procedural pages for template output
-
convertPage
-
converts procedural pages for template output
-
convertPage
-
-
convertParams
-
-
ConvertPart
-
convert part of the tag
-
ConvertSource
-
convert the source code
-
ConvertSource
-
convert the source code
-
ConvertTitle
-
Convert the title of a Tutorial docbook tag section
-
ConvertTodoList
-
-
ConvertTodoList
-
-
ConvertTodoList
-
-
ConvertTodoList
-
Convert the list of all @todo tags
-
convertTutorial
-
-
convertTutorial
-
-
convertTutorial
-
Default Tutorial Handler
-
convertTutorial
-
Convert tutorials for output
-
convertTutorial
-
-
convertTutorial
-
-
convertTutorial
-
-
convertVar
-
Converts class variables for template output.
-
convertVar
-
Converts class variables for template output
-
convertVar
-
Converts class variables for template output.
-
convertVar
-
Converts class variables for template output
-
convertVar
-
Does nothing in this converter
-
convertVar
-
-
convertVar
-
Converts class variables for template output
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
copyFile
-
Copies a file from the template directory to the target directory
-
copyMediaRecursively
-
-
copyMediaRecursively
-
-
copyMediaRecursively
-
-
createDocs
-
-
createParentDir
-
Recursively creates all subdirectories that don't exist in the $dir path
-
config.php
-
-
Classes.inc
-
-
clone.inc.php
-
-
clone5.inc.php
-
-
common.inc.php
-
-
Converter.inc
-
-
CHMdefaultConverter.inc
-
-
class.phpdocpdf.php
-
-
$globalconflicts
-
Namespace conflicts within all documented packages of functions
-
$globals
-
global declarations parsed from function definition
-
$globalsbyfile
-
array of parsed global variables organized by the full path of the file that contains the global variable definition.
-
$globalsbynamefile
-
array of file names organized by global variables that are in the file.
-
$global_elements
-
alphabetized index of global variables by package
-
generateChildClassList
-
returns a list of child classes
-
generateChildClassList
-
returns a list of child classes
-
generateElementIndex
-
does nothing
-
generateElementIndex
-
Generate alphabetical index of all elements
-
generateElementIndex
-
Generate alphabetical index of all elements
-
generateElementIndex
-
Generate alphabetical index of all elements
-
generateElementIndex
-
Generate alphabetical index of all elements
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class.
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedInterfaceTrees
-
returns a template-enabled array of interface inheritance trees
-
generateFormattedInterfaceTrees
-
returns a template-enabled array of interface inheritance trees
-
generateFormattedInterfaceTrees
-
returns a template-enabled array of interface inheritance trees
-
generateFormattedInterfaceTrees
-
returns a template-enabled array of interface inheritance trees
-
generateKLinks
-
Get the table of contents for index.hhk
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndexes
-
-
generatePkgElementIndexes
-
-
generatePkgElementIndexes
-
-
generatePkgElementIndexes
-
-
generatePkgElementIndexes
-
-
generateTOC
-
-
getAllFiles
-
Take a filename with wildcards and return all files that match the
-
getBase
-
Retrieve common directory (case-insensitive in windows)
-
getBlock
-
Unused
-
getCData
-
-
getCData
-
-
getCData
-
-
getCData
-
-
getCData
-
-
getCData
-
-
getChildClassList
-
returns a list of all child classes of this class
-
getClass
-
Get the parserClass representation of a class from its name and file
-
getClass
-
Retrieve the class name
-
getClass
-
Retrieve the class name
-
getClass
-
Return name of the class that contains this method
-
getClassByPackage
-
Search for a class in a package
-
getClassContents
-
-
getClasses
-
returns a list of all classes declared in a file
-
getClassesInPath
-
-
getClassesOnPage
-
gets a list of all classes declared on a procedural page represented by
-
getClassLeft
-
-
getClassLink
-
-
getClassLink
-
-
getClassLink
-
-
getClassLink
-
-
getClassLink
-
-
getClassLink
-
-
getClassLink
-
-
getColor
-
This really should be in the parent class
-
getConflicts
-
Returns all classes in other packages that have the same name as this class
-
getConflicts
-
Returns all global variables in other packages that have the same name as this global variable
-
getConflicts
-
Returns all defines in other packages that have the same name as this define
-
getConflicts
-
Returns all functions in other packages that have the same name as this function
-
getConflicts
-
If a package contains two classes with the same name, this function finds that conflict
-
getConstLink
-
-
getConstLink
-
-
getConstLink
-
-
getConstLink
-
return false or a
constLink to $expr in $class
-
getConstLink
-
-
getConstNames
-
-
getConsts
-
-
getConverterDir
-
Get the absolute path to the converter's base directory
-
getCurrentPageLink
-
-
getCurrentPageLink
-
-
getCurrentPageLink
-
-
getCurrentPageLink
-
-
getCurrentPageURL
-
Return the path to the current
-
getDataType
-
Retrieve converter-specific representation of the data type
-
getDefineLink
-
-
getDefineLink
-
-
getDefineLink
-
-
getDefineLink
-
-
getDefineLink
-
-
getDefineLink
-
-
getDefineLink
-
-
getDefiniteChildren
-
Get all classes confirmed in parsing to be descended class $parclass in file $file
-
getDesc
-
-
getDescription
-
Get the description of how the element used is being used.
-
getDir
-
-
getDirTree
-
-
getEndLineNumber
-
-
getEndLineNumber
-
Retrieve ending line number
-
getEvent
-
Get the current event
-
getExampleLink
-
-
getExampleLink
-
-
getExampleLink
-
-
getExampleLink
-
-
getExampleLink
-
-
getExplicitCategory
-
If the DocBlock has a @category tag, then this returns true
-
getExplicitPackage
-
If the DocBlock has a @package tag, then this returns true
-
getExtends
-
-
getFile
-
-
getFile
-
gets the file name
-
getFileSource
-
gets the source code tokens
-
getFileSourceName
-
Translate the path info into a unique file name for the highlighted source code.
-
getFileSourceName
-
-
getFileSourcePath
-
Return the fixed path to the source-code file folder.
-
getFormattedConflicts
-
-
getFormattedDescMethods
-
Get a list of methods in child classes that override this method
-
getFormattedDescVars
-
Get a list of vars in child classes that override this var
-
getFormattedImplements
-
returns an array containing the class inheritance tree from the root object to the class.
-
getFormattedInheritedConsts
-
Return template-enabled list of inherited class constants
-
getFormattedInheritedMethods
-
Return template-enabled list of inherited methods
-
getFormattedInheritedVars
-
Return template-enabled list of inherited variables
-
getFormattedMethodImplements
-
Get the method this method(s) implemented from an interface, if any
-
getFormattedOverrides
-
Get the method this method overrides, if any
-
getFunctionCall
-
Get a human-friendly description of the function call
-
getFunctionCall
-
adds "constructor " to start of function call if $isConstructor is true
-
getFunctionLink
-
-
getFunctionLink
-
-
getFunctionLink
-
-
getFunctionLink
-
-
getFunctionLink
-
-
getFunctionLink
-
-
getFunctionLink
-
-
getGlobalLink
-
-
getGlobalLink
-
-
getGlobalLink
-
-
getGlobalLink
-
-
getGlobalLink
-
-
getGlobalLink
-
-
getGlobalLink
-
-
getGlobalValue
-
Parse a global variable's default value for class initialization.
-
getGlobalValue
-
-
getHighlightState
-
-
getId
-
Get the id value needed to allow linking
-
getId
-
-
getId
-
-
getId
-
-
getId
-
Get the id value needed to allow linking
-
getId
-
-
getId
-
Return converter-specific formatting of ID.
-
getImplements
-
-
getImplements
-
-
getIncludeValue
-
Parse an include's file to see if it is a file documented in this project
-
getIndexInformation
-
Generate indexing information for given element
-
getIndexInformation
-
Generate indexing information for given element
-
getIndexInformation
-
Generate indexing information for given element
-
getInheritedConsts
-
-
getInheritedMethods
-
-
getInheritedVars
-
-
getIntricateFunctionCall
-
-
getIntricateFunctionCall
-
Like getFunctionCall(), but has no English or pre-determined formatting.
-
getKeyword
-
-
getLineNumber
-
-
getLineNumber
-
Retrieve starting line number
-
getLink
-
Get a link to this tutorial, or to any subsection of this tutorial
-
getLink
-
quick way to link to this element
-
getLink
-
quick way to link to this element
-
getLink
-
quick way to link to this element
-
getLink
-
quick way to link to this element
-
getLink
-
quick way to link to this element
-
getLink
-
quick way to link to this element
-
getLink
-
do that stuff in $template_options
-
getLink
-
quick way to link to this element
-
getLink
-
returns a link
-
getLink
-
The meat of the @see tag and inline {@link} tag
-
getLink
-
do that stuff in $template_options
-
getMethod
-
-
getMethodLink
-
-
getMethodLink
-
-
getMethodLink
-
-
getMethodLink
-
-
getMethodLink
-
-
getMethodLink
-
-
getMethodLink
-
-
getMethodNames
-
-
getMethods
-
-
getModifiers
-
Return a list of access modifiers (static/private/etc.)
-
getModifiers
-
Return name of the class that contains this method
-
getModifiers
-
Get the PHP5+ modifiers for this class
-
getName
-
-
getName
-
Get the output-safe filename (. changed to _)
-
getName
-
gets the name
-
getNext
-
Retrieve converter-specific link to the next tutorial's documentation
-
getOverrides
-
-
getOverrides
-
-
getOverridingMethods
-
-
getOverridingMethodsForClass
-
-
getOverridingVars
-
-
getOverridingVarsForClass
-
-
getPackage
-
-
getPackageOutput
-
gets the package output array
-
getPageContents
-
-
getPageLeft
-
-
getPageLink
-
-
getPageLink
-
-
getPageLink
-
-
getPageLink
-
-
getPageLink
-
-
getPageLink
-
-
getPageLink
-
-
getPageName
-
-
getPageName
-
-
getPageName
-
-
getPageName
-
-
getPageName
-
-
getPageName
-
-
getParam
-
-
getParent
-
retrieve object that represents the parent class
-
getParent
-
Retrieve converter-specific link to the parent tutorial's documentation
-
getParentClass
-
Find the parent class of a class in file $file
-
getParentClassTree
-
-
getParseData
-
Not implemented in this version
-
getParserEventName
-
searches for a parser event name based on its number
-
getParserEventName
-
-
getParserEventName
-
debugging function
-
getParserEventName
-
-
getParserEventName
-
Return the name of the parser event
-
getParserEventName
-
Debugging function, takes an event number and attempts to return its name
-
getPath
-
gets the path
-
getPath
-
-
getPathInfo
-
gathers path-related info about a given element
-
getPos
-
Returns the current pointer position, or 1 character after the end of the word
-
getPrev
-
Retrieve converter-specific link to the previous tutorial's documentation
-
getProgramListing
-
Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial
-
getReadmeInstallChangelog
-
-
getRealPath
-
Ensures the path to the file is an absolute path
-
getRegExpableSearchString
-
Converts $s into a string that can be used with preg_match
-
getReturnsReference
-
-
getRoots
-
Get a list of all root classes indexed by package. Used to generate class trees by
Converter
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getSDesc
-
-
getSortedClassTreeFromClass
-
Return a tree of all classes that extend this class
-
getSource
-
loads up next set of source code
-
getSource
-
-
getSource
-
Retrieve source code for the last function/method
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceLink
-
-
getSourceLink
-
-
getSourceLink
-
-
getSourceLink
-
gets path to the sourcecode file
-
getSourceLink
-
-
getSourceLink
-
-
getSourceLink
-
Retrieve a converter-specific link to the example
-
getSourceLocation
-
gets the source location
-
getSourceLocation
-
-
getState
-
-
getState
-
Return parserStringWithInlineTags::Convert() cache state
-
getString
-
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
-
getString
-
No inline tags are possible, returns 'public', 'protected' or 'private'
-
getString
-
Returns the text minus any inline tags
-
getString
-
always gets an empty string
-
getString
-
gets the source string
-
getSubsection
-
Retrieve the contents of a subsection
-
getTitle
-
Retrieve Converter-specific formatting of the title of this element
-
getTitle
-
Retrieve the title of the tutorial, or of any subsection
-
getTOC
-
Retrieve either the table of contents index, or the location that the TOC will go
-
getTutorial
-
If this file has a tutorial associated with it, returns a link to the tutorial.
-
getTutorial
-
Get the associated tutorial for this class, if any
-
getTutorialId
-
-
getTutorialId
-
-
getTutorialId
-
-
getTutorialId
-
Return a converter-specific id to distinguish tutorials and their sections
-
getTutorialId
-
-
getTutorialId
-
-
getTutorialId
-
-
getTutorialLink
-
The meat of the @tutorial tag and inline {@tutorial} tag
-
getTutorialList
-
-
getTutorials
-
Retrieve tutorial subdirectories and their contents from the list of
-
getTutorialTree
-
Get a tree structure representing the hierarchy of tutorials
-
getTutorialTree
-
-
getTutorialTree
-
-
getType
-
gets the tag type
-
getType
-
gets the type
-
getType
-
-
getValue
-
gets the value
-
getVar
-
-
getVarLink
-
-
getVarLink
-
-
getVarLink
-
-
getVarLink
-
return false or a
varLink to $expr in $class
-
getVarLink
-
-
getVarLink
-
-
getVarLink
-
-
getVarNames
-
-
getVars
-
-
getWord
-
Retrieve a token for the phpDocumentorTParser
-
getWord
-
-
getWord
-
Retrieve a token from the token list
-
getWord
-
Retrieve the next token
-
getYPlusOffset
-
-
get_include_path
-
-
globalLink
-
global variable link
-
globalTagHandler
-
handles @global
-
$package
-
package of the {@id}
-
$package
-
-
$package
-
-
$package
-
-
$package
-
-
$package
-
-
$package
-
package name currently being converted
-
$package
-
-
$packagecategories
-
Used to determine the category for tutorials.
-
$packagecategories
-
Packages associated with categories
-
$packagedescrip
-
description of package parsed from @package tag
-
$packageOutput
-
Used to limit output, contains contents of --packageoutput commandline.
-
$packageoutput
-
array of packages to parser and output documentation for, if not all packages should be documented
-
$packages
-
Packages to create documentation for
-
$packagexml
-
Contents of the packagename.xml file are stored in this template variable
-
$package_elements
-
alphabetical index of all elements sorted by package, subpackage, page, and class.
-
$package_output
-
set to value of -po commandline
-
$package_pages
-
array of parsed package pages
-
$package_pages
-
array of converted package page names.
-
$package_pages
-
array of converted package page names.
-
$package_pages
-
array of converted package page names.
-
$package_pages
-
array of converted package page names.
-
$package_pages
-
array of converted package page names.
-
$package_parents
-
Keeps track of packages of classes that have parent classes in another package. Used in automatic linking.
-
$package_parents
-
Hierarchy of packages
-
$page
-
name of current page being converted
-
$page
-
name of current page being converted
-
$page
-
name of current page being converted
-
$pageclasspackages
-
array of packages assigned to classes in a file, ordered by fullpath
-
$pageconflicts
-
Namespace conflicts within all documented pages
-
$pagepackages
-
array of packages ordered by full path
-
$pagepackage_pagenums
-
-
$pages
-
-
$pages
-
array of all procedural pages ordered by name
-
$page_contents
-
alphabetical index of all elements on a page by package/subpackage
-
$page_data
-
template for the procedural page currently being processed
-
$page_data
-
template for the procedural page currently being processed
-
$page_data
-
template for the procedural page currently being processed
-
$page_dir
-
output directory for the current procedural page being processed
-
$page_dir
-
output directory for the current procedural page being processed
-
$page_dir
-
output directory for the current procedural page being processed
-
$page_dir
-
output directory for the current procedural page being processed
-
$page_dir
-
output directory for the current procedural page being processed
-
$page_elements
-
alphabetized index of procedural pages by package
-
$params
-
array of param data.
-
$params
-
parameters parsed from function definition.
-
$parent
-
parserPage element that is this parserData's parent, or false if not set.
-
$parent
-
Format: array(file, parent) where parent class is found or false if no parent
-
$parent
-
link to the parent tutorial in a document series, or false if none
-
$pars
-
-
$parse
-
The main parser
-
$parseprivate
-
controls processing of elements marked private with @access private
-
$parsePrivate
-
set in
Setup.inc.php to the value of the parseprivate commandline
-
$parserVersion
-
-
$path
-
-
$path
-
path to the tutorial page
-
$path
-
full path location of this element (filename)
-
$path
-
path of current page being converted
-
$path
-
path of current page being converted
-
$path
-
path of current page being converted
-
$path
-
-
$path
-
-
$pathpages
-
array of all procedural page names ordered by full path to the file
-
$pdf
-
-
$phpDocOptions
-
Holds all the options that are avaible to the cmd line interface
-
$phpDocumentor_DefaultCategoryName
-
default package name, set using -dn --defaultcategoryname
-
$phpDocumentor_DefaultPackageName
-
default package name, set using -dn --defaultpackagename
-
$phpDocumentor_errors
-
-
$phpDocumentor_error_descrip
-
Error messages for phpDocumentor parser errors
-
$phpDocumentor_warning_descrip
-
Error messages for phpDocumentor parser warnings
-
$pkg_elements
-
alphabetical index of all elements, indexed by package/subpackage
-
$popEvent
-
-
$prev
-
link to the previous tutorial in a document series, or false if none
-
$privateclasselements
-
array of parsed class elements with @access private
-
$privateelements
-
array of parsed elements with @access private
-
$privatepages
-
Put away a page that has been @ignored or @access private if !$parsePrivate
-
$private_class
-
this variable is used to prevent parsing of elements with an @ignore tag
-
$proceduralpages
-
used to keep track of all elements in a procedural page. Handles name
-
$processed_desc
-
-
$processed_sdesc
-
-
$processSpecialRoots
-
This converter knows about the new root tree processing
-
$processSpecialRoots
-
This converter knows about the new root tree processing
-
$processSpecialRoots
-
This converter knows about the new root tree processing
-
$processSpecialRoots
-
This converter knows about the new root tree processing
-
$properties
-
-
$pushEvent
-
-
packageTagHandler
-
handles @package
-
pageLink
-
procedural page link
-
paramTagHandler
-
handles @param
-
parse
-
Parse a new file
-
parse
-
Parse a new file
-
parse
-
Parse a long or short description for tags
-
parse
-
Parse a new file
-
parse
-
Parse a new file
-
parse
-
Parse a new file
-
parse
-
Parse a new file
-
parse
-
Parse text for PDFParser XML tags, and add the text to the PDF file
-
parseArgv
-
Parses $_SERVER['argv'] and creates a setup array
-
parseHiddenFiles
-
-
parseIni
-
Parse configuration file phpDocumentor.ini
-
parsePackagePage
-
Backward-compatibility only, use the new tutorials for more power
-
Parser
-
Set up invariant parsing variables
-
Parser
-
PHP Parser for PHP 4.2.3-
-
parserAccessTag
-
This class represents the @access tag
-
parserAccessTag
-
checks $value to make sure it is private, protected or public, otherwise it's not a valid @access tag
-
parserB
-
Used for <b> in a description
-
parserBase
-
Base class for all elements
-
parserBr
-
Used for <br> in a description
-
parserCData
-
Represents <![CDATA[ ]]> sections.
-
parserClass
-
-
parserCode
-
Used for <code> in a description
-
parserConst
-
-
parserConst
-
-
parserData
-
-
parserDefine
-
-
parserDesc
-
-
parserDescParser
-
Parses a DocBlock description to retrieve abstract representations of
-
parserDescParser
-
-
parserDescVar
-
Used for <var> in a description
-
parserDocBlock
-
Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions
-
parserDocBlock
-
sets package to default
-
parserElement
-
-
parserEntity
-
sets up the entity
-
parserEntity
-
a standard entity like ”
-
parserExampleInlineTag
-
Represents the example inline tag, used to display an example file inside a docblock or tutorial
-
parserExampleInlineTag
-
constructor
-
parserExampleTag
-
Reads and parses the example file indicated
-
parserExampleTag
-
represents "@example"
-
parserFileSourceTag
-
Set $source to $value, and set up path
-
parserFileSourceTag
-
represents "@filesource"
-
parserFunction
-
-
parserGlobal
-
-
parserI
-
Used for <i> in a description
-
parserIdInlineTag
-
Represents the inline {@id} tag for tutorials
-
parserIdInlineTag
-
constructor
-
parserInclude
-
-
parserInheritdocInlineTag
-
Represents the inheritdoc inline tag, used by classes/methods/vars to inherit documentation from the parent class if possible
-
parserInheritdocInlineTag
-
Does nothing, overrides parent constructor
-
parserInlineTag
-
sets up the tag
-
parserInlineTag
-
Use this element to represent an {@inline tag} like {@link}
-
parserKbd
-
Used for <kbd> in a description
-
parserLicenseTag
-
set up the license tag
-
parserLicenseTag
-
represents the "@see" tag
-
parserLinkInlineTag
-
sets up the tag
-
parserLinkInlineTag
-
represents inline links
-
parserLinkTag
-
sets up the link tag
-
parserLinkTag
-
represents the "@link" tag
-
parserList
-
Used for lists <ol> and <ul>
-
parserList
-
Constructor - create a new list
-
parserMethod
-
-
parserMethod
-
-
parserMethodTag
-
represents the "@method" tag
-
parserNameTag
-
This class represents the @name tag
-
parserNameTag
-
set up the name tag
-
parserPackagePage
-
-
parserPackagePage
-
-
parserPage
-
Contains information about a PHP file, used to group procedural elements together.
-
parserPage
-
sets package to default package
-
parserParamTag
-
represents the "@param" tag
-
parserPre
-
Used for <pre> in a description
-
parserPropertyReadTag
-
represents the "@property-read" tag
-
parserPropertyTag
-
represents the "@property" tag
-
parserPropertyTag
-
set up the property tag
-
parserPropertyWriteTag
-
represents the "@property-write" tag
-
parserReturnTag
-
set up the tag
-
parserReturnTag
-
represents the "@return" tag
-
parserSamp
-
Used for <samp> in a description
-
parserSeeTag
-
sets up the see tag
-
parserSeeTag
-
represents the "@see" tag
-
parserSourceInlineTag
-
represents inline source tag, used for function/method source
-
parserSourceInlineTag
-
constructor
-
parserStaticvarTag
-
represents the "@staticvar" tag
-
parserStringWithInlineTags
-
Used to represent strings that contain inline tags, so that they can be properly parsed at link time
-
parserTag
-
used to represent standard tags like @access, etc.
-
parserTag
-
Set up the tag
-
parserTocInlineTag
-
Represents {@toc} for table of contents generation in tutorials
-
parserTocInlineTag
-
constructor
-
parserTutorial
-
-
parserTutorial
-
-
parserTutorialInlineTag
-
constructor
-
parserTutorialInlineTag
-
Represents inline links to external tutorial documentation
-
parserTutorialTag
-
represents "@tutorial"
-
parserUsedByTag
-
set up the usedby tag
-
parserUsedByTag
-
This is a virtual tag, it is created by @uses to cross-reference the used element
-
parserUsesTag
-
set up the uses tag
-
parserUsesTag
-
represents the "@uses" tag
-
parserVar
-
-
parserVar
-
-
parserVarTag
-
represents the "@var" tag
-
parserXMLDocBookTag
-
a standard XML DocBook Tag
-
parserXMLDocBookTag
-
sets up the tag
-
PARSER_EVENT_ACCESS_MODIFIER
-
used when parsing an access modifier
-
PARSER_EVENT_ARRAY
-
used when an array definition is encountered in parsing
-
PARSER_EVENT_CLASS
-
used when a class definition is encountered in parsing
-
PARSER_EVENT_CLASS_CONSTANT
-
used when a class implements interfaces
-
PARSER_EVENT_CLASS_MEMBER
-
used by the HighlightParser only, when ->var or ->function() is encountered in a method
-
PARSER_EVENT_COMMENT
-
used when short comment // is encountered in parsing
-
PARSER_EVENT_COMMENTBLOCK
-
used when long comment /x x/ where x is an asterisk is encountered in parsing
-
PARSER_EVENT_DEFINE
-
used when a define statement is encountered in parsing
-
PARSER_EVENT_DEFINE_GLOBAL
-
used when parsing a global variable declaration
-
PARSER_EVENT_DEFINE_PARAMS
-
used when a define statement opening parenthesis is encountered in parsing
-
PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS
-
used when a define statement's opening parenthesis is encountered in parsing
-
PARSER_EVENT_DESC
-
used when parsing the desc part of a docblock
-
PARSER_EVENT_DOCBLOCK
-
used when a DocBlock is encountered in parsing
-
PARSER_EVENT_DOCBLOCK_TEMPLATE
-
used when encountering a /**#@+ comment marking a new docblock template
-
PARSER_EVENT_DOCKEYWORD
-
used when a @tag is encountered in DocBlock parsing
-
PARSER_EVENT_DOCKEYWORD_EMAIL
-
used when a <email@address> is encountered in parsing an @author tag
-
PARSER_EVENT_END_DOCBLOCK_TEMPLATE
-
used when encountering a /**#@-* / comment (no space) marking the end of using a docblock template
-
PARSER_EVENT_END_STATEMENT
-
-
PARSER_EVENT_EOFQUOTE
-
used when a <<< is encountered in parsing
-
PARSER_EVENT_ESCAPE
-
used when a backslash is encountered in parsing a string or other escapable entity
-
PARSER_EVENT_FUNCTION
-
used when a function definition is encountered in parsing
-
PARSER_EVENT_FUNCTION_PARAMS
-
used when a function statement opening parenthesis is encountered in parsing
-
PARSER_EVENT_FUNCTION_PARAM_VAR
-
used when a $param is encountered in a function definition
-
PARSER_EVENT_FUNC_GLOBAL
-
used when parsing a "global $var1, $var2;" declaration in a function
-
PARSER_EVENT_GLOBAL_VALUE
-
used when parsing the default value in a global variable declaration
-
PARSER_EVENT_IMPLEMENTS
-
used when a class implements interfaces
-
PARSER_EVENT_INCLUDE
-
used when an include/require/include_once/include_once statement is encountered in parsing
-
PARSER_EVENT_INCLUDE_PARAMS
-
used when an opening parenthesis of an include/require/include_once/include_once statement is encountered in parsing
-
PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS
-
used when an inner ( ) is encountered while parsing an include/require/include_once/include_once statement
-
PARSER_EVENT_INLINE_DOCKEYWORD
-
used when an inline {@tag} is encountered in parsing a DocBlock
-
PARSER_EVENT_LOGICBLOCK
-
{ encountered in parsing a function or php code
-
PARSER_EVENT_METHOD
-
used by the HighlightParser only, when a method starts
-
PARSER_EVENT_METHOD_LOGICBLOCK
-
used by the HighlightParser only, when a method body is parsed
-
PARSER_EVENT_NOEVENTS
-
used for the beginning of parsing, before first < ? php encountered
-
PARSER_EVENT_OUTPHP
-
used when a ? > (with no space) is encountered in parsing
-
PARSER_EVENT_PHPCODE
-
used when php code processor instruction (< ? php) is encountered in parsing
-
PARSER_EVENT_QUOTE
-
used when double quotation mark (") encountered in parsing
-
PARSER_EVENT_QUOTE_VAR
-
used by the HighlightParser only, when {$var} is encountered in a string
-
PARSER_EVENT_SINGLEQUOTE
-
used when a single quote (') is encountered in parsing
-
PARSER_EVENT_STATIC_VAR
-
used when parsing a "static $var1, $var2;" declaration in a function
-
PARSER_EVENT_STATIC_VAR_VALUE
-
used when parsing the value in a "static $var1 = x" declaration in a function
-
PARSER_EVENT_TAGS
-
used when parsing the @tag block of a docblock
-
PARSER_EVENT_VAR
-
used when a var statement is encountered in parsing a class definition
-
PARSER_EVENT_VAR_ARRAY
-
used when a variable value is an array
-
PARSER_EVENT_VAR_ARRAY_COMMENT
-
used when a comment is found in a variable array value
-
parseString
-
Parse a new file
-
pathMatchesParsedFile
-
checks to see if the parsed file matches the given path
-
PATH_DELIMITER
-
-
PDERROR_ACCESS_WRONG_PARAM
-
warning triggered when the arguments to @access are neither public nor private
-
PDERROR_BEAUTIFYING_FAILED
-
warning triggered by an unterminated entity in a tutorial
-
PDERROR_CANNOT_EXTEND_SELF
-
warning triggered if someone brilliant tries "class X extends X {"
-
PDERROR_CANT_HAVE_INLINE_IN_TAGNAME
-
warning triggered when an inline tag is found inside an xml tag name
-
PDERROR_CANT_NEST_IN_B
-
warning triggered when another tag is nested in <b>
-
PDERROR_CHILD_TUTORIAL_NOT_FOUND
-
warning triggered when a tutorial's child in the .ini file doesn't exist in the
-
PDERROR_CLASS_CONFLICT
-
warning triggered when classes in the same package have the same name
-
PDERROR_CLASS_EXISTS
-
warning triggered when inheritance could be from more than one class
-
PDERROR_CLASS_NOT_IN_PACKAGE
-
warning triggered when a getClassByPackage is called and can't find the class
-
PDERROR_CLASS_PARENT_NOT_FOUND
-
warning triggered when an entire page is ignored because of @access private
-
PDERROR_CONVERTER_NOT_FOUND
-
warning triggered when a converter is passed to
-
PDERROR_CONVERTER_OVR_GFCT
-
warning triggered when a child converter doesn't override
-
PDERROR_DANGEROUS_PHP_BUG_EXISTS
-
warning triggered when the PHP version being used has dangerous bug/behavior
-
PDERROR_DB_TEMPLATE_UNTERMINATED
-
warning triggered when a docblock template is never turned off
-
PDERROR_DOCBLOCK_CONFLICT
-
warning triggered by a page-level docblock preceding a source element
-
PDERROR_DOCBLOCK_GOES_CLASS
-
warning triggered when the first docblock in a file with a @package tag precedes a class. In this case, the class gets the docblock.
-
PDERROR_DUMB_USES
-
warning triggered by improper "@uses blah"
-
PDERROR_ELEMENT_IGNORED
-
warning triggered when a duplicate element is encountered that will be
-
PDERROR_EMPTY_EXAMPLE_TITLE
-
warning triggered by @example path/to/example with no title
-
PDERROR_EXAMPLE_NOT_FOUND
-
warning triggered when an example's path from @example /path/to/example.php
-
PDERROR_FUNCTION_HAS_NONAME
-
warning triggered by a function with no name
-
PDERROR_GLOBAL_NOT_FOUND
-
warning triggered when there are multiple @name tags in a docblock
-
PDERROR_ID_MUST_BE_INLINE
-
warning triggered when an id attribute in a tutorial docbook tag is not
-
PDERROR_IGNORE_TAG_IGNORED
-
warning triggered when an @ignore tag is used in a DocBlock preceding
-
PDERROR_ILLEGAL_PACKAGENAME
-
warning triggered when the package or subpackage name is illegal
-
PDERROR_INHERITANCE_CONFLICT
-
warning triggered when inheritance could be from more than one class
-
PDERROR_INHERITDOC_DONT_WORK_HERE
-
warning triggered by {@inheritdoc} in a non-inheritable situation
-
PDERROR_INLINETAG_IN_SEE
-
warning triggered when an example's path from @example /path/to/example.php
-
PDERROR_INTERNAL_NOT_CLOSED
-
warning triggered when an {@internal}} tag is not closed
-
PDERROR_INVALID_VALUES
-
warning triggered if a command line option does not have a valid value passed in
-
PDERROR_LOOP_RECURSION_LIMIT_REACHED
-
warning triggered when the a loop recursion tripwire has been tripped
-
PDERROR_MALFORMED_GLOBAL_TAG
-
warning triggered when there are multiple @name tags in a docblock
-
PDERROR_MALFORMED_TAG
-
warning triggered by an empty tag
-
PDERROR_MISSING_PROPERTY_TAG_NAME
-
warning triggered when any of {@property}}, {@property-read}},
-
PDERROR_MULTIPLE_ACCESS_TAGS
-
warning triggered when there are multiple @access tags in a docblock
-
PDERROR_MULTIPLE_CATEGORY_TAGS
-
warning triggered by more than 1 @category tag
-
PDERROR_MULTIPLE_GLOBAL_TAGS
-
warning triggered when there are multiple @name tags in a docblock
-
PDERROR_MULTIPLE_NAME_TAGS
-
warning triggered when there are multiple @name tags in a docblock
-
PDERROR_MULTIPLE_PACKAGE_TAGS
-
warning triggered when there are multiple @package tags in a docblock
-
PDERROR_MULTIPLE_PARENT
-
warning triggered when inheritance could be from more than one class
-
PDERROR_MULTIPLE_RETURN_TAGS
-
warning triggered when there are multiple @return tags in a docblock
-
PDERROR_MULTIPLE_SUBPACKAGE_TAGS
-
warning triggered when there are multiple @subpackage tags in a docblock
-
PDERROR_MULTIPLE_VAR_TAGS
-
warning triggered when there are multiple @var tags in a docblock
-
PDERROR_NAME_ALIAS_SAME_AS_TARGET
-
warning triggered when the alias value in an page-level docblock's @name tag
-
PDERROR_NEED_WHITESPACE
-
warning triggered when an entire page is ignored because of @access private
-
PDERROR_NESTED_INTERNAL
-
warning triggered when {@internal}} is nested inside another {@internal}}
-
PDERROR_NOTODO_INCLUDE
-
warning triggered when @todo is used on an include element
-
PDERROR_NO_CONVERTERS
-
warning triggered when a converter is passed to
-
PDERROR_NO_CONVERTER_HANDLER
-
warning triggered when an example's path from @example /path/to/example.php
-
PDERROR_NO_DOCBOOK_ID
-
warning triggered in tutorial parsing if there is a missing {@id} inline tag
-
PDERROR_NO_PACKAGE_TAG
-
warning triggered when no @package tag is used in a page-level
-
PDERROR_NO_PAGE_LEVELDOCBLOCK
-
warning triggered when a file does not contain a page-level docblock
-
PDERROR_OVERRIDDEN_PACKAGE_TAGS
-
warning triggered when there a @package tag is used in a function,
-
PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS
-
warning triggered when there a @subpackage tag is used in a function,
-
PDERROR_PACKAGECAT_SET
-
warning triggered when a package is already associated with a category, and
-
PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE
-
warning triggered when there are multiple @name tags in a docblock
-
PDERROR_PARENT_NOT_FOUND
-
warning triggered when parent class doesn't exist
-
PDERROR_PARSEPRIVATE
-
warning triggered when an entire page is ignored because of @access private
-
PDERROR_PDFFUNCTION_NO_FUNC
-
warning triggered when a <pdffunction:funcname /> tag is used in the PDF
-
PDERROR_PDF_METHOD_DOESNT_EXIST
-
warning triggered when a <pdffunction:funcname /> tag is used in the PDF
-
PDERROR_PDF_TEMPVAR_DOESNT_EXIST
-
warning triggered when a <pdffunction:funcname arg=$tempvar/> tag
-
PDERROR_PRIVATE_ASSUMED
-
warning triggered when no @access private tag is used in a
-
PDERROR_SOURCECODE_IGNORED
-
warning triggered by sourcecode="on", if PHP < 4.3.0
-
PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND
-
warning triggered when a { @source } inline tag is used in a docblock not
-
PDERROR_SOURCE_TAG_IGNORED
-
warning triggered when an {@source} tag is found in a short description
-
PDERROR_TAG_NOT_HANDLED
-
warning triggered by @filesource, if PHP < 4.3.0
-
PDERROR_TEMPLATEDIR_DOESNT_EXIST
-
warning triggered by non-existent template directory
-
PDERROR_TEXT_OUTSIDE_LI
-
warning triggered when text in a docblock list is not contained in
-
PDERROR_TUTORIAL_IS_OWN_CHILD
-
warning triggered when a tutorial lists itself as a child tutorial
-
PDERROR_TUTORIAL_IS_OWN_GRANDPA
-
warning triggered when a tutorial's child lists the parent tutorial
-
PDERROR_TUTORIAL_NOT_FOUND
-
warning triggered when a tutorial is referenced
-
PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND
-
warning triggered when a subsection's title is asked for, but the subsection
-
PDERROR_UL_IN_UL
-
warning triggered if <ul> is nested inside <ul> and not <li>
-
PDERROR_UNCLOSED_TAG
-
warning triggered when a DocBlock html tag is unclosed
-
PDERROR_UNDOCUMENTED_ELEMENT
-
warning triggered when a class or method hasn't got docblock
-
PDERROR_UNKNOWN_COMMANDLINE
-
warning triggered when an entire page is ignored because of @access private
-
PDERROR_UNKNOWN_TAG
-
warning triggered when classes in the same package have the same name
-
PDERROR_UNMATCHED_LIST_TAG
-
warning triggered when a docblock has an unmatched <ol> or <ul>
-
PDERROR_UNMATCHED_TUTORIAL_TAG
-
warning triggered when a docbook tag is not properly matched
-
PDERROR_UNTERMINATED_ATTRIB
-
warning triggered when a subsection's title is asked for, but the subsection
-
PDERROR_UNTERMINATED_ENTITY
-
warning triggered by an unterminated entity in a tutorial
-
PDERROR_UNTERMINATED_INLINE_TAG
-
warning triggered when an {@inline tag} is not terminated
-
PDFdefaultConverter
-
PDF output converter.
-
PDFdefaultConverter
-
-
PDFParser
-
Sets up the wordparser for this class
-
PDFParser
-
-
phpdoc.php
-
-
phpdocpdf
-
-
phpdocpdf
-
-
ParserPDF.inc
-
-
PDFdefaultConverter.inc
-
-
PackagePageElements.inc
-
-
Parser.inc
-
-
ParserData.inc
-
-
ParserDescCleanup.inc
-
-
ParserDocBlock.inc
-
-
ParserElements.inc
-
-
phpdoc.inc
-
-
phpDocumentorTParser.inc
-
-
phpDocumentorTWordParser.inc
-
-
ProceduralPages.inc
-
-
Publisher.inc
-
-
phpDocumentorTParser
-
Tokenizer-based parser for PHP source code
-
phpDocumentorTParser
-
Constructor
-
phpDocumentorTWordParser
-
Like WordParser, but expects an array of tokens from the tokenizer instead of a string.
-
phpDocumentor_clone
-
Clone an object in PHP 4
-
phpDocumentor_ConfigFileList
-
used in phpdoc.php and new_phpdoc.php
-
PHPDOCUMENTOR_EVENT_CLASS
-
Class published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_CONST
-
Class Constant published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_DEFINE
-
Constant (define) published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_DOCBLOCK
-
DocBlock published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE
-
used when a docblock template is encountered in the source
-
PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE
-
used when a docblock template is encountered in the source
-
PHPDOCUMENTOR_EVENT_END_PAGE
-
used to inform phpDocumentor_IntermediateParser that the current file has been completely parsed.
-
PHPDOCUMENTOR_EVENT_FUNCTION
-
Function published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_GLOBAL
-
used when a global variable definition is encountered in the source
-
PHPDOCUMENTOR_EVENT_INCLUDE
-
Include (include/require/include_once/include_once) published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_MESSAGE
-
-
PHPDOCUMENTOR_EVENT_NEWFILE
-
use to inform ErrorTracker of a new file being parsed
-
PHPDOCUMENTOR_EVENT_NEWLINENUM
-
use to inform ErrorTracker of the next line number being parsed
-
PHPDOCUMENTOR_EVENT_NEWSTATE
-
use to inform IntermediateParser of a new element being parsed
-
PHPDOCUMENTOR_EVENT_PACKAGEPAGE
-
Package-level page published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_PAGE
-
New File (page) published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG
-
Contents of README/INSTALL/CHANGELOG files published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_TUTORIAL
-
Tutorial published to IntermediateParser with this event
-
PHPDOCUMENTOR_EVENT_VAR
-
Class Variable published to IntermediateParser with this event
-
phpDocumentor_get_class
-
Returns a lower-cased version of get_class for PHP 5
-
phpDocumentor_HighlightParser
-
Highlights source code using
parse()
-
phpDocumentor_HighlightParser
-
Initialize the $tokenpushEvent, $wordpushEvent arrays
-
phpDocumentor_HighlightWordParser
-
Retrieve tokens from an array of tokens organized by line numbers
-
phpDocumentor_IntermediateParser
-
sets up basic data structures
-
phpDocumentor_IntermediateParser
-
The phpDocumentor_IntermediateParser Class
-
phpDocumentor_out
-
Print parse information if quiet setting is off
-
phpDocumentor_parse_ini_file
-
Parse an .ini file
-
PHPDOCUMENTOR_PDF_EVENT_CONTENT
-
used for parsing stuff between <text>
-
PHPDOCUMENTOR_PDF_EVENT_FONT
-
when <font> is found in an ezText input
-
PHPDOCUMENTOR_PDF_EVENT_NEWPAGE
-
when <newpage/> is found in an ezText input
-
PHPDOCUMENTOR_PDF_EVENT_PDFFUNCTION
-
when <pdffunction> is found in an ezText input
-
PHPDOCUMENTOR_PDF_EVENT_TEXT
-
when <text> is found in an ezText input
-
PHPDOCUMENTOR_PDF_STATE_CONTENT
-
used for parsing stuff between <text>
-
PHPDOCUMENTOR_PDF_STATE_FONT
-
when <font> is found in an ezText input
-
PHPDOCUMENTOR_PDF_STATE_NEWPAGE
-
when <newpage/> is found in an ezText input
-
PHPDOCUMENTOR_PDF_STATE_PDFFUNCTION
-
when <pdffunction> is found in an ezText input
-
PHPDOCUMENTOR_PDF_STATE_TEXT
-
when <text> is found in an ezText input
-
PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES
-
when tag attributes name="value" are found
-
PHPDOCUMENTOR_PDP_EVENT_B
-
when <b> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_BR
-
when <br> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_CDATA
-
when <![CDATA[ ]]> is found
-
PHPDOCUMENTOR_PDP_EVENT_CODE
-
when <code> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_DOUBLECR
-
when \n\n is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_ENTITY
-
when tag attributes name="value" are found
-
PHPDOCUMENTOR_PDP_EVENT_ESCAPE
-
when the << potential escape for tags is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE
-
when << /code>> is found in a <code></code> section
-
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE
-
when << /pre>> is found in a <pre></pre> section
-
PHPDOCUMENTOR_PDP_EVENT_I
-
when <i> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_KBD
-
when <kbd> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_LIST
-
when <ul>/<ol> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_P
-
when <p> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_PRE
-
when <pre> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_PROGRAMLISTING
-
when <programlisting> is found
-
PHPDOCUMENTOR_PDP_EVENT_SAMP
-
when <samp> is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_SIMLIST
-
when a simple list is found in a desc
-
PHPDOCUMENTOR_PDP_EVENT_TAG
-
when a DocBook <tag> is found
-
PHPDOCUMENTOR_PDP_EVENT_VAR
-
when <var> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_ATTRIBUTES
-
when tag attributes name="value" are found
-
PHPDOCUMENTOR_PDP_STATE_B
-
when <b> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_BR
-
when <br> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_CDATA
-
when <![CDATA[ ]]> is found
-
PHPDOCUMENTOR_PDP_STATE_CODE
-
when <code> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_DOUBLECR
-
when \n\n is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_ENTITY
-
when tag attributes name="value" are found
-
PHPDOCUMENTOR_PDP_STATE_ESCAPE
-
when the << potential escape for tags is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE
-
when << /code>> is found in a <code></code> section
-
PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE
-
when << /pre>> is found in a <pre></pre> section
-
PHPDOCUMENTOR_PDP_STATE_I
-
when <i> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_KBD
-
when <kbd> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_LIST
-
when <ul>/<ol> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_P
-
when <p> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_PRE
-
when <pre> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_PROGRAMLISTING
-
when <programlisting> is found
-
PHPDOCUMENTOR_PDP_STATE_SAMP
-
when <samp> is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_SIMLIST
-
when a simple list is found in a desc
-
PHPDOCUMENTOR_PDP_STATE_TAG
-
when a DocBook <tag> is found
-
PHPDOCUMENTOR_PDP_STATE_VAR
-
when <var> is found in a desc
-
phpDocumentor_peardoc2_XML_Beautifier
-
-
phpDocumentor_setup
-
Checks PHP version, makes sure it is 4.2.0+, and chooses the
-
phpDocumentor_setup
-
-
phpDocumentor_TutorialHighlightParser
-
Initialize the $tokenpushEvent, $wordpushEvent arrays
-
phpDocumentor_TutorialHighlightParser
-
Highlights source code using
parse()
-
PHPDOCUMENTOR_VER
-
-
PHPDOCUMENTOR_WEBSITE
-
-
PHPDOCUMENTOR_WINDOWS
-
-
phpDocumentor_XML_Beautifier_Tokenizer
-
Highlights source code using
parse()
-
phpDocumentor_XML_Beautifier_Tokenizer
-
Initialize the $tokenpushEvent, $wordpushEvent arrays
-
PHPDOC_BEAUTIFIER_CDATA
-
do not remove, needed in plain renderer
-
PHPDOC_WEBROOT_DIR
-
-
PHPDOC_XMLTOKEN_EVENT_ATTRIBUTE
-
used when a <tag attr="attribute"> is found
-
PHPDOC_XMLTOKEN_EVENT_CDATA
-
used when a <! is found
-
PHPDOC_XMLTOKEN_EVENT_CLOSETAG
-
used when a close </tag> is found
-
PHPDOC_XMLTOKEN_EVENT_COMMENT
-
used when a <!-- comment --> is found
-
PHPDOC_XMLTOKEN_EVENT_DEF
-
used when a <! is found
-
PHPDOC_XMLTOKEN_EVENT_DOUBLEQUOTE
-
used when a <!-- comment --> is found
-
PHPDOC_XMLTOKEN_EVENT_ENTITY
-
used when an &entity; is found
-
PHPDOC_XMLTOKEN_EVENT_IN_CDATA
-
used when a <![CDATA[ section is found
-
PHPDOC_XMLTOKEN_EVENT_NOEVENTS
-
starting state
-
PHPDOC_XMLTOKEN_EVENT_OPENTAG
-
used when an open <tag> is found
-
PHPDOC_XMLTOKEN_EVENT_PI
-
used when a processor instruction is found
-
PHPDOC_XMLTOKEN_EVENT_SINGLEQUOTE
-
used when a <!-- comment --> is found
-
PHPDOC_XMLTOKEN_EVENT_XML
-
used when a <?xml is found
-
PHPUnit_MAIN_METHOD
-
-
popEvent
-
Pop an event from the stack
-
postProcess
-
-
postProcess
-
Uses htmlspecialchars() on the input
-
postProcess
-
Uses htmlspecialchars() on the input
-
postProcess
-
This version does nothing
-
postProcess
-
-
postProcess
-
Parse out any html tags from doc comments, and make them into
-
postProcess
-
Uses htmlspecialchars() on the input
-
postProcess
-
-
ppageParser
-
set up invariant Parser variables
-
ppageParser
-
Global package page parser
-
prepareDocBlock
-
-
prepareDocBlock
-
convert the element's DocBlock for output
-
prepareDocBlock
-
-
PreserveWhiteSpace
-
Used to convert the contents of <pre> in a docblock
-
ProceduralPages
-
Intermediate procedural page parsing structure.
-
processChild
-
-
ProgramExample
-
Used to convert the <code> tag in a docblock
-
ProgramExample
-
Used to convert the <code> tag in a docblock
-
ProgramExample
-
Used to convert the <code> tag in a docblock
-
ProgramExample
-
-
ProgramExample
-
Used to convert the <code> tag in a docblock
-
propertyTagHandler
-
Handles @property(-read or -write) and @method magic tag
-
Publisher
-
a class for handling the publishing of data
-
publishEvent
-
Publish an event
-
pushEvent
-
Push an event onto the stack
-
ParserClassTests.php
-
-
ParserPageTests.php
-
-
phpDocumentorSetupTests.php
-
-
phpDocumentorTParserTests.php
-
-
$sdesc
-
-
$section
-
-
$setup
-
Used to parse command-line options
-
$set_pageNumbering
-
-
$smarty_dir
-
Directory that the smarty templates are in
-
$smarty_dir
-
-
$sort_absolutely_everything
-
This is used if the content must be passed in the order it should be read, i.e. by package, procedural then classes
-
$sort_absolutely_everything
-
default PDF Converter wants elements sorted by type as well as alphabetically
-
$sort_absolutely_everything
-
Pass elements by package, simplifies generation of package.xml/category.xml
-
$sort_page_contents_by_type
-
This determines whether the $page_contents array should be sorted by element type as well as alphabetically by name
-
$sort_page_contents_by_type
-
XMLDocBookConverter wants elements sorted by type as well as alphabetically
-
$sort_page_contents_by_type
-
XMLDocBookConverter wants elements sorted by type as well as alphabetically
-
$sort_page_contents_by_type
-
Smarty Converter wants elements sorted by type as well as alphabetically
-
$sort_page_contents_by_type
-
CHMdefaultConverter wants elements sorted by type as well as alphabetically
-
$sort_page_contents_by_type
-
Smarty Converter wants elements sorted by type as well as alphabetically
-
$source
-
Tokenized source code of the file
-
$source
-
tokenized source organized by line numbers for php 4.3.0+, the old
-
$source
-
-
$source
-
-
$sourceloc
-
-
$sourceloc
-
-
$sourceLocation
-
-
$sourceLocation
-
relative source location
-
$sourcePaths
-
A list of files that have had source code generated
-
$source_location
-
relative path of the parsed file from the base parse directory
-
$stack
-
The stack
-
$start
-
First line of source code to display
-
$statics
-
array of static variable data.
-
$statics
-
static variable declarations parsed from function definition
-
$subpackage
-
-
$subpackage
-
-
$subpackage
-
-
$subpackage
-
subpackage of the {@id}
-
$subpackage
-
-
$subpackage
-
subpackage name currently being converted
-
$subpackagedescrip
-
description of subpackage parsed from @package tag
-
$subscriber
-
Array of references objects that have Subscribed to this publisher
-
Setup.inc.php
-
-
Sampize
-
Used to convert the contents of <samp> in a docblock
-
setAccessModifiers
-
Use this method to set access modifiers for a class
-
setClassParent
-
Find the parent class of $class, and set up structures to note this fact
-
setColorArray
-
-
setConstructor
-
Use this method to tell the parser that this method is the class constructor
-
setDataType
-
Sets the name of the global variable's type
-
setDesc
-
-
setDestructor
-
Use this method to tell the parser that this method is the class constructor
-
setDirectoriesToParse
-
-
setDocBlock
-
sets the docblock
-
setDocBlock
-
-
setEndLineNumber
-
Sets the ending line number of elements
-
setEndLineNumber
-
Sets the ending line number for the DocBlock
-
setExplicitCategory
-
Used if this docblock has a @category tag.
-
setExplicitPackage
-
Used if this docblock has a @package tag.
-
setExtends
-
-
setFile
-
Sets the name to display in documentation (can be an alias set with @name)
-
setFile
-
-
setFilesToParse
-
-
setHTMLColor
-
-
setId
-
If the id attribute is present, this method will set its id
-
setIgnore
-
-
setInterface
-
Use this method to set the type of class to be an interface
-
setJavadocDesc
-
-
setLineNum
-
Start the parsing at a certain line number
-
setLineNum
-
Start the parsing at a certain line number
-
setLineNumber
-
Sets the starting line number for the DocBlock
-
setLineNumber
-
Set starting line number
-
setMemoryLimit
-
Allow a memory_limit setting in phpDocumentor.ini to override php.ini or default memory limit
-
setModifiers
-
Return name of the class that contains this method
-
setModifiers
-
Return name of the class that contains this method
-
setModifiers
-
Set the PHP5+ modifiers for this class
-
setName
-
sets the name
-
setName
-
Change a page's name from its file to alias $name
-
setName
-
-
setNext
-
-
setPackageOutput
-
loads the package output array
-
setPackageOutput
-
-
setParent
-
sets the parent
-
setParent
-
-
setParent
-
-
setParentNoClass
-
-
setParseBase
-
sets the parser base
-
setParsePrivate
-
-
setParsePrivate
-
set display of elements marked with @access private
-
setPath
-
sets the path to the file
-
setPath
-
set the path
-
setPath
-
-
setPos
-
Set the internal cursor within the source code
-
setPrev
-
-
setQuietMode
-
set parsing information output mode (quiet or verbose)
-
setQuietMode
-
-
setReturnsReference
-
sets $returnsreference to true
-
setSeperator
-
Sets the list of possible separator tokens
-
setShortDesc
-
Set the short description of the DocBlock
-
setSource
-
sets the source tag's value
-
setSource
-
sets the source
-
setSource
-
-
setSource
-
Pass source code to any {@source} tags contained within the string for later conversion.
-
setSource
-
Sets the source code of the file for highlighting.
-
setSourceLocation
-
sets the source location
-
setSourceLocation
-
-
setSourcePaths
-
Mark a file as having had source code highlighted
-
setTargetDir
-
-
setTargetDir
-
Sets the output directory
-
setTargetDir
-
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
-
setTargetDir
-
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
-
setTargetDir
-
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
-
setTargetDir
-
Sets the output directory for generated documentation
-
setTargetDir
-
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
-
setTemplateBase
-
Sets the template base directory
-
setTemplateBase
-
-
setTemplateBase
-
Set the template directory with a different template base directory
-
setTemplateDir
-
sets the template directory based on the $outputformat and $name
-
setTemplateDir
-
-
setTemplateDir
-
-
setTemplateDir
-
-
setTemplateDir
-
-
setTitle
-
-
setTitle
-
Set the title of a DocBook tag section.
-
setTOC
-
set the TOC
-
setTOC
-
sets the TOC value
-
setUndocumentedElementWarnings
-
-
setUndocumentedElementWarningsMode
-
show warnings for undocumented elements
-
setup
-
Set the word parser to go.
-
setup
-
-
setup
-
Initialize the WordParser
-
setup
-
Initialize the parser object
-
setupPagePackages
-
if there is one class package in a file, the parent path inherits the package if its package is default.
-
setupPages
-
Adjusts packages of all pages and removes name conflicts within a package
-
setupStates
-
setup the parser tokens, and the pushEvent/popEvent arrays
-
setupStates
-
Initialize all parser state variables
-
setupStates
-
setup the parser tokens, and the pushEvent/popEvent arrays
-
setupStates
-
setup the parser tokens, and the pushEvent/popEvent arrays
-
setupStates
-
setup the parser tokens, and the pushEvent/popEvent arrays
-
setupStates
-
Initialize all parser state variables
-
setupStates
-
Initialize all parser state variables
-
setupStates
-
set up invariant Parser variables
-
setupTOC
-
-
setup_dirs
-
Recursively move contents of $struc into associative array
-
setValue
-
sets the given value
-
setWhitespace
-
set parser to return or strip whitespace
-
set_dir
-
Recursively add all the subdirectories of $contents to $dir without erasing anything in
-
showImage
-
Allows png's with alpha transparency to be displayed in IE 6
-
SmartyInit
-
-
SmartyInit
-
-
SmartyInit
-
-
SmartyInit
-
-
SMART_PATH_DELIMITER
-
-
sortPageContentsByElementType
-
sorts $page_contents by element type as well as alphabetically
-
sourceLine
-
Return a line of highlighted source code with formatted line number
-
sourceLine
-
Return a line of highlighted source code with formatted line number
-
sourceLine
-
Return a line of highlighted source code with formatted line number
-
sourceLine
-
Return a line of highlighted source code with formatted line number
-
startCData
-
Begin a new CData section
-
startHighlight
-
Initialize highlight caching
-
STATE_ACCESS_MODIFIER
-
currently parsing an access modifier
-
STATE_ARRAY
-
currently parsing an array
-
STATE_CLASS
-
currently parsing a class definition
-
STATE_CLASS_CONSTANT
-
currently parsing a class constant
-
STATE_CLASS_MEMBER
-
currently parsing a class member using the HighlightParser
-
STATE_COMMENT
-
currently parsing a short comment //
-
STATE_COMMENTBLOCK
-
currently parsing a long comment /x x/ where x is an asterisk
-
STATE_DEFINE
-
currently parsing a define statement
-
STATE_DEFINE_PARAMS
-
currently parsing the stuff in ( ) of a define statement
-
STATE_DEFINE_PARAMS_PARENTHESIS
-
currently parsing an inner parenthetical statement of a define( )
-
STATE_DESC
-
currently parsing the desc part of a docblock
-
STATE_DOCBLOCK
-
currently parsing a DocBlock
-
STATE_DOCBLOCK_TEMPLATE
-
currently parsing the value in a "static $var1 = x" declaration in a function
-
STATE_DOCKEYWORD
-
currently parsing a @tag in a DocBlock
-
STATE_DOCKEYWORD_EMAIL
-
currently parsing an email in brackets in an @author tag of a DocBlock
-
STATE_END_CLASS
-
used to tell Render that a class has been completely parsed, and to flush buffers
-
STATE_END_DOCBLOCK_TEMPLATE
-
currently parsing the value in a "static $var1 = x" declaration in a function
-
STATE_EOFQUOTE
-
currently parsing a string defined using Perl <<<
-
STATE_ESCAPE
-
used when a backslash is encountered in parsing a string or other escapable entity
-
STATE_FUNCTION
-
currently parsing a Function or Method
-
STATE_FUNCTION_PARAMS
-
currently parsing the stuff in ( ) of a function definition
-
STATE_FUNCTION_PARAM_VAR
-
currently parsing a $param in a function definition
-
STATE_FUNC_GLOBAL
-
currently parsing a "global $var1, $var2;" declaration in a function
-
STATE_GLOBAL
-
currently parsing a global variable declaration
-
STATE_GLOBAL_VALUE
-
currently parsing the default value in a global variable declaration
-
STATE_IMPLEMENTS
-
currently parsing an implements clause
-
STATE_INCLUDE
-
currently parsing an include/require/include_once/include_once
-
STATE_INCLUDE_PARAMS
-
currently parsing the stuff in ( ) of a define statement
-
STATE_INCLUDE_PARAMS_PARENTHESIS
-
currently parsing an inner parenthetical statement of an include/includeonce/require/requireonce( )
-
STATE_INLINE_DOCKEYWORD
-
currently parsing an inline tag like { @link} in a DocBlock
-
STATE_LOGICBLOCK
-
currently parsing a { } block
-
STATE_METHOD
-
currently parsing a method using the HighlightParser
-
STATE_METHOD_LOGICBLOCK
-
currently parsing the method body using the HighlightParser
-
STATE_NOEVENTS
-
out of < ? php tag
-
STATE_OUTPHP
-
currently out of php code
-
STATE_PHPCODE
-
currently parsing php code
-
STATE_QUOTE
-
currently parsing a quote
-
STATE_QUOTE_VAR
-
currently parsing a {$encapsed_var} using the HighlightParser
-
STATE_SINGLEQUOTE
-
currently parsing a string enclosed in single quotes (')
-
STATE_STATIC_VAR
-
currently parsing a "static $var1, $var2;" declaration in a function
-
STATE_STATIC_VAR_VALUE
-
currently parsing the value in a "static $var1 = x" declaration in a function
-
STATE_TAGS
-
currently parsing the @tag block of a docblock
-
STATE_TUTORIAL_ATTRIBUTE
-
currently parsing an open <tag>
-
STATE_TUTORIAL_CLOSETAG
-
currently parsing a close </tag>
-
STATE_TUTORIAL_COMMENT
-
currently parsing a <!-- comment -->
-
STATE_TUTORIAL_DOUBLEQUOTE
-
currently parsing a <!-- comment -->
-
STATE_TUTORIAL_ENTITY
-
currently parsing an &entity;
-
STATE_TUTORIAL_ITAG
-
currently parsing an {@inline tag}
-
STATE_TUTORIAL_NOEVENTS
-
currently in starting state
-
STATE_TUTORIAL_OPENTAG
-
currently parsing an open <tag>
-
STATE_TUTORIAL_SINGLEQUOTE
-
currently parsing a <!-- comment -->
-
STATE_VAR
-
currently parsing a Class variable
-
STATE_VAR_ARRAY
-
currently parsing a variable value is an array
-
STATE_VAR_ARRAY_COMMENT
-
currently parsing a comment in a variable array value
-
STATE_XMLTOKEN_ATTRIBUTE
-
currently parsing an open <tag>
-
STATE_XMLTOKEN_CDATA
-
currently parsing a <!
-
STATE_XMLTOKEN_CLOSETAG
-
currently parsing a close </tag>
-
STATE_XMLTOKEN_COMMENT
-
currently parsing a <!-- comment -->
-
STATE_XMLTOKEN_DEF
-
currently parsing a <!
-
STATE_XMLTOKEN_DOUBLEQUOTE
-
currently parsing a <!-- comment -->
-
STATE_XMLTOKEN_ENTITY
-
currently parsing an &entity;
-
STATE_XMLTOKEN_IN_CDATA
-
currently parsing a <![CDATA[ ]]>
-
STATE_XMLTOKEN_NOEVENTS
-
currently in starting state
-
STATE_XMLTOKEN_OPENTAG
-
currently parsing an open <tag>
-
STATE_XMLTOKEN_PI
-
currently in processor instruction
-
STATE_XMLTOKEN_SINGLEQUOTE
-
currently parsing a <!-- comment -->
-
STATE_XMLTOKEN_XML
-
currently parsing a <?xml
-
staticvarTagHandler
-
handles @staticvar
-
stringConvert
-
converter helper used in PHP 4.2.3-
-
Strlen
-
get length of the tag
-
Strlen
-
only used to determine blank lines. {@source} will not be blank, probably
-
subscribe
-
Adds a subscriber to the $subscriber array().
-
suite
-
-
suite
-
-
suite
-
-
suite
-
-
suite
-
-
suite
-
-
switchDirTree
-