-
$all_packages
-
list of all packages encountered while documenting. Used in automatic linking.
-
addClass
-
While parsing, add a class to the list of parsed classes
-
addClassPackageToFile
-
adds a package from a class to the current file
-
addConst
-
While parsing, add a variable to the list of parsed variables
-
addConverter
-
Add a converter name to use to the list of converters
-
addDefine
-
sets up the $definesbyfile array using $curfile
-
addElementToPage
-
adds a processed descendant of
parserElement to the $pages array or $privatepages array
-
addFunction
-
sets up the $functionsbyfile array using $curfile
-
addGlobal
-
sets up the $globalsbyfile array using $curfile
-
addInclude
-
sets up the $includesbyfile array using $curfile
-
addMethod
-
While parsing, add a method to the list of parsed methods
-
addPackageParent
-
If the parent class of $class is in a different package, adds it to the
-
addPackageToFile
-
Mark a package as being used in a class
-
addPage
-
sets up the $pages array
-
addPage
-
Replaces the
parserPage represented by $this->pages[$path] with $page
-
addPageIfNecessary
-
add a new
parserPage to the $pages array if none is found
-
addPagePackage
-
Changes the package of the page represented by $path
-
addPrivatePage
-
-
addUses
-
Add all the @uses tags from $element to the $uses array so that @usedby
-
addVar
-
While parsing, add a variable to the list of parsed variables
-
addItem
-
add an item to a list
-
addList
-
add a list
-
addError
-
add a new error to the $errors array
-
addError
-
add an Error
-
addErrorDie
-
-
addErrorReturn
-
add a new error to the $errors array and returns the error string
-
addWarning
-
add a new warning to the $warnings array
-
addWarning
-
add a Warning
-
arrayConvert
-
converter helper used in PHP 4.3.0+
-
arrayConvert
-
converter helper for PHP 4.3.0+
-
abstractLink
-
linking classes parent
-
addLink
-
sets up the link
-
addLink
-
sets up the link
-
addLink
-
sets up the link
-
add
-
equivalent to the . operator ($a = $b . $c)
-
addElement
-
add a new element to the tracking array
-
addLink
-
adds a link
-
addTutorial
-
adds a tutorial parser
-
add
-
-
addAccess
-
add an @access tag to the tags array
-
addExample
-
adds an @example tag
-
addFileSource
-
Adds a new @filesource tag to the DocBlock
-
addFuncGlobal
-
adds a function declaration of @global to the $funcglobals array
-
addKeyword
-
-
addLink
-
-
addName
-
Adds a @name tag to the tag list
-
addPackage
-
-
addParam
-
-
addProperty
-
Adds a @property(-read or -write) or @method magic tag to the DocBlock
-
addReturn
-
-
addSee
-
-
addStaticVar
-
-
addTag
-
Used to insert DocBlock Template tags into a docblock
-
addUnknownTag
-
adds an unknown tag to the $unknown_tags array for use by custom converters
-
addUses
-
Add a @uses tag to the DocBlock
-
addVar
-
-
addGlobals
-
Add all "global $var, $var2" declarations to this function
-
addImplements
-
-
addParam
-
-
addParam
-
-
addSource
-
Set the source code. Always array in PHP 4.3.0+
-
addStatics
-
Add all "static $var, $var2 = 6" declarations to this function
-
addTutorial
-
-
$attributes
-
Attributes from the XML tag
-
add
-
Add contents to this tag.
-
addAttribute
-
Add an xml tag attribute name="value" pair
-
addCData
-
add a word to CData
-
addFileSource
-
Wrapper for addSource() used to retrieve the entire source code organized by line number in setup()
-
addSource
-
Generate source token arrays organized by line number
-
$classes
-
used to keep track of inheritance at the smartest level possible for a
-
$converters
-
an array of template names indexed by converter name
-
$curfile
-
file being parsed, used in every add function to match up elements with the file that contains them
-
$cur_class
-
Name of the class currently being parsed.
-
checkForBugCondition
-
Crash in case of known, dangerous bug condition
-
checkIgnore
-
Tell whether to ignore a file or a directory allows * and ? wildcards
-
checkIgnoreTag
-
-
ClasselementCmp
-
-
Classes
-
Intermediate class parsing structure.
-
Convert
-
Interface to the Converter
-
createDocs
-
-
Classes.inc
-
-
clone.inc.php
-
-
clone5.inc.php
-
-
common.inc.php
-
-
Convert
-
performs the conversion of list tags
-
Convert
-
performs the conversion of code tags
-
Convert
-
performs the conversion of sample tags
-
Convert
-
performs the conversion of keyboard tags
-
Convert
-
performs the conversion of italic tags
-
Convert
-
performs the conversion of linebreak tags
-
Convert
-
performs the conversion of code tags
-
Convert
-
performs the conversion of variable tags
-
Convert
-
performs the conversion of bold tags
-
$converted_returnType
-
contains a link to the documentation for a class passed as a type in @return, @var or @param
-
Convert
-
-
Convert
-
process this tag through the given output converter
-
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
-
Convert
-
process this tag through the given output converter (sets up the $converted_returnType)
-
Convert
-
Return a link to the highlighted source and generate the source
-
Convert
-
process this tag through the given output converter
-
Convert
-
process this tag through the given output converter
-
ConvertSource
-
convert the source code
-
ConvertSource
-
convert the source code
-
$curfile
-
-
$category
-
category of the {@id}
-
Convert
-
converter method
-
Convert
-
convert part of the tag
-
Convert
-
convert the tag
-
Convert
-
calls the output conversion
-
Convert
-
converter
-
Convert
-
only sets a warning and returns empty
-
ConvertPart
-
convert part of the tag
-
$category
-
-
$class
-
-
classLink
-
class link
-
constLink
-
class constant link
-
$category
-
-
$classelements
-
array of parsed class elements
-
$clean
-
-
Convert
-
Use to convert the string to a real string with all inline tags parsed and linked
-
$category
-
-
canSource
-
Tells the DocBlock it can have a @filesource tag
-
cantSource
-
Tells the DocBlock it can't have a @filesource tag
-
changeGlobal
-
-
changeParam
-
-
changeStatic
-
-
$children
-
links to the child tutorials, or false if none
-
$class
-
-
$class
-
-
$class
-
-
$conflicts
-
-
$curfile
-
-
Convert
-
-
Convert
-
-
$context
-
-
categoryTagHandler
-
handles @category
-
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.
-
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
-
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.
-
Convert
-
calls the output conversion
-
Convert
-
calls the output conversion
-
Convert
-
calls the output conversion
-
concatTokens
-
Utility function to convert a series of tokens into a string
-
$globalconflicts
-
Namespace conflicts within all documented packages of functions
-
$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.
-
getAllFiles
-
Take a filename with wildcards and return all files that match the
-
getBase
-
Retrieve common directory (case-insensitive in windows)
-
getClass
-
Get the parserClass representation of a class from its name and file
-
getClassByPackage
-
Search for a class in a package
-
getClassesInPath
-
-
getConflicts
-
If a package contains two classes with the same name, this function finds that conflict
-
getDefiniteChildren
-
Get all classes confirmed in parsing to be descended class $parclass in file $file
-
getDirTree
-
-
getEvent
-
Get the current event
-
getParentClass
-
Find the parent class of a class in file $file
-
getPathInfo
-
gathers path-related info about a given element
-
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
-
getRoots
-
Get a list of all root classes indexed by package. Used to generate class trees by
Converter
-
getTutorials
-
Retrieve tutorial subdirectories and their contents from the list of
-
get_include_path
-
-
getDescription
-
Get the description of how the element used is being used.
-
getSourceLink
-
gets path to the sourcecode file
-
getSourceLink
-
Retrieve a converter-specific link to the example
-
getString
-
Returns the text minus any inline tags
-
getString
-
No inline tags are possible, returns 'public', 'protected' or 'private'
-
getProgramListing
-
Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial
-
getString
-
gets the source string
-
getString
-
always gets an empty string
-
globalLink
-
global variable link
-
getClasses
-
returns a list of all classes declared in a file
-
getFile
-
gets the file name
-
getLink
-
returns a link
-
getName
-
Get the output-safe filename (. changed to _)
-
getName
-
gets the name
-
getPackageOutput
-
gets the package output array
-
getParseData
-
Not implemented in this version
-
getPath
-
gets the path
-
getSourceLocation
-
gets the source location
-
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)
-
getTutorial
-
If this file has a tutorial associated with it, returns a link to the tutorial.
-
getType
-
gets the tag type
-
getType
-
gets the type
-
getValue
-
gets the value
-
getDesc
-
-
getEndLineNumber
-
Retrieve ending line number
-
getExplicitCategory
-
If the DocBlock has a @category tag, then this returns true
-
getExplicitPackage
-
If the DocBlock has a @package tag, then this returns true
-
getKeyword
-
-
getLineNumber
-
Retrieve starting line number
-
getSDesc
-
-
getType
-
-
$globals
-
global declarations parsed from function definition
-
getChildClassList
-
returns a list of all child classes of this class
-
getClass
-
Retrieve the class name
-
getClass
-
Return name of the class that contains this method
-
getClass
-
Retrieve the class name
-
getConflicts
-
Returns all functions in other packages that have the same name as this function
-
getConflicts
-
Returns all classes in other packages that have the same name as this class
-
getConflicts
-
Returns all defines in other packages that have the same name as this define
-
getConflicts
-
Returns all global variables in other packages that have the same name as this global variable
-
getConstNames
-
-
getConsts
-
-
getDataType
-
Retrieve converter-specific representation of the data type
-
getEndLineNumber
-
-
getExtends
-
-
getFile
-
-
getFunctionCall
-
adds "constructor " to start of function call if $isConstructor is true
-
getFunctionCall
-
Get a human-friendly description of the function call
-
getImplements
-
-
getImplements
-
-
getInheritedConsts
-
-
getInheritedMethods
-
-
getInheritedVars
-
-
getIntricateFunctionCall
-
-
getIntricateFunctionCall
-
Like getFunctionCall(), but has no English or pre-determined formatting.
-
getLineNumber
-
-
getLink
-
quick way to link to this element
-
getLink
-
quick way to link to this element
-
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
-
getMethod
-
-
getMethodNames
-
-
getMethods
-
-
getModifiers
-
Get the PHP5+ modifiers for this class
-
getModifiers
-
Return a list of access modifiers (static/private/etc.)
-
getModifiers
-
Return name of the class that contains this method
-
getName
-
-
getNext
-
Retrieve converter-specific link to the next tutorial's documentation
-
getOverrides
-
-
getOverrides
-
-
getOverridingMethods
-
-
getOverridingMethodsForClass
-
-
getOverridingVars
-
-
getOverridingVarsForClass
-
-
getPackage
-
-
getParam
-
-
getParent
-
retrieve object that represents the parent class
-
getParent
-
Retrieve converter-specific link to the parent tutorial's documentation
-
getParentClassTree
-
-
getPath
-
-
getPrev
-
Retrieve converter-specific link to the previous tutorial's documentation
-
getReturnsReference
-
-
getSource
-
-
getSourceLocation
-
-
getTitle
-
Retrieve the title of the tutorial, or of any subsection
-
getTutorial
-
Get the associated tutorial for this class, if any
-
getVar
-
-
getVarNames
-
-
getVars
-
-
getParserEventName
-
searches for a parser event name based on its number
-
getParserEventName
-
debugging function
-
getParserEventName
-
-
getParserEventName
-
-
getParserEventName
-
Debugging function, takes an event number and attempts to return its name
-
getWord
-
Retrieve the next token
-
globalTagHandler
-
handles @global
-
getId
-
Return converter-specific formatting of ID.
-
getSubsection
-