Index of all elements

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

a

$all_packages: in file Converter.inc, variable Converter::$all_packages
All packages encountered in parsing
$all_packages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$all_packages
list of all packages encountered while documenting. Used in automatic linking.
$attributes: in file PackagePageElements.inc, variable parserXMLDocBookTag::$attributes
Attributes from the XML tag
abstractLink: in file LinkClasses.inc, class abstractLink
linking classes parent
add: in file PackagePageElements.inc, method parserXMLDocBookTag::add()
Add contents to this tag.
add: in file ParserData.inc, method parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
add: in file ParserDocBlock.inc, method parserDesc::add()
addAccess: in file ParserDocBlock.inc, method parserDocBlock::addAccess()
add an @access tag to the tags array
addAttribute: in file PackagePageElements.inc, method parserXMLDocBookTag::addAttribute()
Add an xml tag attribute name="value" pair
addCData: in file PackagePageElements.inc, method parserXMLDocBookTag::addCData()
add a word to CData
addClass: in file Classes.inc, method Classes::addClass()
While parsing, add a class to the list of parsed classes
addClassPackageToFile: in file ProceduralPages.inc, method ProceduralPages::addClassPackageToFile()
adds a package from a class to the current file
addConst: in file Classes.inc, method Classes::addConst()
While parsing, add a variable to the list of parsed variables
addConverter: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addConverter()
Add a converter name to use to the list of converters
addDefine: in file ProceduralPages.inc, method ProceduralPages::addDefine()
sets up the $definesbyfile array using $curfile
addElement: in file ParserData.inc, method parserData::addElement()
add a new element to the tracking array
addElementToPage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addElementToPage()
adds a processed descendant of parserElement to the $pages array or $privatepages array
addError: in file Errors.inc, method ErrorTracker::addError()
add a new error to the $errors array
addError: in file Errors.inc, function addError()
add an Error
addErrorDie: in file Errors.inc, function addErrorDie()
like addError() but exits parsing
addErrorReturn: in file Errors.inc, method ErrorTracker::addErrorReturn()
add a new error to the $errors array and returns the error string
addExample: in file ParserDocBlock.inc, method parserDocBlock::addExample()
adds an @example tag
addFileSource: in file ParserDocBlock.inc, method parserDocBlock::addFileSource()
Adds a new @filesource tag to the DocBlock
addFileSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::addFileSource()
Wrapper for addSource() used to retrieve the entire source code organized by line number in setup()
addFuncGlobal: in file ParserDocBlock.inc, method parserDocBlock::addFuncGlobal()
adds a function declaration of @global to the $funcglobals array
addFunction: in file ProceduralPages.inc, method ProceduralPages::addFunction()
sets up the $functionsbyfile array using $curfile
addGlobal: in file ProceduralPages.inc, method ProceduralPages::addGlobal()
sets up the $globalsbyfile array using $curfile
addGlobals: in file ParserElements.inc, method parserFunction::addGlobals()
Add all "global $var, $var2" declarations to this function
addHHP: in file CHMdefaultConverter.inc, method CHMdefaultConverter::addHHP()
addImplements: in file ParserElements.inc, method parserClass::addImplements()
addInclude: in file ProceduralPages.inc, method ProceduralPages::addInclude()
sets up the $includesbyfile array using $curfile
addItem: in file DescHTML.inc, method parserList::addItem()
add an item to a list
addKeyword: in file ParserDocBlock.inc, method parserDocBlock::addKeyword()
addKLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::addKLink()
Add an item to the index.hhk file
addLink: in file LinkClasses.inc, method methodLink::addLink()
sets up the link
addLink: in file ParserDocBlock.inc, method parserDocBlock::addLink()
creates a parserLinkTag and adds it to the $tags array
addLink: in file LinkClasses.inc, method abstractLink::addLink()
sets up the link
addLink: in file LinkClasses.inc, method tutorialLink::addLink()
sets up the link
addLink: in file ParserData.inc, method parserData::addLink()
adds a link
addList: in file DescHTML.inc, method parserList::addList()
add a list
addMessage: in file class.phpdocpdf.php, method phpdocpdf::addMessage()
addMethod: in file Classes.inc, method Classes::addMethod()
While parsing, add a method to the list of parsed methods
addName: in file ParserDocBlock.inc, method parserDocBlock::addName()
Adds a @name tag to the tag list
addPackage: in file ParserDocBlock.inc, method parserDocBlock::addPackage()
addPackageParent: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPackageParent()
If the parent class of $class is in a different package, adds it to the
addPackageToFile: in file Classes.inc, method Classes::addPackageToFile()
Mark a package as being used in a class
addPage: in file ProceduralPages.inc, method ProceduralPages::addPage()
sets up the $pages array
addPage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPage()
Replaces the parserPage represented by $this->pages[$path] with $page
addPageIfNecessary: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPageIfNecessary()
add a new parserPage to the $pages array if none is found
addPagePackage: in file ProceduralPages.inc, method ProceduralPages::addPagePackage()
Changes the package of the page represented by $path
addParam: in file ParserDocBlock.inc, method parserDocBlock::addParam()
addParam: in file ParserElements.inc, method parserFunction::addParam()
addParam: in file ParserElements.inc, method parserMethod::addParam()
addPrivatePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addPrivatePage()
Adds a parserPage element to the parserData element in $this->privatepages[$path]
addProperty: in file ParserDocBlock.inc, method parserDocBlock::addProperty()
Adds a @property(-read or -write) or @method magic tag to the DocBlock
addReturn: in file ParserDocBlock.inc, method parserDocBlock::addReturn()
creates a parserReturnTag and adds it to the $tags array
addSee: in file ParserDocBlock.inc, method parserDocBlock::addSee()
creates a parserLinkTag and adds it to the $tags array
addSource: in file ParserElements.inc, method parserFunction::addSource()
Set the source code. Always array in PHP 4.3.0+
addSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::addSource()
Generate source token arrays organized by line number
addSourceTOC: in file CHMdefaultConverter.inc, method CHMdefaultConverter::addSourceTOC()
addStatics: in file ParserElements.inc, method parserFunction::addStatics()
Add all "static $var, $var2 = 6" declarations to this function
addStaticVar: in file ParserDocBlock.inc, method parserDocBlock::addStaticVar()
addSummaryToPackageXml: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::addSummaryToPackageXml()
addTag: in file ParserDocBlock.inc, method parserDocBlock::addTag()
Used to insert DocBlock Template tags into a docblock
addTOC: in file CHMdefaultConverter.inc, method CHMdefaultConverter::addTOC()
addTutorial: in file ParserElements.inc, method parserClass::addTutorial()
addTutorial: in file ParserData.inc, method parserData::addTutorial()
adds a tutorial parser
addUnknownTag: in file ParserDocBlock.inc, method parserDocBlock::addUnknownTag()
adds an unknown tag to the $unknown_tags array for use by custom converters
addUses: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::addUses()
Add all the @uses tags from $element to the $uses array so that @usedby
addUses: in file ParserDocBlock.inc, method parserDocBlock::addUses()
Add a @uses tag to the DocBlock
addVar: in file Classes.inc, method Classes::addVar()
While parsing, add a variable to the list of parsed variables
addVar: in file ParserDocBlock.inc, method parserDocBlock::addVar()
creates a parserVarTag and adds it to the $tags array
addWarning: in file Errors.inc, method ErrorTracker::addWarning()
add a new warning to the $warnings array
addWarning: in file Errors.inc, function addWarning()
add a Warning
adv_htmlentities: in file Converter.inc, function adv_htmlentities()
smart htmlentities, doesn't entity the allowed tags list
arrayConvert: in file InlineTags.inc, method parserSourceInlineTag::arrayConvert()
converter helper used in PHP 4.3.0+
arrayConvert: in file InlineTags.inc, method parserExampleInlineTag::arrayConvert()
converter helper for PHP 4.3.0+
AttrToString: in file Converter.inc, method Converter::AttrToString()
Convert the attribute of a Tutorial docbook tag's attribute list
actions.php: procedural page actions.php

top

b

$base_dir: in file HTMLframesConverter.inc, variable HTMLframesConverter::$base_dir
target directory passed on the command-line.
$base_dir: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$base_dir
target directory passed on the command-line.
$base_dir: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$base_dir
target directory passed on the command-line.
$base_dir: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$base_dir
target directory passed on the command-line.
$base_dir: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$base_dir
target directory passed on the command-line.
backupPos: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::backupPos()
back the word parser to the previous token as defined by $last_token
backupPos: in file WordParser.inc, method WordParser::backupPos()
Backup to the previous token so that it can be retrieved again in a new context.
backupPos: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::backupPos()
backs the parser up to the previous position
Bolden: in file Converter.inc, method Converter::Bolden()
Used to convert the contents of in a docblock
Br: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::Br()
Br: in file Converter.inc, method Converter::Br()
Used to convert in a docblock
bug_772441: in file bug-772441.php, class bug_772441
bullet: in file class.phpdocpdf.php, method phpdocpdf::bullet()
builder.php: procedural page builder.php
bug-560532.php: procedural page bug-560532.php
bug-772441.php: procedural page bug-772441.php
Beautifier.php: procedural page Beautifier.php

top

c

$category: in file InlineTags.inc, variable parserIdInlineTag::$category
category of the {@id}
$category: in file ParserDocBlock.inc, variable parserDocBlock::$category
$category: in file ParserData.inc, variable parserPage::$category
$category: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$category
peardoc2 Category
$category: in file LinkClasses.inc, variable abstractLink::$category
$category: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$category
peardoc2 Category
$children: in file ParserElements.inc, variable parserTutorial::$children
links to the child tutorials, or false if none
$class: in file Converter.inc, variable Converter::$class
set to a classname if currently parsing a class, false if not
$class: in file LinkClasses.inc, variable methodLink::$class
$class: in file ParserElements.inc, variable parserVar::$class
$class: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class
name of current class being converted
$class: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class
name of current class being converted
$class: in file ParserElements.inc, variable parserConst::$class
$class: in file ParserElements.inc, variable parserMethod::$class
$classelements: in file ParserData.inc, variable parserData::$classelements
array of parsed class elements
$classes: in file Converter.inc, variable Converter::$classes
All class information, organized by path, and by package
$classes: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$classes
used to keep track of inheritance at the smartest level possible for a
$classpackage_pagenums: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$classpackage_pagenums
$class_contents: in file Converter.inc, variable Converter::$class_contents
alphabetical index of all methods and vars in a class by package/subpackage
$class_data: in file Converter.inc, variable Converter::$class_data
template for the class currently being processed
$class_data: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class_data
template for the class currently being processed
$class_data: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class_data
template for the class currently being processed
$class_dir: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$class_dir
output directory for the current class being processed
$class_dir: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$class_dir
output directory for the current class being processed
$class_dir: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class_dir
output directory for the current class being processed
$class_dir: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class_dir
output directory for the current class being processed
$class_dir: in file HTMLframesConverter.inc, variable HTMLframesConverter::$class_dir
output directory for the current class being processed
$class_elements: in file Converter.inc, variable Converter::$class_elements
alphabetized index of classes by package
$clean: in file ParserData.inc, variable parserData::$clean
used by phpDocumentor_IntermediateParser::handleDocBlock() to
$conflicts: in file ParserElements.inc, variable parserElement::$conflicts
$context: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$context
$converted_returnType: in file DocBlockTags.inc, variable parserReturnTag::$converted_returnType
contains a link to the documentation for a class passed as a type in @return, @var or @param
$converter: in file class.phpdocpdf.php, variable phpdocpdf::$converter
$converters: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$converters
an array of template names indexed by converter name
$curclasspackage: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$curclasspackage
$curfile: in file Converter.inc, variable Converter::$curfile
full path of the current file being converted
$curfile: in file ParserElements.inc, variable parserClass::$curfile
$curfile: in file ProceduralPages.inc, variable ProceduralPages::$curfile
file being parsed, used in every add function to match up elements with the file that contains them
$curfile: in file Errors.inc, variable ErrorTracker::$curfile
$curpage: in file Converter.inc, variable Converter::$curpage
current procedural page being processed
$curpagepackage: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$curpagepackage
$current: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$current
contains all of the template procedural page element loop data needed for the current template
$current: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$current
contains all of the template procedural page element loop data needed for the current template
$current: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$current
contains all of the template procedural page element loop data needed for the current template
$current: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$current
contains all of the template procedural page element loop data needed for the current template
$current: in file HTMLframesConverter.inc, variable HTMLframesConverter::$current
contains all of the template procedural page element loop data needed for the current template
$currentclass: in file HTMLframesConverter.inc, variable HTMLframesConverter::$currentclass
contains all of the template class element loop data needed for the current template
$currentclass: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$currentclass
contains all of the template class element loop data needed for the current template
$currentclass: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$currentclass
contains all of the template class element loop data needed for the current template
$currentclass: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$currentclass
contains all of the template class element loop data needed for the current template
$currentclass: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$currentclass
contains all of the template class element loop data needed for the current template
$cur_class: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$cur_class
Name of the class currently being parsed.
canSource: in file ParserDocBlock.inc, method parserDocBlock::canSource()
Tells the DocBlock it can have a @filesource tag
cantSource: in file ParserDocBlock.inc, method parserDocBlock::cantSource()
Tells the DocBlock it can't have a @filesource tag
categoryTagHandler: in file Parser.inc, method Parser::categoryTagHandler()
handles @category
changeGlobal: in file ParserDocBlock.inc, method parserDocBlock::changeGlobal()
changeParam: in file ParserDocBlock.inc, method parserDocBlock::changeParam()
changeStatic: in file ParserDocBlock.inc, method parserDocBlock::changeStatic()
checkEventPop: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::checkEventPop()
This function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPop: in file Parser.inc, method Parser::checkEventPop()
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPop: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::checkEventPop()
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
checkEventPush: in file Parser.inc, method Parser::checkEventPush()
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkEventPush: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::checkEventPush()
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkEventPush: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::checkEventPush()
This function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
checkForBugCondition: in file Setup.inc.php, function checkForBugCondition()
Crash in case of known, dangerous bug condition
checkIgnore: in file Io.inc, method Io::checkIgnore()
Tell whether to ignore a file or a directory allows * and ? wildcards
checkIgnoreTag: in file Setup.inc.php, method phpDocumentor_setup::checkIgnoreTag()
checkState: in file Converter.inc, method Converter::checkState()
Compare parserStringWithInlineTags::Convert() cache state to $state
CHMdefaultConverter: in file CHMdefaultConverter.inc, method CHMdefaultConverter::CHMdefaultConverter()
sets $base_dir to $targetDir
CHMdefaultConverter: in file CHMdefaultConverter.inc, class CHMdefaultConverter
Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)
ClasselementCmp: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::ClasselementCmp()
does a natural case sort on two class elements (either parserClass, parserMethod or parserVar
Classes: in file Classes.inc, class Classes
Intermediate class parsing structure.
classLink: in file LinkClasses.inc, class classLink
class link
cleanup: in file Converter.inc, method Converter::cleanup()
Finish up parsing/cleanup directories
concatTokens: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::concatTokens()
Utility function to convert a series of tokens into a string
configWordParser: in file HighlightParser.inc, method phpDocumentor_HighlightParser::configWordParser()
Give the word parser necessary data to begin a new parse
configWordParser: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::configWordParser()
Tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser: in file Parser.inc, method Parser::configWordParser()
tell the parser's WordParser $wp to set up tokens to parse words by.
configWordParser: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::configWordParser()
tell the parser's WordParser $wp to set up tokens to parse words by.
constLink: in file LinkClasses.inc, class constLink
class constant link
Convert: in file InlineTags.inc, method parserIdInlineTag::Convert()
converter
Convert: in file InlineTags.inc, method parserTocInlineTag::Convert()
converter method
Convert: in file InlineTags.inc, method parserTutorialInlineTag::Convert()
convert part of the tag
Convert: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::Convert()
Interface to the Converter
Convert: in file InlineTags.inc, method parserSourceInlineTag::Convert()
convert the tag
Convert: in file InlineTags.inc, method parserLinkInlineTag::Convert()
calls the output conversion
Convert: in file PackagePageElements.inc, method parserEntity::Convert()
calls the output conversion
Convert: in file PackagePageElements.inc, method parserCData::Convert()
calls the output conversion
Convert: in file InlineTags.inc, method parserInheritdocInlineTag::Convert()
only sets a warning and returns empty
Convert: in file PackagePageElements.inc, method parserXMLDocBookTag::Convert()
calls the output conversion
Convert: in file DescHTML.inc, method parserSamp::Convert()
performs the conversion of sample tags
Convert: in file DescHTML.inc, method parserKbd::Convert()
performs the conversion of keyboard tags
Convert: in file ParserData.inc, method parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
Convert: in file DescHTML.inc, method parserList::Convert()
performs the conversion of list tags
Convert: in file DescHTML.inc, method parserPre::Convert()
performs the conversion of code tags
Convert: in file DocBlockTags.inc, method parserFileSourceTag::Convert()
Return a link to the highlighted source and generate the source
Convert: in file DocBlockTags.inc, method parserAccessTag::Convert()
process this tag through the given output converter
Convert: in file DescHTML.inc, method parserDescVar::Convert()
performs the conversion of variable tags
Convert: in file DescHTML.inc, method parserCode::Convert()
performs the conversion of code tags
Convert: in file Converter.inc, method Converter::Convert()
Convert all elements to output format
Convert: in file ParserElements.inc, method parserTutorial::Convert()
Convert: in file ParserElements.inc, method parserPackagePage::Convert()
Convert: in file DescHTML.inc, method parserB::Convert()
performs the conversion of bold tags
Convert: in file DescHTML.inc, method parserBr::Convert()
performs the conversion of linebreak tags
Convert: in file DocBlockTags.inc, method parserNameTag::Convert()
process this tag through the given output converter
Convert: in file DescHTML.inc, method parserI::Convert()
performs the conversion of italic tags
Convert: in file DocBlockTags.inc, method parserTutorialTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserUsesTag::Convert()
Return a link to documentation for other element, and description of how it is used
Convert: in file DocBlockTags.inc, method parserReturnTag::Convert()
process this tag through the given output converter (sets up the $converted_returnType)
Convert: in file DocBlockTags.inc, method parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
Convert: in file DocBlockTags.inc, method parserUsedByTag::Convert()
process this tag through the given output converter
Convert: in file DocBlockTags.inc, method parserSeeTag::Convert()
process this tag through the given output converter
convertClass: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertClass()
convertClass: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertClass()
Converts class for template output
convertClass: in file Converter.inc, method Converter::convertClass()
Default Class Handler
convertClass: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertClass()
Converts class for template output
convertClass: in file HTMLframesConverter.inc, method HTMLframesConverter::convertClass()
Converts class for template output
convertClass: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertClass()
Converts class for template output
convertClass: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertClass()
Converts class for template output
convertConst: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertConst()
Converts class constants for template output
convertConst: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertConst()
convertConst: in file Converter.inc, method Converter::convertConst()
Converts class constants for template output.
convertConst: in file HTMLframesConverter.inc, method HTMLframesConverter::convertConst()
Converts class variables for template output
convertConst: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertConst()
Converts class variables for template output
convertDefine: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertDefine()
convertDefine: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertDefine()
Converts defines for template output
convertDefine: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertDefine()
Converts defines for template output
convertDefine: in file Converter.inc, method Converter::convertDefine()
Converts defines for template output
convertDefine: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertDefine()
Converts defines for template output
convertDefine: in file HTMLframesConverter.inc, method HTMLframesConverter::convertDefine()
Converts defines for template output
convertDefine: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertDefine()
Converts defines for template output
convertDocBlock: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertDocBlock()
Converter: in file Converter.inc, class Converter
Base class for all output converters.
Converter: in file Converter.inc, method Converter::Converter()
Initialize Converter data structures
ConvertErrorLog: in file HTMLframesConverter.inc, method HTMLframesConverter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file XMLDocBookConverter.inc, method XMLDocBookConverter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file CHMdefaultConverter.inc, method CHMdefaultConverter::ConvertErrorLog()
Create errors.html template file output
ConvertErrorLog: in file Converter.inc, method Converter::ConvertErrorLog()
Convert the phpDocumentor parsing/conversion error log
convertFunction: in file HTMLframesConverter.inc, method HTMLframesConverter::convertFunction()
Converts function for template output
convertFunction: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertFunction()
Converts function for template output
convertFunction: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertFunction()
Converts function for template output - does nothing in peardoc2!
convertFunction: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertFunction()
convertFunction: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertFunction()
Converts function for template output
convertFunction: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertFunction()
Converts function for template output
convertFunction: in file Converter.inc, method Converter::convertFunction()
Converts function for template output
convertGlobal: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertGlobal()
Converts global variables for template output
convertGlobal: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertGlobal()
convertGlobal: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertGlobal()
Converts global variables for template output
convertGlobal: in file Converter.inc, method Converter::convertGlobal()
Converts global variables for template output
convertGlobal: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertGlobal()
Converts global variables for template output
convertGlobal: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertGlobal()
Converts global variables for template output
convertGlobal: in file HTMLframesConverter.inc, method HTMLframesConverter::convertGlobal()
Converts global variables for template output
convertInclude: in file HTMLframesConverter.inc, method HTMLframesConverter::convertInclude()
Converts include elements for template output
convertInclude: in file Converter.inc, method Converter::convertInclude()
Converts includes for template output
convertInclude: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertInclude()
Converts include elements for template output
convertInclude: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertInclude()
convertInclude: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertInclude()
Converts include elements for template output
convertInclude: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertInclude()
Converts include elements for template output
convertInclude: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertInclude()
Converts include elements for template output
convertMethod: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertMethod()
Converts class methods for template output
convertMethod: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertMethod()
convertMethod: in file HTMLframesConverter.inc, method HTMLframesConverter::convertMethod()
Converts class methods for template output
convertMethod: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertMethod()
Converts class methods for template output
convertMethod: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertMethod()
Converts method for template output
convertMethod: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertMethod()
Converts method for template output
convertMethod: in file Converter.inc, method Converter::convertMethod()
Converts method for template output
convertPackagepage: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertPackagepage()
convertPackagePage: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertPackagePage()
Does nothing - use tutorials for DocBook
convertPackagepage: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
convertPackagePage: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertPackagePage()
Converts package page and sets its package as used in $package_pages
convertPackagepage: in file HTMLframesConverter.inc, method HTMLframesConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
convertPackagepage: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
convertPage: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertPage()
converts procedural pages for template output
convertPage: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertPage()
converts procedural pages for template output
convertPage: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertPage()
converts procedural pages for template output
convertPage: in file Converter.inc, method Converter::convertPage()
Default Page Handler
convertPage: in file HTMLframesConverter.inc, method HTMLframesConverter::convertPage()
converts procedural pages for template output
convertPage: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertPage()
converts procedural pages for template output
convertPage: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertPage()
convertParams: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertParams()
ConvertPart: in file InlineTags.inc, method parserLinkInlineTag::ConvertPart()
convert part of the tag
ConvertSource: in file DocBlockTags.inc, method parserExampleTag::ConvertSource()
convert the source code
ConvertSource: in file DocBlockTags.inc, method parserFileSourceTag::ConvertSource()
convert the source code
ConvertTitle: in file Converter.inc, method Converter::ConvertTitle()
Convert the title of a Tutorial docbook tag section
ConvertTodoList: in file HTMLframesConverter.inc, method HTMLframesConverter::ConvertTodoList()
ConvertTodoList: in file CHMdefaultConverter.inc, method CHMdefaultConverter::ConvertTodoList()
ConvertTodoList: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ConvertTodoList()
ConvertTodoList: in file Converter.inc, method Converter::ConvertTodoList()
Convert the list of all @todo tags
convertTutorial: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertTutorial()
convertTutorial: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertTutorial()
convertTutorial: in file Converter.inc, method Converter::convertTutorial()
Default Tutorial Handler
convertTutorial: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertTutorial()
Convert tutorials for output
convertTutorial: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertTutorial()
convertTutorial: in file HTMLframesConverter.inc, method HTMLframesConverter::convertTutorial()
convertTutorial: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertTutorial()
convertVar: in file Converter.inc, method Converter::convertVar()
Converts class variables for template output.
convertVar: in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertVar()
Converts class variables for template output
convertVar: in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertVar()
Converts class variables for template output.
convertVar: in file HTMLframesConverter.inc, method HTMLframesConverter::convertVar()
Converts class variables for template output
convertVar: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertVar()
Does nothing in this converter
convertVar: in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertVar()
convertVar: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertVar()
Converts class variables for template output
Convert_RIC: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Convert_RIC: in file HTMLframesConverter.inc, method HTMLframesConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Convert_RIC: in file PDFdefaultConverter.inc, method PDFdefaultConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Convert_RIC: in file CHMdefaultConverter.inc, method CHMdefaultConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
Convert_RIC: in file Converter.inc, method Converter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
copyFile: in file Converter.inc, method Converter::copyFile()
Copies a file from the template directory to the target directory
copyMediaRecursively: in file HTMLframesConverter.inc, method HTMLframesConverter::copyMediaRecursively()
copyMediaRecursively: in file CHMdefaultConverter.inc, method CHMdefaultConverter::copyMediaRecursively()
copyMediaRecursively: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::copyMediaRecursively()
createDocs: in file Setup.inc.php, method phpDocumentor_setup::createDocs()
createParentDir: in file Converter.inc, method Converter::createParentDir()
Recursively creates all subdirectories that don't exist in the $dir path
config.php: procedural page config.php
Classes.inc: procedural page Classes.inc
clone.inc.php: procedural page clone.inc.php
clone5.inc.php: procedural page clone5.inc.php
common.inc.php: procedural page common.inc.php
Converter.inc: procedural page Converter.inc
CHMdefaultConverter.inc: procedural page CHMdefaultConverter.inc
class.phpdocpdf.php: procedural page class.phpdocpdf.php

top

d

$data: in file Errors.inc, variable RecordWarning::$data
error string
$data: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$data
$data contains parsed structures for the current page being parsed
$datatype: in file ParserElements.inc, variable parserGlobal::$datatype
Name of the global's data type
$db_template: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$db_template
$defineconflicts: in file ProceduralPages.inc, variable ProceduralPages::$defineconflicts
Namespace conflicts within all documented packages of functions
$definesbyfile: in file ProceduralPages.inc, variable ProceduralPages::$definesbyfile
array of parsed defines organized by the full path of the file that contains the define.
$definesbynamefile: in file ProceduralPages.inc, variable ProceduralPages::$definesbynamefile
array of file names organized by defines that are in the file.
$define_elements: in file Converter.inc, variable Converter::$define_elements
alphabetized index of defines by package
$desc: in file ParserDocBlock.inc, variable parserDocBlock::$desc
$dirs: in file Setup.inc.php, variable phpDocumentor_setup::$dirs
contents of --directory commandline
$docblock: in file ParserElements.inc, variable parserElement::$docblock
$docblock: in file ParserData.inc, variable parserData::$docblock
DocBlock (parserDocBlock) for this page, or false if not set
debug: in file common.inc.php, function debug()
Debugging output
decideOnOrOff: in file Setup.inc.php, function decideOnOrOff()
Fuzzy logic to interpret the boolean args' intent
defaultHandler: in file Parser.inc, method ppageParser::defaultHandler()
Handles all non-inline tags
defaultTagHandler: in file Parser.inc, method Parser::defaultTagHandler()
Handles all standard tags that only have a description
defineLink: in file LinkClasses.inc, class defineLink
define link
dirList: in file Io.inc, method Io::dirList()
displayHelpMsg: in file Io.inc, method Io::displayHelpMsg()
create the help message for display on the command-line
doSimpleList: in file ParserDescCleanup.inc, method parserDescParser::doSimpleList()
Return a simple list, if found
dots: in file class.phpdocpdf.php, method phpdocpdf::dots()
DescHTML.inc: procedural page DescHTML.inc
DocBlockTags.inc: procedural page DocBlockTags.inc

top

e

$elements: in file Converter.inc, variable Converter::$elements
alphabetical index of all elements
$elements: in file ParserData.inc, variable parserData::$elements
array of parsed elements
$end: in file InlineTags.inc, variable parserSourceInlineTag::$end
Last line to display
$endlinenumber: in file ParserDocBlock.inc, variable parserDocBlock::$endlinenumber
Line number in the source on which this docblock ends
$endlinenumber: in file ParserElements.inc, variable parserElement::$endlinenumber
line number on file where this element stops
$errors: in file Errors.inc, variable ErrorTracker::$errors
array of RecordErrors
$eventHandlers: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$eventHandlers
$eventHandlers: in file phpDocumentorTParser.inc, variable phpDocumentorTParser::$eventHandlers
$eventHandlers: in file Tokenizer.php, variable phpDocumentor_XML_Beautifier_Tokenizer::$eventHandlers
$event_handlers: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$event_handlers
the functions which handle output from the Parser
$explicitcategory: in file ParserDocBlock.inc, variable parserDocBlock::$explicitcategory
fix for bug 708559
$explicitpackage: in file ParserDocBlock.inc, variable parserDocBlock::$explicitpackage
fix for bug 591396
$extends: in file ParserElements.inc, variable parserClass::$extends
elementCmp: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::elementCmp()
does a natural case sort on two parserElement descendants
EncloseList: in file Converter.inc, method Converter::EncloseList()
Used to convert the contents of <ol> or <ul> in a docblock
EncloseParagraph: in file Converter.inc, method Converter::EncloseParagraph()
Used to enclose a paragraph in a docblock
endCData: in file PackagePageElements.inc, method parserXMLDocBookTag::endCData()
Adds $_cdata to $value
endClass: in file CHMdefaultConverter.inc, method CHMdefaultConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endClass: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endClass: in file Converter.inc, method Converter::endClass()
Called by walk() while converting, when the last class element has been parsed.
endClass: in file XMLDocBookConverter.inc, method XMLDocBookConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endClass: in file HTMLframesConverter.inc, method HTMLframesConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endClass: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
endPage: in file XMLDocBookConverter.inc, method XMLDocBookConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
endPage: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
endPage: in file HTMLframesConverter.inc, method HTMLframesConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
endPage: in file Converter.inc, method Converter::endPage()
Called by walk() while converting, when the last procedural page element has been parsed.
endPage: in file CHMdefaultConverter.inc, method CHMdefaultConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
endTag: in file Parser.inc, method Parser::endTag()
Called to clean up at the end of parsing a @tag in a docblock
ErrorTracker: in file Errors.inc, class ErrorTracker
contains all the errors/warnings
EventStack: in file EventStack.inc, class EventStack
An event Stack
exampleProgramExample: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::exampleProgramExample()
Used to convert the {@example} inline tag in a docblock.
exampleProgramExample: in file Converter.inc, method Converter::exampleProgramExample()
Used to convert the {@example} inline tag in a docblock.
exampleTagHandler: in file Parser.inc, method Parser::exampleTagHandler()
handles @example
explicitDocBlock: in file ParserData.inc, method parserData::explicitDocBlock()
Tells this page that its DocBlock was not implicit
ezNewPage: in file class.phpdocpdf.php, method phpdocpdf::ezNewPage()
ezOutput: in file class.phpdocpdf.php, method phpdocpdf::ezOutput()
ezProcessText: in file class.phpdocpdf.php, method phpdocpdf::ezProcessText()
ezText: in file class.phpdocpdf.php, method phpdocpdf::ezText()
Errors.inc: procedural page Errors.inc
EventStack.inc: procedural page EventStack.inc

top

f

$file: in file ParserData.inc, variable parserPage::$file
filename.ext (no path)
$file: in file Errors.inc, variable RecordWarning::$file
file this error occurred in
$file: in file ParserElements.inc, variable parserElement::$file
location of this element (filename)
$fileAlias: in file LinkClasses.inc, variable abstractLink::$fileAlias
phpdoc alias _phpdoc_inc for phpdoc.inc
$files: in file Setup.inc.php, variable phpDocumentor_setup::$files
contents of --filename commandline
$font_dir: in file class.phpdocpdf.php, variable phpdocpdf::$font_dir
$funcglobals: in file ParserDocBlock.inc, variable parserDocBlock::$funcglobals
array of global variable data.
$functionconflicts: in file ProceduralPages.inc, variable ProceduralPages::$functionconflicts
Namespace conflicts within all documented packages of functions
$functionsbyfile: in file ProceduralPages.inc, variable ProceduralPages::$functionsbyfile
array of parsed functions organized by the full path of the file that contains the function.
$functionsbynamefile: in file ProceduralPages.inc, variable ProceduralPages::$functionsbynamefile
array of file names organized by functions that are in the file.
$function_data: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$function_data
$function_data: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$function_data
$function_elements: in file Converter.inc, variable Converter::$function_elements
alphabetized index of functions by package
file_dialog.php: procedural page file_dialog.php
fancy_debug: in file common.inc.php, function fancy_debug()
Returns a formatted var_dump for debugging purposes.
findGlobal: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::findGlobal()
Tell the phpDocumentorTWordParser to return the entire global variable if it is found.
flushHighlightCache: in file Converter.inc, method Converter::flushHighlightCache()
Return the close text for the current token
flushPackageXml: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::flushPackageXml()
formatFile: in file Beautifier.php, method phpDocumentor_peardoc2_XML_Beautifier::formatFile()
format a file or URL
formatIndex: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::formatIndex()
Does nothing
formatIndex: in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html
formatIndex: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html
formatIndex: in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatIndex()
CHMdefaultConverter uses this function to format template index.html and packages.html
formatIndex: in file Converter.inc, method Converter::formatIndex()
Called by walk() while converting.
formatIndex: in file HTMLframesConverter.inc, method HTMLframesConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html
formatLeftIndex: in file HTMLframesConverter.inc, method HTMLframesConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
formatLeftIndex: in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
formatLeftIndex: in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
formatLeftIndex: in file Converter.inc, method Converter::formatLeftIndex()
Called by walk() while converting.
formatLeftIndex: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::formatLeftIndex()
Creates package/lang/categoryname/packagename.xml for each package
formatLeftIndex: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
formatPkgIndex: in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here
formatPkgIndex: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::formatPkgIndex()
Does nothing
formatPkgIndex: in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatPkgIndex()
CHMdefaultConverter chooses to format both package indexes and the complete index here
formatPkgIndex: in file Converter.inc, method Converter::formatPkgIndex()
Called by walk() while converting.
formatPkgIndex: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here
formatPkgIndex: in file HTMLframesConverter.inc, method HTMLframesConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here
formatString: in file Beautifier.php, method phpDocumentor_peardoc2_XML_Beautifier::formatString()
format an XML string
formatTutorialTOC: in file HTMLframesConverter.inc, method HTMLframesConverter::formatTutorialTOC()
Use the template tutorial_toc.tpl to generate a table of contents for HTML
formatTutorialTOC: in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatTutorialTOC()
Use the template tutorial_toc.tpl to generate a table of contents for HTML
formatTutorialTOC: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatTutorialTOC()
Use the template tutorial_toc.tpl to generate a table of contents for HTML
formatTutorialTOC: in file Converter.inc, method Converter::formatTutorialTOC()
Creates a table of contents for a {@toc} inline tag in a tutorial
functionLink: in file LinkClasses.inc, class functionLink
function link
find_phpdoc.php: procedural page find_phpdoc.php

top

g

$globalconflicts: in file ProceduralPages.inc, variable ProceduralPages::$globalconflicts
Namespace conflicts within all documented packages of functions
$globals: in file ParserElements.inc, variable parserFunction::$globals
global declarations parsed from function definition
$globalsbyfile: in file ProceduralPages.inc, variable ProceduralPages::$globalsbyfile
array of parsed global variables organized by the full path of the file that contains the global variable definition.
$globalsbynamefile: in file ProceduralPages.inc, variable ProceduralPages::$globalsbynamefile
array of file names organized by global variables that are in the file.
$global_elements: in file Converter.inc, variable Converter::$global_elements
alphabetized index of global variables by package
generateChildClassList: in file Converter.inc, method Converter::generateChildClassList()
returns a list of child classes
generateChildClassList: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateChildClassList()
returns a list of child classes
generateElementIndex: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateElementIndex()
does nothing
generateElementIndex: in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateElementIndex()
Generate alphabetical index of all elements
generateElementIndex: in file HTMLframesConverter.inc, method HTMLframesConverter::generateElementIndex()
Generate alphabetical index of all elements
generateElementIndex: in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateElementIndex()
Generate alphabetical index of all elements
generateElementIndex: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateElementIndex()
Generate alphabetical index of all elements
generateFormattedClassTree: in file Converter.inc, method Converter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class.
generateFormattedClassTree: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
generateFormattedClassTree: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
generateFormattedClassTree: in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
generateFormattedClassTree: in file HTMLframesConverter.inc, method HTMLframesConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
generateFormattedClassTree: in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
generateFormattedClassTrees: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
generateFormattedClassTrees: in file HTMLframesConverter.inc, method HTMLframesConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
generateFormattedClassTrees: in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
generateFormattedClassTrees: in file PDFdefaultConverter.inc, method PDFdefaultConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
generateFormattedClassTrees: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateFormattedClassTrees()
returns a template-enabled array of class trees
generateFormattedClassTrees: in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
generateFormattedInterfaceTrees: in file HTMLframesConverter.inc, method HTMLframesConverter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
generateFormattedInterfaceTrees: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
generateFormattedInterfaceTrees: in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
generateFormattedInterfaceTrees: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
generateKLinks: in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateKLinks()
Get the table of contents for index.hhk
generatePkgElementIndex: in file XMLDocBookConverter.inc, method XMLDocBookConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
generatePkgElementIndex: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
generatePkgElementIndex: in file HTMLframesConverter.inc, method HTMLframesConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
generatePkgElementIndex: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
generatePkgElementIndex: in file CHMdefaultConverter.inc, method CHMdefaultConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
generatePkgElementIndexes: in file XMLDocBookConverter.inc, method XMLDocBookConverter::generatePkgElementIndexes()
generatePkgElementIndexes: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generatePkgElementIndexes()
generatePkgElementIndexes: in file CHMdefaultConverter.inc, method CHMdefaultConverter::generatePkgElementIndexes()
generatePkgElementIndexes: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generatePkgElementIndexes()
generatePkgElementIndexes: in file HTMLframesConverter.inc, method HTMLframesConverter::generatePkgElementIndexes()
generateTOC: in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateTOC()
getAllFiles: in file Io.inc, method Io::getAllFiles()
Take a filename with wildcards and return all files that match the
getBase: in file Io.inc, method Io::getBase()
Retrieve common directory (case-insensitive in windows)
getBlock: in file WordParser.inc, method WordParser::getBlock()
Unused
getCData: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getCData()
getCData: in file HTMLframesConverter.inc, method HTMLframesConverter::getCData()
getCData: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getCData()
getCData: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getCData()
getCData: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getCData()
getCData: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getCData()
getChildClassList: in file ParserElements.inc, method parserClass::getChildClassList()
returns a list of all child classes of this class
getClass: in file Classes.inc, method Classes::getClass()
Get the parserClass representation of a class from its name and file
getClass: in file ParserElements.inc, method parserVar::getClass()
Retrieve the class name
getClass: in file ParserElements.inc, method parserConst::getClass()
Retrieve the class name
getClass: in file ParserElements.inc, method parserMethod::getClass()
Return name of the class that contains this method
getClassByPackage: in file Classes.inc, method Classes::getClassByPackage()
Search for a class in a package
getClassContents: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassContents()
getClasses: in file ParserData.inc, method parserData::getClasses()
returns a list of all classes declared in a file
getClassesInPath: in file Classes.inc, method Classes::getClassesInPath()
Used by parserData::getClasses() to retrieve classes defined in file $path
getClassesOnPage: in file Converter.inc, method Converter::getClassesOnPage()
gets a list of all classes declared on a procedural page represented by
getClassLeft: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassLeft()
getClassLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getClassLink()
getClassLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getClassLink()
getClassLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassLink()
getClassLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getClassLink()
getClassLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getClassLink()
getClassLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getClassLink()
getClassLink: in file Converter.inc, method Converter::getClassLink()
return false or a classLink to $expr
getColor: in file class.phpdocpdf.php, method phpdocpdf::getColor()
This really should be in the parent class
getConflicts: in file ParserElements.inc, method parserClass::getConflicts()
Returns all classes in other packages that have the same name as this class
getConflicts: in file ParserElements.inc, method parserGlobal::getConflicts()
Returns all global variables in other packages that have the same name as this global variable
getConflicts: in file ParserElements.inc, method parserDefine::getConflicts()
Returns all defines in other packages that have the same name as this define
getConflicts: in file ParserElements.inc, method parserFunction::getConflicts()
Returns all functions in other packages that have the same name as this function
getConflicts: in file Classes.inc, method Classes::getConflicts()
If a package contains two classes with the same name, this function finds that conflict
getConstLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getConstLink()
getConstLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getConstLink()
getConstLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getConstLink()
getConstLink: in file Converter.inc, method Converter::getConstLink()
return false or a constLink to $expr in $class
getConstLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getConstLink()
getConstNames: in file ParserElements.inc, method parserClass::getConstNames()
getConsts: in file ParserElements.inc, method parserClass::getConsts()
getConverterDir: in file Converter.inc, method Converter::getConverterDir()
Get the absolute path to the converter's base directory
getCurrentPageLink: in file Converter.inc, method Converter::getCurrentPageLink()
getCurrentPageLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getCurrentPageLink()
getCurrentPageLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getCurrentPageLink()
getCurrentPageLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getCurrentPageLink()
getCurrentPageURL: in file Converter.inc, method Converter::getCurrentPageURL()
Return the path to the current
getDataType: in file ParserElements.inc, method parserGlobal::getDataType()
Retrieve converter-specific representation of the data type
getDefineLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getDefineLink()
getDefineLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getDefineLink()
getDefineLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getDefineLink()
getDefineLink: in file Converter.inc, method Converter::getDefineLink()
return false or a defineLink to $expr
getDefineLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getDefineLink()
getDefineLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getDefineLink()
getDefineLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getDefineLink()
getDefiniteChildren: in file Classes.inc, method Classes::getDefiniteChildren()
Get all classes confirmed in parsing to be descended class $parclass in file $file
getDesc: in file ParserDocBlock.inc, method parserDocBlock::getDesc()
getDescription: in file DocBlockTags.inc, method parserUsesTag::getDescription()
Get the description of how the element used is being used.
getDir: in file utilities.php, function getDir()
getDirTree: in file Io.inc, method Io::getDirTree()
getEndLineNumber: in file ParserElements.inc, method parserElement::getEndLineNumber()
getEndLineNumber: in file ParserDocBlock.inc, method parserDocBlock::getEndLineNumber()
Retrieve ending line number
getEvent: in file EventStack.inc, method EventStack::getEvent()
Get the current event
getExampleLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getExampleLink()
getExampleLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getExampleLink()
getExampleLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getExampleLink()
getExampleLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getExampleLink()
getExampleLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getExampleLink()
getExplicitCategory: in file ParserDocBlock.inc, method parserDocBlock::getExplicitCategory()
If the DocBlock has a @category tag, then this returns true
getExplicitPackage: in file ParserDocBlock.inc, method parserDocBlock::getExplicitPackage()
If the DocBlock has a @package tag, then this returns true
getExtends: in file ParserElements.inc, method parserClass::getExtends()
getFile: in file ParserElements.inc, method parserElement::getFile()
getFile: in file ParserData.inc, method parserPage::getFile()
gets the file name
getFileSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::getFileSource()
gets the source code tokens
getFileSourceName: in file Converter.inc, method Converter::getFileSourceName()
Translate the path info into a unique file name for the highlighted source code.
getFileSourceName: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getFileSourceName()
getFileSourcePath: in file Converter.inc, method Converter::getFileSourcePath()
Return the fixed path to the source-code file folder.
getFormattedConflicts: in file Converter.inc, method Converter::getFormattedConflicts()
getFormattedDescMethods: in file Converter.inc, method Converter::getFormattedDescMethods()
Get a list of methods in child classes that override this method
getFormattedDescVars: in file Converter.inc, method Converter::getFormattedDescVars()
Get a list of vars in child classes that override this var
getFormattedImplements: in file Converter.inc, method Converter::getFormattedImplements()
returns an array containing the class inheritance tree from the root object to the class.
getFormattedInheritedConsts: in file Converter.inc, method Converter::getFormattedInheritedConsts()
Return template-enabled list of inherited class constants
getFormattedInheritedMethods: in file Converter.inc, method Converter::getFormattedInheritedMethods()
Return template-enabled list of inherited methods
getFormattedInheritedVars: in file Converter.inc, method Converter::getFormattedInheritedVars()
Return template-enabled list of inherited variables
getFormattedMethodImplements: in file Converter.inc, method Converter::getFormattedMethodImplements()
Get the method this method(s) implemented from an interface, if any
getFormattedOverrides: in file Converter.inc, method Converter::getFormattedOverrides()
Get the method this method overrides, if any
getFunctionCall: in file ParserElements.inc, method parserFunction::getFunctionCall()
Get a human-friendly description of the function call
getFunctionCall: in file ParserElements.inc, method parserMethod::getFunctionCall()
adds "constructor " to start of function call if $isConstructor is true
getFunctionLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getFunctionLink()
getFunctionLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getFunctionLink()
getFunctionLink: in file Converter.inc, method Converter::getFunctionLink()
return false or a functionLink to $expr
getFunctionLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getFunctionLink()
getFunctionLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getFunctionLink()
getFunctionLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getFunctionLink()
getFunctionLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getFunctionLink()
getGlobalLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getGlobalLink()
getGlobalLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getGlobalLink()
getGlobalLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getGlobalLink()
getGlobalLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getGlobalLink()
getGlobalLink: in file Converter.inc, method Converter::getGlobalLink()
return false or a globalLink to $expr
getGlobalLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getGlobalLink()
getGlobalLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getGlobalLink()
getGlobalValue: in file Converter.inc, method Converter::getGlobalValue()
Parse a global variable's default value for class initialization.
getGlobalValue: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getGlobalValue()
getHighlightState: in file Converter.inc, method Converter::getHighlightState()
getId: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getId()
Get the id value needed to allow linking
getId: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getId()
getId: in file HTMLframesConverter.inc, method HTMLframesConverter::getId()
getId: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getId()
getId: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getId()
Get the id value needed to allow linking
getId: in file Converter.inc, method Converter::getId()
take abstractLink descendant and text $eltext and return a
getId: in file PackagePageElements.inc, method parserXMLDocBookTag::getId()
Return converter-specific formatting of ID.
getImplements: in file ParserElements.inc, method parserMethod::getImplements()
getImplements: in file ParserElements.inc, method parserClass::getImplements()
getIncludeValue: in file Converter.inc, method Converter::getIncludeValue()
Parse an include's file to see if it is a file documented in this project
getIndexInformation: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getIndexInformation()
Generate indexing information for given element
getIndexInformation: in file HTMLframesConverter.inc, method HTMLframesConverter::getIndexInformation()
Generate indexing information for given element
getIndexInformation: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getIndexInformation()
Generate indexing information for given element
getInheritedConsts: in file ParserElements.inc, method parserClass::getInheritedConsts()
getInheritedMethods: in file ParserElements.inc, method parserClass::getInheritedMethods()
getInheritedVars: in file ParserElements.inc, method parserClass::getInheritedVars()
getIntricateFunctionCall: in file ParserElements.inc, method parserMethod::getIntricateFunctionCall()
getIntricateFunctionCall: in file ParserElements.inc, method parserFunction::getIntricateFunctionCall()
Like getFunctionCall(), but has no English or pre-determined formatting.
getKeyword: in file ParserDocBlock.inc, method parserDocBlock::getKeyword()
getLineNumber: in file ParserElements.inc, method parserElement::getLineNumber()
getLineNumber: in file ParserDocBlock.inc, method parserDocBlock::getLineNumber()
Retrieve starting line number
getLink: in file ParserElements.inc, method parserTutorial::getLink()
Get a link to this tutorial, or to any subsection of this tutorial
getLink: in file ParserElements.inc, method parserFunction::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserMethod::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserClass::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserGlobal::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserVar::getLink()
quick way to link to this element
getLink: in file ParserElements.inc, method parserConst::getLink()
quick way to link to this element
getLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getLink()
do that stuff in $template_options
getLink: in file ParserElements.inc, method parserDefine::getLink()
quick way to link to this element
getLink: in file ParserData.inc, method parserData::getLink()
returns a link
getLink: in file Converter.inc, method Converter::getLink()
The meat of the @see tag and inline {@link} tag
getLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getLink()
do that stuff in $template_options
getMethod: in file ParserElements.inc, method parserClass::getMethod()
getMethodLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getMethodLink()
getMethodLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getMethodLink()
getMethodLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getMethodLink()
getMethodLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getMethodLink()
getMethodLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getMethodLink()
getMethodLink: in file Converter.inc, method Converter::getMethodLink()
return false or a methodLink to $expr in $class
getMethodLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getMethodLink()
getMethodNames: in file ParserElements.inc, method parserClass::getMethodNames()
getMethods: in file ParserElements.inc, method parserClass::getMethods()
getModifiers: in file ParserElements.inc, method parserVar::getModifiers()
Return a list of access modifiers (static/private/etc.)
getModifiers: in file ParserElements.inc, method parserMethod::getModifiers()
Return name of the class that contains this method
getModifiers: in file ParserElements.inc, method parserClass::getModifiers()
Get the PHP5+ modifiers for this class
getName: in file ParserElements.inc, method parserElement::getName()
getName: in file ParserData.inc, method parserData::getName()
Get the output-safe filename (. changed to _)
getName: in file ParserData.inc, method parserPage::getName()
gets the name
getNext: in file ParserElements.inc, method parserTutorial::getNext()
Retrieve converter-specific link to the next tutorial's documentation
getOverrides: in file ParserElements.inc, method parserVar::getOverrides()
getOverrides: in file ParserElements.inc, method parserMethod::getOverrides()
getOverridingMethods: in file ParserElements.inc, method parserMethod::getOverridingMethods()
getOverridingMethodsForClass: in file ParserElements.inc, method parserMethod::getOverridingMethodsForClass()
getOverridingVars: in file ParserElements.inc, method parserVar::getOverridingVars()
getOverridingVarsForClass: in file ParserElements.inc, method parserVar::getOverridingVarsForClass()
getPackage: in file ParserElements.inc, method parserElement::getPackage()
getPackageOutput: in file ParserData.inc, method parserPage::getPackageOutput()
gets the package output array
getPageContents: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageContents()
getPageLeft: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageLeft()
getPageLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getPageLink()
getPageLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getPageLink()
getPageLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageLink()
getPageLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getPageLink()
getPageLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getPageLink()
getPageLink: in file Converter.inc, method Converter::getPageLink()
return false or a pageLink to $expr
getPageLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getPageLink()
getPageName: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getPageName()
getPageName: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getPageName()
getPageName: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getPageName()
getPageName: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageName()
getPageName: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getPageName()
getPageName: in file HTMLframesConverter.inc, method HTMLframesConverter::getPageName()
getParam: in file ParserElements.inc, method parserFunction::getParam()
getParent: in file ParserElements.inc, method parserClass::getParent()
retrieve object that represents the parent class
getParent: in file ParserElements.inc, method parserTutorial::getParent()
Retrieve converter-specific link to the parent tutorial's documentation
getParentClass: in file Classes.inc, method Classes::getParentClass()
Find the parent class of a class in file $file
getParentClassTree: in file ParserElements.inc, method parserClass::getParentClassTree()
getParseData: in file ParserData.inc, method parserPage::getParseData()
Not implemented in this version
getParserEventName: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::getParserEventName()
searches for a parser event name based on its number
getParserEventName: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::getParserEventName()
getParserEventName: in file XMLpackagePageParser.inc, method XMLPackagePageParser::getParserEventName()
debugging function
getParserEventName: in file ParserDescCleanup.inc, method parserDescParser::getParserEventName()
getParserEventName: in file ParserPDF.inc, method PDFParser::getParserEventName()
Return the name of the parser event
getParserEventName: in file Parser.inc, method Parser::getParserEventName()
Debugging function, takes an event number and attempts to return its name
getPath: in file ParserData.inc, method parserPage::getPath()
gets the path
getPath: in file ParserElements.inc, method parserElement::getPath()
getPathInfo: in file ProceduralPages.inc, method ProceduralPages::getPathInfo()
gathers path-related info about a given element
getPos: in file WordParser.inc, method WordParser::getPos()
Returns the current pointer position, or 1 character after the end of the word
getPrev: in file ParserElements.inc, method parserTutorial::getPrev()
Retrieve converter-specific link to the previous tutorial's documentation
getProgramListing: in file InlineTags.inc, method parserExampleInlineTag::getProgramListing()
Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial
getReadmeInstallChangelog: in file Io.inc, method Io::getReadmeInstallChangelog()
getRealPath: in file ProceduralPages.inc, method ProceduralPages::getRealPath()
Ensures the path to the file is an absolute path
getRegExpableSearchString: in file Io.inc, method Io::getRegExpableSearchString()
Converts $s into a string that can be used with preg_match
getReturnsReference: in file ParserElements.inc, method parserFunction::getReturnsReference()
getRoots: in file Classes.inc, method Classes::getRoots()
Get a list of all root classes indexed by package. Used to generate class trees by Converter
getRootTree: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getRootTree()
return formatted class tree for the Class Trees page
getRootTree: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getRootTree()
return formatted class tree for the Class Trees page
getRootTree: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getRootTree()
return formatted class tree for the Class Trees page
getRootTree: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getRootTree()
return formatted class tree for the Class Trees page
getRootTree: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getRootTree()
return formatted class tree for the Class Trees page
getRootTree: in file HTMLframesConverter.inc, method HTMLframesConverter::getRootTree()
return formatted class tree for the Class Trees page
getSDesc: in file ParserDocBlock.inc, method parserDocBlock::getSDesc()
getSortedClassTreeFromClass: in file Converter.inc, method Converter::getSortedClassTreeFromClass()
Return a tree of all classes that extend this class
getSource: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::getSource()
loads up next set of source code
getSource: in file ParserElements.inc, method parserFunction::getSource()
getSource: in file WordParser.inc, method WordParser::getSource()
Retrieve source code for the last function/method
getSourceAnchor: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
getSourceAnchor: in file HTMLframesConverter.inc, method HTMLframesConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
getSourceAnchor: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
getSourceAnchor: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
getSourceAnchor: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
getSourceLink: in file Converter.inc, method Converter::getSourceLink()
getSourceLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getSourceLink()
getSourceLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getSourceLink()
getSourceLink: in file DocBlockTags.inc, method parserFileSourceTag::getSourceLink()
gets path to the sourcecode file
getSourceLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getSourceLink()
getSourceLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getSourceLink()
getSourceLink: in file DocBlockTags.inc, method parserExampleTag::getSourceLink()
Retrieve a converter-specific link to the example
getSourceLocation: in file ParserData.inc, method parserPage::getSourceLocation()
gets the source location
getSourceLocation: in file ParserElements.inc, method parserClass::getSourceLocation()
getState: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getState()
getState: in file Converter.inc, method Converter::getState()
Return parserStringWithInlineTags::Convert() cache state
getString: in file ParserData.inc, method parserStringWithInlineTags::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: in file DocBlockTags.inc, method parserAccessTag::getString()
No inline tags are possible, returns 'public', 'protected' or 'private'
getString: in file DocBlockTags.inc, method parserTag::getString()
Returns the text minus any inline tags
getString: in file InlineTags.inc, method parserInlineTag::getString()
always gets an empty string
getString: in file InlineTags.inc, method parserSourceInlineTag::getString()
gets the source string
getSubsection: in file PackagePageElements.inc, method parserXMLDocBookTag::getSubsection()
Retrieve the contents of a subsection
getTitle: in file PackagePageElements.inc, method parserXMLDocBookTag::getTitle()
Retrieve Converter-specific formatting of the title of this element
getTitle: in file ParserElements.inc, method parserTutorial::getTitle()
Retrieve the title of the tutorial, or of any subsection
getTOC: in file PackagePageElements.inc, method parserXMLDocBookTag::getTOC()
Retrieve either the table of contents index, or the location that the TOC will go
getTutorial: in file ParserData.inc, method parserData::getTutorial()
If this file has a tutorial associated with it, returns a link to the tutorial.
getTutorial: in file ParserElements.inc, method parserClass::getTutorial()
Get the associated tutorial for this class, if any
getTutorialId: in file HTMLframesConverter.inc, method HTMLframesConverter::getTutorialId()
getTutorialId: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getTutorialId()
getTutorialId: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getTutorialId()
getTutorialId: in file Converter.inc, method Converter::getTutorialId()
Return a converter-specific id to distinguish tutorials and their sections
getTutorialId: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getTutorialId()
getTutorialId: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getTutorialId()
getTutorialId: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getTutorialId()
getTutorialLink: in file Converter.inc, method Converter::getTutorialLink()
The meat of the @tutorial tag and inline {@tutorial} tag
getTutorialList: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getTutorialList()
getTutorials: in file Io.inc, method Io::getTutorials()
Retrieve tutorial subdirectories and their contents from the list of
getTutorialTree: in file Converter.inc, method Converter::getTutorialTree()
Get a tree structure representing the hierarchy of tutorials
getTutorialTree: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getTutorialTree()
getTutorialTree: in file HTMLframesConverter.inc, method HTMLframesConverter::getTutorialTree()
getType: in file ParserData.inc, method parserPage::getType()
gets the tag type
getType: in file ParserData.inc, method parserBase::getType()
gets the type
getType: in file ParserDocBlock.inc, method parserDocBlock::getType()
getValue: in file ParserData.inc, method parserBase::getValue()
gets the value
getVar: in file ParserElements.inc, method parserClass::getVar()
getVarLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::getVarLink()
getVarLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getVarLink()
getVarLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::getVarLink()
getVarLink: in file Converter.inc, method Converter::getVarLink()
return false or a varLink to $expr in $class
getVarLink: in file HTMLframesConverter.inc, method HTMLframesConverter::getVarLink()
getVarLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getVarLink()
getVarLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::getVarLink()
getVarNames: in file ParserElements.inc, method parserClass::getVarNames()
getVars: in file ParserElements.inc, method parserClass::getVars()
getWord: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::getWord()
Retrieve a token for the phpDocumentorTParser
getWord: in file ParserDescCleanup.inc, method ObjectWordParser::getWord()
getWord: in file WordParser.inc, method WordParser::getWord()
Retrieve a token from the token list
getWord: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::getWord()
Retrieve the next token
getYPlusOffset: in file class.phpdocpdf.php, method phpdocpdf::getYPlusOffset()
get_include_path: in file Io.inc, function get_include_path()
globalLink: in file LinkClasses.inc, class globalLink
global variable link
globalTagHandler: in file Parser.inc, method Parser::globalTagHandler()
handles @global

top

h

$hasaccess: in file ParserDocBlock.inc, variable parserDocBlock::$hasaccess
whether this DocBlock has an @access tag
$hasname: in file ParserDocBlock.inc, variable parserDocBlock::$hasname
whether this DocBlock has a @name tag
$hidden: in file Setup.inc.php, variable phpDocumentor_setup::$hidden
contents of --hidden commandline
$highlightingSource: in file Converter.inc, variable Converter::$highlightingSource
Flag used to help converters determine whether to do special source highlighting
handleClass: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleClass()
handles post-parsing of classes
handleConst: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleConst()
handles post-parsing of class constants
handleDefine: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleDefine()
handles post-parsing of defines
handleDocBlock: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleDocBlock()
handles post-parsing of DocBlocks
handleEvent: in file Errors.inc, method ErrorTracker::handleEvent()
This function subscribes to two events in the Parser in order to keep track of line number information and file name.
HandleEvent: in file DocBlockTags.inc, method parserTag::HandleEvent()
Called by the parserDescParser when processing a description.
HandleEvent: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::HandleEvent()
called via Parser::parse() and Parser's inherited method Publisher::publishEvent()
handleFunction: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleFunction()
handles post-parsing of functions
handleGlobal: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleGlobal()
handles post-parsing of global variables
handleInclude: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleInclude()
handles post-parsing of include/require/include_once/require_once
handleInlineDockeyword: in file Parser.inc, method ppageParser::handleInlineDockeyword()
handler for INLINE_DOCKEYWORD.
handleMethod: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleMethod()
handles post-parsing of class methods
handlePackagePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handlePackagePage()
handles post-parsing of Package-level documentation pages.
handlePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handlePage()
handles post-parsing of procedural pages
handleTutorial: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleTutorial()
handle post-parsing of Tutorials.
handleVar: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::handleVar()
handles post-parsing of class vars
hasClasses: in file ParserData.inc, method parserData::hasClasses()
Does this package have classes?
hasConst: in file ParserElements.inc, method parserClass::hasConst()
hasExplicitDocBlock: in file ParserData.inc, method parserData::hasExplicitDocBlock()
If the page-level DocBlock was present in the source, returns true
hasInheritDoc: in file ParserDocBlock.inc, method parserDocBlock::hasInheritDoc()
Wrapper for parserDesc::hasInheritDoc()
hasInheritDoc: in file ParserDocBlock.inc, method parserDesc::hasInheritDoc()
hasInlineTag: in file ParserData.inc, method parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
hasInterfaces: in file ParserData.inc, method parserData::hasInterfaces()
Does this package have interfaces?
hasMethod: in file ParserElements.inc, method parserClass::hasMethod()
hasSource: in file ParserDocBlock.inc, method parserDesc::hasSource()
hasSource: in file ParserElements.inc, method parserFunction::hasSource()
Determine whether the source code has been requested via {@source}
hasSourceCode: in file Converter.inc, method Converter::hasSourceCode()
Determine whether an element's file has generated source code, used for linking to line numbers of source.
hasTitle: in file PackagePageElements.inc, method parserXMLDocBookTag::hasTitle()
Determine whether the docbook element has a title
hasTutorial: in file Converter.inc, method Converter::hasTutorial()
hasVar: in file ParserElements.inc, method parserClass::hasVar()
highlightDocBlockSource: in file Converter.inc, method Converter::highlightDocBlockSource()
Used to allow converters to format the source code of DocBlocks the way they'd like.
highlightSource: in file Converter.inc, method Converter::highlightSource()
Used to allow converters to format the source code the way they'd like.
highlightTutorialSource: in file Converter.inc, method Converter::highlightTutorialSource()
Used to allow converters to format the source code of Tutorial XML the way they'd like.
htmlArraySelect: in file utilities.php, function htmlArraySelect()
Returns a select box based on an key,value array where selected is based on key
HTMLframesConverter: in file HTMLframesConverter.inc, method HTMLframesConverter::HTMLframesConverter()
sets $base_dir to $targetDir
HTMLframesConverter: in file HTMLframesConverter.inc, class HTMLframesConverter
HTML output converter.
HTMLSmartyConverter: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::HTMLSmartyConverter()
HTMLSmartyConverter: in file HTMLSmartyConverter.inc, class HTMLSmartyConverter
HTML output converter.
HTMLframesConverter.inc: procedural page HTMLframesConverter.inc
HTMLSmartyConverter.inc: procedural page HTMLSmartyConverter.inc
HighlightParser.inc: procedural page HighlightParser.inc
HighlightParserTests.php: procedural page HighlightParserTests.php

top

i

$id: in file InlineTags.inc, variable parserIdInlineTag::$id
section/subsection name
$id: in file ParserData.inc, variable parserPage::$id
not implemented in this version, will be used to link xml output pages
$ignore: in file Io.inc, variable Io::$ignore
Format: array(array(regexp-ready string to search for whole path,
$ignore: in file ParserElements.inc, variable parserClass::$ignore
Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing
$ignorepages: in file ProceduralPages.inc, variable ProceduralPages::$ignorepages
array of all procedural pages ordered by name
$ignoresymlinks: in file Setup.inc.php, variable phpDocumentor_setup::$ignoresymlinks
contents of --ignoresymlinks commandline
$ignore_files: in file Setup.inc.php, variable phpDocumentor_setup::$ignore_files
contents of --ignore commandline
$includesbyfile: in file ProceduralPages.inc, variable ProceduralPages::$includesbyfile
array of parsed includes organized by the full path of the file that contains the include.
$indents: in file class.phpdocpdf.php, variable phpdocpdf::$indents
$indexContents: in file class.phpdocpdf.php, variable phpdocpdf::$indexContents
$ini: in file ParserElements.inc, variable parserTutorial::$ini
output from tutorialname.ext.ini
$inlineTagHandlers: in file phpDocumentorTParser.inc, variable phpDocumentorTParser::$inlineTagHandlers
$inlinetype: in file InlineTags.inc, variable parserTocInlineTag::$inlinetype
always 'toc'
$inlinetype: in file InlineTags.inc, variable parserSourceInlineTag::$inlinetype
always 'source'
$inlinetype: in file InlineTags.inc, variable parserInheritdocInlineTag::$inlinetype
always 'inheritdoc'
$inlinetype: in file InlineTags.inc, variable parserIdInlineTag::$inlinetype
always 'id'
$inlinetype: in file InlineTags.inc, variable parserInlineTag::$inlinetype
the name of the inline tag (like link)
$interface: in file Setup.inc.php, global variable $interface
$interface is either 'web' or is not set at all
$isConstructor: in file ParserElements.inc, variable parserMethod::$isConstructor
$isDestructor: in file ParserElements.inc, variable parserMethod::$isDestructor
$isvalid: in file DocBlockTags.inc, variable parserAccessTag::$isvalid
set to true if the returned tag has a value type of private, protected
$items: in file DescHTML.inc, variable parserList::$items
ignorePage: in file ProceduralPages.inc, method ProceduralPages::ignorePage()
moves a page from the $pages array to the $ignorepages array
incdataHandler: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::incdataHandler()
Handler for real character data
indent: in file class.phpdocpdf.php, method phpdocpdf::indent()
index: in file class.phpdocpdf.php, method phpdocpdf::index()
IndexLetter: in file class.phpdocpdf.php, method phpdocpdf::IndexLetter()
Inherit: in file Classes.inc, method Classes::Inherit()
Main processing engine for setting up class inheritance.
invalidTagHandler: in file Parser.inc, method Parser::invalidTagHandler()
Handles tags like '@filesource' that only work in PHP 4.3.0+
Io: in file Io.inc, method Io::Io()
creates an array $this->phpDocOptions and sets program options in it.
Io: in file Io.inc, class Io
Class to handle file and user io opperations
Ioinc_mystrucsort: in file Io.inc, function Ioinc_mystrucsort()
Sorting functions for the file list
Ioinc_sortfiles: in file Io.inc, function Ioinc_sortfiles()
Sorting functions for the file list
isChildOf: in file ParserElements.inc, method parserTutorial::isChildOf()
Determine if this parserTutorial object is a child of another
isClean: in file ParserData.inc, method parserData::isClean()
checks if the element is "cleaned" already
isIncludeable: in file Io.inc, method Io::isIncludeable()
calls http://www.php.net/file_exists for each value in include_path,
isInterface: in file ParserElements.inc, method parserClass::isInterface()
Italicize: in file Converter.inc, method Converter::Italicize()
Used to convert the contents of in a docblock
InlineTags.inc: procedural page InlineTags.inc
IntermediateParser.inc: procedural page IntermediateParser.inc
Io.inc: procedural page Io.inc
IntermediateParserTests.php: procedural page IntermediateParserTests.php

top

j

$juststarted: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$juststarted
controls formatting of parser informative output
$juststarted: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$juststarted
controls formatting of parser informative output
$juststarted: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$juststarted
controls formatting of parser informative output
$juststarted: in file HTMLframesConverter.inc, variable HTMLframesConverter::$juststarted
controls formatting of parser informative output
$juststarted: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$juststarted
controls formatting of parser informative output

top

k

$keyword: in file DocBlockTags.inc, variable parserStaticvarTag::$keyword
always 'staticvar'
$keyword: in file DocBlockTags.inc, variable parserSeeTag::$keyword
always 'see'
$keyword: in file DocBlockTags.inc, variable parserReturnTag::$keyword
always 'return'
$keyword: in file DocBlockTags.inc, variable parserPropertyWriteTag::$keyword
always 'property-write'
$keyword: in file DocBlockTags.inc, variable parserTag::$keyword
tag name (see, access, etc.)
$keyword: in file DocBlockTags.inc, variable parserTutorialTag::$keyword
Always "tutorial"
$keyword: in file DocBlockTags.inc, variable parserVarTag::$keyword
always 'var'
$keyword: in file DocBlockTags.inc, variable parserUsesTag::$keyword
Always "uses"
$keyword: in file DocBlockTags.inc, variable parserUsedByTag::$keyword
Always "usedby"
$keyword: in file DocBlockTags.inc, variable parserPropertyTag::$keyword
always 'property'
$keyword: in file DocBlockTags.inc, variable parserPropertyReadTag::$keyword
always 'property-read'
$keyword: in file DocBlockTags.inc, variable parserFileSourceTag::$keyword
Always "filesource"
$keyword: in file DocBlockTags.inc, variable parserExampleTag::$keyword
always "example"
$keyword: in file DocBlockTags.inc, variable parserAccessTag::$keyword
tag name
$keyword: in file DocBlockTags.inc, variable parserLicenseTag::$keyword
always 'license'
$keyword: in file DocBlockTags.inc, variable parserLinkTag::$keyword
always 'link'
$keyword: in file DocBlockTags.inc, variable parserParamTag::$keyword
always 'param'
$keyword: in file DocBlockTags.inc, variable parserNameTag::$keyword
tag name
$keyword: in file DocBlockTags.inc, variable parserMethodTag::$keyword
always 'method'
$KLinks: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$KLinks
Table of Contents entry for index.hhk
Kbdize: in file Converter.inc, method Converter::Kbdize()
Used to convert the contents of <kbd> in a docblock

top

l

$last: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$last
$lasterror: in file Errors.inc, variable ErrorTracker::$lasterror
index in $errors of last error triggered
$lasttype: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$lasttype
type of the last parser Element handled
$lastwarning: in file Errors.inc, variable ErrorTracker::$lastwarning
index in $warnings of last warning triggered
$leftindex: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$leftindex
indexes of elements by package that need to be generated
$leftindex: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$leftindex
$leftindex: in file HTMLframesConverter.inc, variable HTMLframesConverter::$leftindex
indexes of elements by package that need to be generated
$leftindex: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$leftindex
indexes of elements by package that need to be generated
$leftindex: in file Converter.inc, variable Converter::$leftindex
Controls which of the one-element-only indexes are generated.
$leftindex: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$leftindex
indexes of elements by package that need to be generated
$leftindex: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$leftindex
indexes of elements by package that need to be generated
$linenum: in file Errors.inc, variable RecordWarning::$linenum
line number of the file this error occurred in
$linenum: in file Errors.inc, variable ErrorTracker::$linenum
$linenumber: in file ParserElements.inc, variable parserElement::$linenumber
Line number in the source on which this element appears
$linenumber: in file ParserDocBlock.inc, variable parserDocBlock::$linenumber
Line number in the source on which this docblock begins
$linked_element: in file ParserElements.inc, variable parserTutorial::$linked_element
The documentable element this tutorial is linked to
$links: in file ParserData.inc, variable parserData::$links
array of links descended from abstractLink
$linktext: in file InlineTags.inc, variable parserLinkInlineTag::$linktext
text to display in the link, can be different from the link for standard
$listType: in file class.phpdocpdf.php, variable phpdocpdf::$listType
$local: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$local
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
$local: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$local
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
listGlobals: in file ParserElements.inc, method parserFunction::listGlobals()
ListItem: in file Converter.inc, method Converter::ListItem()
Used to convert the contents of <li> in a docblock
listParams: in file ParserElements.inc, method parserFunction::listParams()
listParams: in file ParserDocBlock.inc, method parserDocBlock::listParams()
listProperties: in file ParserDocBlock.inc, method parserDocBlock::listProperties()
listStatics: in file ParserElements.inc, method parserFunction::listStatics()
listTags: in file ParserDocBlock.inc, method parserDocBlock::listTags()
LinkClasses.inc: procedural page LinkClasses.inc

top

m

$method_data: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$method_data
$method_data: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$method_data
$modDate: in file ParserData.inc, variable parserPage::$modDate
not implemented yet
main: in file HighlightParserTests.php, method tests_HighlightParserTests::main()
main: in file phpDocumentorTParserTests.php, method tests_phpDocumentorTParserTests::main()
main: in file phpDocumentorSetupTests.php, method tests_phpDocumentorSetupTests::main()
main: in file ParserPageTests.php, method tests_ParserPageTests::main()
main: in file ParserClassTests.php, method tests_ParserClassTests::main()
main: in file IntermediateParserTests.php, method tests_IntermediateParserTests::main()
makeLeft: in file HTMLframesConverter.inc, method HTMLframesConverter::makeLeft()
makeLeft: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::makeLeft()
makeLeft: in file XMLDocBookConverter.inc, method XMLDocBookConverter::makeLeft()
makeLeft: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::makeLeft()
methodLink: in file LinkClasses.inc, class methodLink
method link
mystrnatcasecmp: in file PDFdefaultConverter.inc, method PDFdefaultConverter::mystrnatcasecmp()

top

n

$name: in file ParserData.inc, variable parserPage::$name
phpdoc-safe name (only letters, numbers and _)
$name: in file PackagePageElements.inc, variable parserXMLDocBookTag::$name
Name of the tag
$name: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$name
$name: in file ParserElements.inc, variable parserElement::$name
name of this element, or include type if element is a parserInclude
$name: in file ParserElements.inc, variable parserTutorial::$name
filename minus extension of this tutorial (used for @tutorial tag)
$name: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$name
$name: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$name
$name: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$name
$name: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$name
$name: in file LinkClasses.inc, variable abstractLink::$name
$name: in file HTMLframesConverter.inc, variable HTMLframesConverter::$name
$next: in file ParserElements.inc, variable parserTutorial::$next
link to the next tutorial in a document series, or false if none
$num: in file Errors.inc, variable RecordWarning::$num
error number
$num: in file EventStack.inc, variable EventStack::$num
The number of events in the stack
$numbered: in file DescHTML.inc, variable parserList::$numbered
newLineNum: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::newLineNum()
advances output to a new line
newLineNum: in file HighlightParser.inc, method phpDocumentor_HighlightParser::newLineNum()
wraps the current line (via the converter) and resets it to empty
newSmarty: in file Converter.inc, method Converter::newSmarty()
Return a Smarty template object to operate with
new_phpdoc.php: procedural page new_phpdoc.php
nextFile: in file Classes.inc, method Classes::nextFile()
Prepare to parse a new file
nextIsObjectOrNonNL: in file ParserDescCleanup.inc, method ObjectWordParser::nextIsObjectOrNonNL()
Determine if the next word is an inline tag
nextToken: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::nextToken()
Retrieve the position of the next token that will be parsed in the internal token array

top

o

$origName: in file ParserData.inc, variable parserPage::$origName
original phpdoc-safe name (only letters, numbers and _)
$outputformat: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$outputformat
$outputformat: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$outputformat
$outputformat: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$outputformat
$outputformat: in file HTMLframesConverter.inc, variable HTMLframesConverter::$outputformat
$outputformat: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$outputformat
$outputformat: in file Converter.inc, variable Converter::$outputformat
output format of this converter
$outputformat: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$outputformat
ObjectWordParser: in file ParserDescCleanup.inc, class ObjectWordParser
Like WordParser but designed to handle an array with strings and
ObjectWordParser: in file ParserDescCleanup.inc, method ObjectWordParser::ObjectWordParser()
orderedBullet: in file class.phpdocpdf.php, method phpdocpdf::orderedBullet()
Output: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::Output()
Generate the constants.xml, packagename.xml, and globals.xml files
Output: in file XMLDocBookConverter.inc, method XMLDocBookConverter::Output()
This function is not used by HTMLdefaultConverter, but is required by Converter
Output: in file PDFdefaultConverter.inc, method PDFdefaultConverter::Output()
calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir
Output: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::Output()
This function is not used by HTMLdefaultConverter, but is required by Converter
Output: in file Converter.inc, method Converter::Output()
do all necessary output
Output: in file CHMdefaultConverter.inc, method CHMdefaultConverter::Output()
Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file
output: in file Errors.inc, method RecordError::output()
prints the error
output: in file Errors.inc, method RecordWarning::output()
prints the warning
Output: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::Output()
call this method once parsing has completed.
Output: in file HTMLframesConverter.inc, method HTMLframesConverter::Output()
This function is not used by HTMLdefaultConverter, but is required by Converter
overridePackage: in file ParserDocBlock.inc, method parserDocBlock::overridePackage()
set the element's package to the passed values. Used in phpDocumentor_IntermediateParser to align package of

top

p

$package: in file InlineTags.inc, variable parserIdInlineTag::$package
package of the {@id}
$package: in file ParserElements.inc, variable parserPackagePage::$package
$package: in file ParserDocBlock.inc, variable parserDocBlock::$package
$package: in file Parser.inc, variable ppageParser::$package
$package: in file ParserData.inc, variable parserPage::$package
$package: in file ParserElements.inc, variable parserTutorial::$package
$package: in file Converter.inc, variable Converter::$package
package name currently being converted
$package: in file LinkClasses.inc, variable abstractLink::$package
$packagecategories: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$packagecategories
Used to determine the category for tutorials.
$packagecategories: in file Converter.inc, variable Converter::$packagecategories
Packages associated with categories
$packagedescrip: in file ParserDocBlock.inc, variable parserDocBlock::$packagedescrip
description of package parsed from @package tag
$packageOutput: in file ParserData.inc, variable parserPage::$packageOutput
Used to limit output, contains contents of --packageoutput commandline.
$packageoutput: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$packageoutput
array of packages to parser and output documentation for, if not all packages should be documented
$packages: in file Setup.inc.php, variable phpDocumentor_setup::$packages
Packages to create documentation for
$packagexml: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$packagexml
Contents of the packagename.xml file are stored in this template variable
$package_elements: in file Converter.inc, variable Converter::$package_elements
alphabetical index of all elements sorted by package, subpackage, page, and class.
$package_output: in file Converter.inc, variable Converter::$package_output
set to value of -po commandline
$package_pages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$package_pages
array of parsed package pages
$package_pages: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$package_pages
array of converted package page names.
$package_pages: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$package_pages
array of converted package page names.
$package_pages: in file HTMLframesConverter.inc, variable HTMLframesConverter::$package_pages
array of converted package page names.
$package_pages: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$package_pages
array of converted package page names.
$package_pages: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$package_pages
array of converted package page names.
$package_parents: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$package_parents
Keeps track of packages of classes that have parent classes in another package. Used in automatic linking.
$package_parents: in file Converter.inc, variable Converter::$package_parents
Hierarchy of packages
$page: in file Converter.inc, variable Converter::$page
name of current page being converted
$page: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page
name of current page being converted
$page: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$page
name of current page being converted
$pageclasspackages: in file ProceduralPages.inc, variable ProceduralPages::$pageclasspackages
array of packages assigned to classes in a file, ordered by fullpath
$pageconflicts: in file ProceduralPages.inc, variable ProceduralPages::$pageconflicts
Namespace conflicts within all documented pages
$pagepackages: in file ProceduralPages.inc, variable ProceduralPages::$pagepackages
array of packages ordered by full path
$pagepackage_pagenums: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$pagepackage_pagenums
$pages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$pages
$pages: in file ProceduralPages.inc, variable ProceduralPages::$pages
array of all procedural pages ordered by name
$page_contents: in file Converter.inc, variable Converter::$page_contents
alphabetical index of all elements on a page by package/subpackage
$page_data: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$page_data
template for the procedural page currently being processed
$page_data: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page_data
template for the procedural page currently being processed
$page_data: in file Converter.inc, variable Converter::$page_data
template for the procedural page currently being processed
$page_dir: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$page_dir
output directory for the current procedural page being processed
$page_dir: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$page_dir
output directory for the current procedural page being processed
$page_dir: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$page_dir
output directory for the current procedural page being processed
$page_dir: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page_dir
output directory for the current procedural page being processed
$page_dir: in file HTMLframesConverter.inc, variable HTMLframesConverter::$page_dir
output directory for the current procedural page being processed
$page_elements: in file Converter.inc, variable Converter::$page_elements
alphabetized index of procedural pages by package
$params: in file ParserDocBlock.inc, variable parserDocBlock::$params
array of param data.
$params: in file ParserElements.inc, variable parserFunction::$params
parameters parsed from function definition.
$parent: in file ParserData.inc, variable parserData::$parent
parserPage element that is this parserData's parent, or false if not set.
$parent: in file ParserElements.inc, variable parserClass::$parent
Format: array(file, parent) where parent class is found or false if no parent
$parent: in file ParserElements.inc, variable parserTutorial::$parent
link to the parent tutorial in a document series, or false if none
$pars: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$pars
$parse: in file Setup.inc.php, variable phpDocumentor_setup::$parse
The main parser
$parseprivate: in file Converter.inc, variable Converter::$parseprivate
controls processing of elements marked private with @access private
$parsePrivate: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$parsePrivate
set in Setup.inc.php to the value of the parseprivate commandline
$parserVersion: in file ParserData.inc, variable parserPage::$parserVersion
$path: in file LinkClasses.inc, variable abstractLink::$path
$path: in file ParserElements.inc, variable parserTutorial::$path
path to the tutorial page
$path: in file ParserElements.inc, variable parserElement::$path
full path location of this element (filename)
$path: in file Converter.inc, variable Converter::$path
path of current page being converted
$path: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$path
path of current page being converted
$path: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$path
path of current page being converted
$path: in file ParserData.inc, variable parserPage::$path
$path: in file DocBlockTags.inc, variable parserFileSourceTag::$path
$pathpages: in file ProceduralPages.inc, variable ProceduralPages::$pathpages
array of all procedural page names ordered by full path to the file
$pdf: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$pdf
$phpDocOptions: in file Io.inc, variable Io::$phpDocOptions
Holds all the options that are avaible to the cmd line interface
$phpDocumentor_DefaultCategoryName: in file Setup.inc.php, global variable $phpDocumentor_DefaultCategoryName
default package name, set using -dn --defaultcategoryname
$phpDocumentor_DefaultPackageName: in file Setup.inc.php, global variable $phpDocumentor_DefaultPackageName
default package name, set using -dn --defaultpackagename
$phpDocumentor_errors: in file Errors.inc, global variable $phpDocumentor_errors
$phpDocumentor_error_descrip: in file Errors.inc, global variable $phpDocumentor_error_descrip
Error messages for phpDocumentor parser errors
$phpDocumentor_warning_descrip: in file Errors.inc, global variable $phpDocumentor_warning_descrip
Error messages for phpDocumentor parser warnings
$pkg_elements: in file Converter.inc, variable Converter::$pkg_elements
alphabetical index of all elements, indexed by package/subpackage
$popEvent: in file Publisher.inc, variable Publisher::$popEvent
$prev: in file ParserElements.inc, variable parserTutorial::$prev
link to the previous tutorial in a document series, or false if none
$privateclasselements: in file ParserData.inc, variable parserData::$privateclasselements
array of parsed class elements with @access private
$privateelements: in file ParserData.inc, variable parserData::$privateelements
array of parsed elements with @access private
$privatepages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$privatepages
Put away a page that has been @ignored or @access private if !$parsePrivate
$private_class: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$private_class
this variable is used to prevent parsing of elements with an @ignore tag
$proceduralpages: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$proceduralpages
used to keep track of all elements in a procedural page. Handles name
$processed_desc: in file ParserDocBlock.inc, variable parserDocBlock::$processed_desc
$processed_sdesc: in file ParserDocBlock.inc, variable parserDocBlock::$processed_sdesc
$processSpecialRoots: in file HTMLframesConverter.inc, variable HTMLframesConverter::$processSpecialRoots
This converter knows about the new root tree processing
$processSpecialRoots: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$processSpecialRoots
This converter knows about the new root tree processing
$processSpecialRoots: in file Converter.inc, variable Converter::$processSpecialRoots
This converter knows about the new root tree processing
$processSpecialRoots: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$processSpecialRoots
This converter knows about the new root tree processing
$properties: in file ParserDocBlock.inc, variable parserDocBlock::$properties
array of parserPropertyTag, parserPropertyReadTag, parserPropertyWriteTag, parserMethodTag magic tags
$pushEvent: in file Publisher.inc, variable Publisher::$pushEvent
packageTagHandler: in file Parser.inc, method Parser::packageTagHandler()
handles @package
pageLink: in file LinkClasses.inc, class pageLink
procedural page link
paramTagHandler: in file Parser.inc, method Parser::paramTagHandler()
handles @param
parse: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::parse()
Parse a new file
parse: in file Parser.inc, method Parser::parse()
Parse a new file
parse: in file ParserDescCleanup.inc, method parserDescParser::parse()
Parse a long or short description for tags
parse: in file phpDocumentorTParser.inc, method phpDocumentorTParser::parse()
Parse a new file
parse: in file Parser.inc, method ppageParser::parse()
Parse a new file
parse: in file HighlightParser.inc, method phpDocumentor_HighlightParser::parse()
Parse a new file
parse: in file XMLpackagePageParser.inc, method XMLPackagePageParser::parse()
Parse a new file
parse: in file ParserPDF.inc, method PDFParser::parse()
Parse text for PDFParser XML tags, and add the text to the PDF file
parseArgv: in file Io.inc, method Io::parseArgv()
Parses $_SERVER['argv'] and creates a setup array
parseHiddenFiles: in file Setup.inc.php, method phpDocumentor_setup::parseHiddenFiles()
parseIni: in file Setup.inc.php, method phpDocumentor_setup::parseIni()
Parse configuration file phpDocumentor.ini
parsePackagePage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::parsePackagePage()
Backward-compatibility only, use the new tutorials for more power
Parser: in file Parser.inc, method Parser::Parser()
Set up invariant parsing variables
Parser: in file Parser.inc, class Parser
PHP Parser for PHP 4.2.3-
parserAccessTag: in file DocBlockTags.inc, class parserAccessTag
This class represents the @access tag
parserAccessTag: in file DocBlockTags.inc, method parserAccessTag::parserAccessTag()
checks $value to make sure it is private, protected or public, otherwise it's not a valid @access tag
parserB: in file DescHTML.inc, class parserB
Used for in a description
parserBase: in file ParserData.inc, class parserBase
Base class for all elements
parserBr: in file DescHTML.inc, class parserBr
Used for in a description
parserCData: in file PackagePageElements.inc, class parserCData
Represents <![CDATA[ ]]> sections.
parserClass: in file ParserElements.inc, class parserClass
parserCode: in file DescHTML.inc, class parserCode
Used for <code> in a description
parserConst: in file ParserElements.inc, method parserConst::parserConst()
parserConst: in file ParserElements.inc, class parserConst
parserData: in file ParserData.inc, class parserData
Contains an in-memory representation of all documentable elements (parserPage, parserFunction, parserDefine, parserInclude, parserClass, parserMethod, parserVar) and their DocBlocks (parserDocBlock).
parserDefine: in file ParserElements.inc, class parserDefine
parserDesc: in file ParserDocBlock.inc, class parserDesc
represents a short or long description in a DocBlock (parserDocBlock)
parserDescParser: in file ParserDescCleanup.inc, class parserDescParser
Parses a DocBlock description to retrieve abstract representations of
parserDescParser: in file ParserDescCleanup.inc, method parserDescParser::parserDescParser()
sets $wp to be a ObjectWordParser
parserDescVar: in file DescHTML.inc, class parserDescVar
Used for <var> in a description
parserDocBlock: in file ParserDocBlock.inc, class parserDocBlock
Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions
parserDocBlock: in file ParserDocBlock.inc, method parserDocBlock::parserDocBlock()
sets package to default
parserElement: in file ParserElements.inc, class parserElement
all elements except parserPackagePage descend from this abstract class
parserEntity: in file PackagePageElements.inc, method parserEntity::parserEntity()
sets up the entity
parserEntity: in file PackagePageElements.inc, class parserEntity
a standard entity like ”
parserExampleInlineTag: in file InlineTags.inc, class parserExampleInlineTag
Represents the example inline tag, used to display an example file inside a docblock or tutorial
parserExampleInlineTag: in file InlineTags.inc, method parserExampleInlineTag::parserExampleInlineTag()
constructor
parserExampleTag: in file DocBlockTags.inc, method parserExampleTag::parserExampleTag()
Reads and parses the example file indicated
parserExampleTag: in file DocBlockTags.inc, class parserExampleTag
represents "@example"
parserFileSourceTag: in file DocBlockTags.inc, method parserFileSourceTag::parserFileSourceTag()
Set $source to $value, and set up path
parserFileSourceTag: in file DocBlockTags.inc, class parserFileSourceTag
represents "@filesource"
parserFunction: in file ParserElements.inc, class parserFunction
parserGlobal: in file ParserElements.inc, class parserGlobal
parserI: in file DescHTML.inc, class parserI
Used for in a description
parserIdInlineTag: in file InlineTags.inc, class parserIdInlineTag
Represents the inline {@id} tag for tutorials
parserIdInlineTag: in file InlineTags.inc, method parserIdInlineTag::parserIdInlineTag()
constructor
parserInclude: in file ParserElements.inc, class parserInclude
parserInheritdocInlineTag: in file InlineTags.inc, class parserInheritdocInlineTag
Represents the inheritdoc inline tag, used by classes/methods/vars to inherit documentation from the parent class if possible
parserInheritdocInlineTag: in file InlineTags.inc, method parserInheritdocInlineTag::parserInheritdocInlineTag()
Does nothing, overrides parent constructor
parserInlineTag: in file InlineTags.inc, method parserInlineTag::parserInlineTag()
sets up the tag
parserInlineTag: in file InlineTags.inc, class parserInlineTag
Use this element to represent an {@inline tag} like {@link}
parserKbd: in file DescHTML.inc, class parserKbd
Used for <kbd> in a description
parserLicenseTag: in file DocBlockTags.inc, method parserLicenseTag::parserLicenseTag()
set up the license tag
parserLicenseTag: in file DocBlockTags.inc, class parserLicenseTag
represents the "@see" tag
parserLinkInlineTag: in file InlineTags.inc, method parserLinkInlineTag::parserLinkInlineTag()
sets up the tag
parserLinkInlineTag: in file InlineTags.inc, class parserLinkInlineTag
represents inline links
parserLinkTag: in file DocBlockTags.inc, method parserLinkTag::parserLinkTag()
sets up the link tag
parserLinkTag: in file DocBlockTags.inc, class parserLinkTag
represents the "@link" tag
parserList: in file DescHTML.inc, class parserList
Used for lists <ol> and <ul>
parserList: in file DescHTML.inc, method parserList::parserList()
Constructor - create a new list
parserMethod: in file ParserElements.inc, method parserMethod::parserMethod()
parserMethod: in file ParserElements.inc, class parserMethod
parserMethodTag: in file DocBlockTags.inc, class parserMethodTag
represents the "@method" tag
parserNameTag: in file DocBlockTags.inc, class parserNameTag
This class represents the @name tag
parserNameTag: in file DocBlockTags.inc, method parserNameTag::parserNameTag()
set up the name tag
parserPackagePage: in file ParserElements.inc, method parserPackagePage::parserPackagePage()
parserPackagePage: in file ParserElements.inc, class parserPackagePage
parserPage: in file ParserData.inc, class parserPage
Contains information about a PHP file, used to group procedural elements together.
parserPage: in file ParserData.inc, method parserPage::parserPage()
sets package to default package
parserParamTag: in file DocBlockTags.inc, class parserParamTag
represents the "@param" tag
parserPre: in file DescHTML.inc, class parserPre
Used for <pre> in a description
parserPropertyReadTag: in file DocBlockTags.inc, class parserPropertyReadTag
represents the "@property-read" tag
parserPropertyTag: in file DocBlockTags.inc, class parserPropertyTag
represents the "@property" tag
parserPropertyTag: in file DocBlockTags.inc, method parserPropertyTag::parserPropertyTag()
set up the property tag
parserPropertyWriteTag: in file DocBlockTags.inc, class parserPropertyWriteTag
represents the "@property-write" tag
parserReturnTag: in file DocBlockTags.inc, method parserReturnTag::parserReturnTag()
set up the tag
parserReturnTag: in file DocBlockTags.inc, class parserReturnTag
represents the "@return" tag
parserSamp: in file DescHTML.inc, class parserSamp
Used for <samp> in a description
parserSeeTag: in file DocBlockTags.inc, method parserSeeTag::parserSeeTag()
sets up the see tag
parserSeeTag: in file DocBlockTags.inc, class parserSeeTag
represents the "@see" tag
parserSourceInlineTag: in file InlineTags.inc, class parserSourceInlineTag
represents inline source tag, used for function/method source
parserSourceInlineTag: in file InlineTags.inc, method parserSourceInlineTag::parserSourceInlineTag()
constructor
parserStaticvarTag: in file DocBlockTags.inc, class parserStaticvarTag
represents the "@staticvar" tag
parserStringWithInlineTags: in file ParserData.inc, class parserStringWithInlineTags
Used to represent strings that contain inline tags, so that they can be properly parsed at link time
parserTag: in file DocBlockTags.inc, class parserTag
used to represent standard tags like @access, etc.
parserTag: in file DocBlockTags.inc, method parserTag::parserTag()
Set up the tag
parserTocInlineTag: in file InlineTags.inc, class parserTocInlineTag
Represents {@toc} for table of contents generation in tutorials
parserTocInlineTag: in file InlineTags.inc, method parserTocInlineTag::parserTocInlineTag()
constructor
parserTutorial: in file ParserElements.inc, method parserTutorial::parserTutorial()
parserTutorial: in file ParserElements.inc, class parserTutorial
parserTutorialInlineTag: in file InlineTags.inc, method parserTutorialInlineTag::parserTutorialInlineTag()
constructor
parserTutorialInlineTag: in file InlineTags.inc, class parserTutorialInlineTag
Represents inline links to external tutorial documentation
parserTutorialTag: in file DocBlockTags.inc, class parserTutorialTag
represents "@tutorial"
parserUsedByTag: in file DocBlockTags.inc, method parserUsedByTag::parserUsedByTag()
set up the usedby tag
parserUsedByTag: in file DocBlockTags.inc, class parserUsedByTag
This is a virtual tag, it is created by @uses to cross-reference the used element
parserUsesTag: in file DocBlockTags.inc, method parserUsesTag::parserUsesTag()
set up the uses tag
parserUsesTag: in file DocBlockTags.inc, class parserUsesTag
represents the "@uses" tag
parserVar: in file ParserElements.inc, class parserVar
parserVar: in file ParserElements.inc, method parserVar::parserVar()
parserVarTag: in file DocBlockTags.inc, class parserVarTag
represents the "@var" tag
parserXMLDocBookTag: in file PackagePageElements.inc, class parserXMLDocBookTag
a standard XML DocBook Tag
parserXMLDocBookTag: in file PackagePageElements.inc, method parserXMLDocBookTag::parserXMLDocBookTag()
sets up the tag
PARSER_EVENT_ACCESS_MODIFIER: in file Parser.inc, constant PARSER_EVENT_ACCESS_MODIFIER
used when parsing an access modifier
PARSER_EVENT_ARRAY: in file Parser.inc, constant PARSER_EVENT_ARRAY
used when an array definition is encountered in parsing
PARSER_EVENT_CLASS: in file Parser.inc, constant PARSER_EVENT_CLASS
used when a class definition is encountered in parsing
PARSER_EVENT_CLASS_CONSTANT: in file Parser.inc, constant PARSER_EVENT_CLASS_CONSTANT
used when a class implements interfaces
PARSER_EVENT_CLASS_MEMBER: in file Parser.inc, constant PARSER_EVENT_CLASS_MEMBER
used by the HighlightParser only, when ->var or ->function() is encountered in a method
PARSER_EVENT_COMMENT: in file Parser.inc, constant PARSER_EVENT_COMMENT
used when short comment // is encountered in parsing
PARSER_EVENT_COMMENTBLOCK: in file Parser.inc, constant PARSER_EVENT_COMMENTBLOCK
used when long comment /x x/ where x is an asterisk is encountered in parsing
PARSER_EVENT_DEFINE: in file Parser.inc, constant PARSER_EVENT_DEFINE
used when a define statement is encountered in parsing
PARSER_EVENT_DEFINE_GLOBAL: in file Parser.inc, constant PARSER_EVENT_DEFINE_GLOBAL
used when parsing a global variable declaration
PARSER_EVENT_DEFINE_PARAMS: in file Parser.inc, constant PARSER_EVENT_DEFINE_PARAMS
used when a define statement opening parenthesis is encountered in parsing
PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS: in file Parser.inc, constant PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS
used when a define statement's opening parenthesis is encountered in parsing
PARSER_EVENT_DESC: in file Parser.inc, constant PARSER_EVENT_DESC
used when parsing the desc part of a docblock
PARSER_EVENT_DOCBLOCK: in file Parser.inc, constant PARSER_EVENT_DOCBLOCK
used when a DocBlock is encountered in parsing
PARSER_EVENT_DOCBLOCK_TEMPLATE: in file Parser.inc, constant PARSER_EVENT_DOCBLOCK_TEMPLATE
used when encountering a /**#@+ comment marking a new docblock template
PARSER_EVENT_DOCKEYWORD: in file Parser.inc, constant PARSER_EVENT_DOCKEYWORD
used when a @tag is encountered in DocBlock parsing
PARSER_EVENT_DOCKEYWORD_EMAIL: in file Parser.inc, constant PARSER_EVENT_DOCKEYWORD_EMAIL
used when a <email@address> is encountered in parsing an @author tag
PARSER_EVENT_END_DOCBLOCK_TEMPLATE: in file Parser.inc, constant PARSER_EVENT_END_DOCBLOCK_TEMPLATE
used when encountering a /**#@-* / comment (no space) marking the end of using a docblock template
PARSER_EVENT_END_STATEMENT: in file Parser.inc, constant PARSER_EVENT_END_STATEMENT
PARSER_EVENT_EOFQUOTE: in file Parser.inc, constant PARSER_EVENT_EOFQUOTE
used when a <<< is encountered in parsing
PARSER_EVENT_ESCAPE: in file Parser.inc, constant PARSER_EVENT_ESCAPE
used when a backslash is encountered in parsing a string or other escapable entity
PARSER_EVENT_FUNCTION: in file Parser.inc, constant PARSER_EVENT_FUNCTION
used when a function definition is encountered in parsing
PARSER_EVENT_FUNCTION_PARAMS: in file Parser.inc, constant PARSER_EVENT_FUNCTION_PARAMS
used when a function statement opening parenthesis is encountered in parsing
PARSER_EVENT_FUNCTION_PARAM_VAR: in file Parser.inc, constant PARSER_EVENT_FUNCTION_PARAM_VAR
used when a $param is encountered in a function definition
PARSER_EVENT_FUNC_GLOBAL: in file Parser.inc, constant PARSER_EVENT_FUNC_GLOBAL
used when parsing a "global $var1, $var2;" declaration in a function
PARSER_EVENT_GLOBAL_VALUE: in file Parser.inc, constant PARSER_EVENT_GLOBAL_VALUE
used when parsing the default value in a global variable declaration
PARSER_EVENT_IMPLEMENTS: in file Parser.inc, constant PARSER_EVENT_IMPLEMENTS
used when a class implements interfaces
PARSER_EVENT_INCLUDE: in file Parser.inc, constant PARSER_EVENT_INCLUDE
used when an include/require/include_once/include_once statement is encountered in parsing
PARSER_EVENT_INCLUDE_PARAMS: in file Parser.inc, constant 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: in file Parser.inc, constant 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: in file Parser.inc, constant PARSER_EVENT_INLINE_DOCKEYWORD
used when an inline {@tag} is encountered in parsing a DocBlock
PARSER_EVENT_LOGICBLOCK: in file Parser.inc, constant PARSER_EVENT_LOGICBLOCK
{ encountered in parsing a function or php code
PARSER_EVENT_METHOD: in file Parser.inc, constant PARSER_EVENT_METHOD
used by the HighlightParser only, when a method starts
PARSER_EVENT_METHOD_LOGICBLOCK: in file Parser.inc, constant PARSER_EVENT_METHOD_LOGICBLOCK
used by the HighlightParser only, when a method body is parsed
PARSER_EVENT_NOEVENTS: in file Parser.inc, constant PARSER_EVENT_NOEVENTS
used for the beginning of parsing, before first < ? php encountered
PARSER_EVENT_OUTPHP: in file Parser.inc, constant PARSER_EVENT_OUTPHP
used when a ? > (with no space) is encountered in parsing
PARSER_EVENT_PHPCODE: in file Parser.inc, constant PARSER_EVENT_PHPCODE
used when php code processor instruction (< ? php) is encountered in parsing
PARSER_EVENT_QUOTE: in file Parser.inc, constant PARSER_EVENT_QUOTE
used when double quotation mark (") encountered in parsing
PARSER_EVENT_QUOTE_VAR: in file Parser.inc, constant PARSER_EVENT_QUOTE_VAR
used by the HighlightParser only, when {$var} is encountered in a string
PARSER_EVENT_SINGLEQUOTE: in file Parser.inc, constant PARSER_EVENT_SINGLEQUOTE
used when a single quote (') is encountered in parsing
PARSER_EVENT_STATIC_VAR: in file Parser.inc, constant PARSER_EVENT_STATIC_VAR
used when parsing a "static $var1, $var2;" declaration in a function
PARSER_EVENT_STATIC_VAR_VALUE: in file Parser.inc, constant PARSER_EVENT_STATIC_VAR_VALUE
used when parsing the value in a "static $var1 = x" declaration in a function
PARSER_EVENT_TAGS: in file Parser.inc, constant PARSER_EVENT_TAGS
used when parsing the @tag block of a docblock
PARSER_EVENT_VAR: in file Parser.inc, constant PARSER_EVENT_VAR
used when a var statement is encountered in parsing a class definition
PARSER_EVENT_VAR_ARRAY: in file Parser.inc, constant PARSER_EVENT_VAR_ARRAY
used when a variable value is an array
PARSER_EVENT_VAR_ARRAY_COMMENT: in file Parser.inc, constant PARSER_EVENT_VAR_ARRAY_COMMENT
used when a comment is found in a variable array value
parseString: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::parseString()
Parse a new file
pathMatchesParsedFile: in file ProceduralPages.inc, method ProceduralPages::pathMatchesParsedFile()
checks to see if the parsed file matches the given path
PATH_DELIMITER: in file common.inc.php, constant PATH_DELIMITER
PDERROR_ACCESS_WRONG_PARAM: in file Errors.inc, constant PDERROR_ACCESS_WRONG_PARAM
warning triggered when the arguments to @access are neither public nor private
PDERROR_BEAUTIFYING_FAILED: in file Errors.inc, constant PDERROR_BEAUTIFYING_FAILED
warning triggered by an unterminated entity in a tutorial
PDERROR_CANNOT_EXTEND_SELF: in file Errors.inc, constant PDERROR_CANNOT_EXTEND_SELF
warning triggered if someone brilliant tries "class X extends X {"
PDERROR_CANT_HAVE_INLINE_IN_TAGNAME: in file Errors.inc, constant PDERROR_CANT_HAVE_INLINE_IN_TAGNAME
warning triggered when an inline tag is found inside an xml tag name
PDERROR_CANT_NEST_IN_B: in file Errors.inc, constant PDERROR_CANT_NEST_IN_B
warning triggered when another tag is nested in
PDERROR_CHILD_TUTORIAL_NOT_FOUND: in file Errors.inc, constant PDERROR_CHILD_TUTORIAL_NOT_FOUND
warning triggered when a tutorial's child in the .ini file doesn't exist in the
PDERROR_CLASS_CONFLICT: in file Errors.inc, constant PDERROR_CLASS_CONFLICT
warning triggered when classes in the same package have the same name
PDERROR_CLASS_EXISTS: in file Errors.inc, constant PDERROR_CLASS_EXISTS
warning triggered when inheritance could be from more than one class
PDERROR_CLASS_NOT_IN_PACKAGE: in file Errors.inc, constant PDERROR_CLASS_NOT_IN_PACKAGE
warning triggered when a getClassByPackage is called and can't find the class
PDERROR_CLASS_PARENT_NOT_FOUND: in file Errors.inc, constant PDERROR_CLASS_PARENT_NOT_FOUND
warning triggered when an entire page is ignored because of @access private
PDERROR_CONVERTER_NOT_FOUND: in file Errors.inc, constant PDERROR_CONVERTER_NOT_FOUND
warning triggered when a converter is passed to
PDERROR_CONVERTER_OVR_GFCT: in file Errors.inc, constant PDERROR_CONVERTER_OVR_GFCT
warning triggered when a child converter doesn't override
PDERROR_DANGEROUS_PHP_BUG_EXISTS: in file Errors.inc, constant PDERROR_DANGEROUS_PHP_BUG_EXISTS
warning triggered when the PHP version being used has dangerous bug/behavior
PDERROR_DB_TEMPLATE_UNTERMINATED: in file Errors.inc, constant PDERROR_DB_TEMPLATE_UNTERMINATED
warning triggered when a docblock template is never turned off
PDERROR_DOCBLOCK_CONFLICT: in file Errors.inc, constant PDERROR_DOCBLOCK_CONFLICT
warning triggered by a page-level docblock preceding a source element
PDERROR_DOCBLOCK_GOES_CLASS: in file Errors.inc, constant 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: in file Errors.inc, constant PDERROR_DUMB_USES
warning triggered by improper "@uses blah"
PDERROR_ELEMENT_IGNORED: in file Errors.inc, constant PDERROR_ELEMENT_IGNORED
warning triggered when a duplicate element is encountered that will be
PDERROR_EMPTY_EXAMPLE_TITLE: in file Errors.inc, constant PDERROR_EMPTY_EXAMPLE_TITLE
warning triggered by @example path/to/example with no title
PDERROR_EXAMPLE_NOT_FOUND: in file Errors.inc, constant PDERROR_EXAMPLE_NOT_FOUND
warning triggered when an example's path from @example /path/to/example.php
PDERROR_FUNCTION_HAS_NONAME: in file Errors.inc, constant PDERROR_FUNCTION_HAS_NONAME
warning triggered by a function with no name
PDERROR_GLOBAL_NOT_FOUND: in file Errors.inc, constant PDERROR_GLOBAL_NOT_FOUND
warning triggered when there are multiple @name tags in a docblock
PDERROR_ID_MUST_BE_INLINE: in file Errors.inc, constant PDERROR_ID_MUST_BE_INLINE
warning triggered when an id attribute in a tutorial docbook tag is not
PDERROR_IGNORE_TAG_IGNORED: in file Errors.inc, constant PDERROR_IGNORE_TAG_IGNORED
warning triggered when an @ignore tag is used in a DocBlock preceding
PDERROR_ILLEGAL_PACKAGENAME: in file Errors.inc, constant PDERROR_ILLEGAL_PACKAGENAME
warning triggered when the package or subpackage name is illegal
PDERROR_INHERITANCE_CONFLICT: in file Errors.inc, constant PDERROR_INHERITANCE_CONFLICT
warning triggered when inheritance could be from more than one class
PDERROR_INHERITDOC_DONT_WORK_HERE: in file Errors.inc, constant PDERROR_INHERITDOC_DONT_WORK_HERE
warning triggered by {@inheritdoc} in a non-inheritable situation
PDERROR_INLINETAG_IN_SEE: in file Errors.inc, constant PDERROR_INLINETAG_IN_SEE
warning triggered when an example's path from @example /path/to/example.php
PDERROR_INTERNAL_NOT_CLOSED: in file Errors.inc, constant PDERROR_INTERNAL_NOT_CLOSED
warning triggered when an {@internal}} tag is not closed
PDERROR_INVALID_VALUES: in file Errors.inc, constant PDERROR_INVALID_VALUES
warning triggered if a command line option does not have a valid value passed in
PDERROR_LOOP_RECURSION_LIMIT_REACHED: in file Errors.inc, constant PDERROR_LOOP_RECURSION_LIMIT_REACHED
warning triggered when the a loop recursion tripwire has been tripped
PDERROR_MALFORMED_GLOBAL_TAG: in file Errors.inc, constant PDERROR_MALFORMED_GLOBAL_TAG
warning triggered when there are multiple @name tags in a docblock
PDERROR_MALFORMED_TAG: in file Errors.inc, constant PDERROR_MALFORMED_TAG
warning triggered by an empty tag
PDERROR_MISSING_PROPERTY_TAG_NAME: in file Errors.inc, constant PDERROR_MISSING_PROPERTY_TAG_NAME
warning triggered when any of {@property}}, {@property-read}},
PDERROR_MULTIPLE_ACCESS_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_ACCESS_TAGS
warning triggered when there are multiple @access tags in a docblock
PDERROR_MULTIPLE_CATEGORY_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_CATEGORY_TAGS
warning triggered by more than 1 @category tag
PDERROR_MULTIPLE_GLOBAL_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_GLOBAL_TAGS
warning triggered when there are multiple @name tags in a docblock
PDERROR_MULTIPLE_NAME_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_NAME_TAGS
warning triggered when there are multiple @name tags in a docblock
PDERROR_MULTIPLE_PACKAGE_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_PACKAGE_TAGS
warning triggered when there are multiple @package tags in a docblock
PDERROR_MULTIPLE_PARENT: in file Errors.inc, constant PDERROR_MULTIPLE_PARENT
warning triggered when inheritance could be from more than one class
PDERROR_MULTIPLE_RETURN_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_RETURN_TAGS
warning triggered when there are multiple @return tags in a docblock
PDERROR_MULTIPLE_SUBPACKAGE_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_SUBPACKAGE_TAGS
warning triggered when there are multiple @subpackage tags in a docblock
PDERROR_MULTIPLE_VAR_TAGS: in file Errors.inc, constant PDERROR_MULTIPLE_VAR_TAGS
warning triggered when there are multiple @var tags in a docblock
PDERROR_NAME_ALIAS_SAME_AS_TARGET: in file Errors.inc, constant PDERROR_NAME_ALIAS_SAME_AS_TARGET
warning triggered when the alias value in an page-level docblock's @name tag
PDERROR_NEED_WHITESPACE: in file Errors.inc, constant PDERROR_NEED_WHITESPACE
warning triggered when an entire page is ignored because of @access private
PDERROR_NESTED_INTERNAL: in file Errors.inc, constant PDERROR_NESTED_INTERNAL
warning triggered when {@internal}} is nested inside another {@internal}}
PDERROR_NOTODO_INCLUDE: in file Errors.inc, constant PDERROR_NOTODO_INCLUDE
warning triggered when @todo is used on an include element
PDERROR_NO_CONVERTERS: in file Errors.inc, constant PDERROR_NO_CONVERTERS
warning triggered when a converter is passed to
PDERROR_NO_CONVERTER_HANDLER: in file Errors.inc, constant PDERROR_NO_CONVERTER_HANDLER
warning triggered when an example's path from @example /path/to/example.php
PDERROR_NO_DOCBOOK_ID: in file Errors.inc, constant PDERROR_NO_DOCBOOK_ID
warning triggered in tutorial parsing if there is a missing {@id} inline tag
PDERROR_NO_PACKAGE_TAG: in file Errors.inc, constant PDERROR_NO_PACKAGE_TAG
warning triggered when no @package tag is used in a page-level
PDERROR_NO_PAGE_LEVELDOCBLOCK: in file Errors.inc, constant PDERROR_NO_PAGE_LEVELDOCBLOCK
warning triggered when a file does not contain a page-level docblock
PDERROR_OVERRIDDEN_PACKAGE_TAGS: in file Errors.inc, constant PDERROR_OVERRIDDEN_PACKAGE_TAGS
warning triggered when there a @package tag is used in a function,
PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS: in file Errors.inc, constant PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS
warning triggered when there a @subpackage tag is used in a function,
PDERROR_PACKAGECAT_SET: in file Errors.inc, constant PDERROR_PACKAGECAT_SET
warning triggered when a package is already associated with a category, and
PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE: in file Errors.inc, constant PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE
warning triggered when there are multiple @name tags in a docblock
PDERROR_PARENT_NOT_FOUND: in file Errors.inc, constant PDERROR_PARENT_NOT_FOUND
warning triggered when parent class doesn't exist
PDERROR_PARSEPRIVATE: in file Errors.inc, constant PDERROR_PARSEPRIVATE
warning triggered when an entire page is ignored because of @access private
PDERROR_PDFFUNCTION_NO_FUNC: in file Errors.inc, constant PDERROR_PDFFUNCTION_NO_FUNC
warning triggered when a <pdffunction:funcname /> tag is used in the PDF
PDERROR_PDF_METHOD_DOESNT_EXIST: in file Errors.inc, constant PDERROR_PDF_METHOD_DOESNT_EXIST
warning triggered when a <pdffunction:funcname /> tag is used in the PDF
PDERROR_PDF_TEMPVAR_DOESNT_EXIST: in file Errors.inc, constant PDERROR_PDF_TEMPVAR_DOESNT_EXIST
warning triggered when a <pdffunction:funcname arg=$tempvar/> tag
PDERROR_PRIVATE_ASSUMED: in file Errors.inc, constant PDERROR_PRIVATE_ASSUMED
warning triggered when no @access private tag is used in a
PDERROR_SOURCECODE_IGNORED: in file Errors.inc, constant PDERROR_SOURCECODE_IGNORED
warning triggered by sourcecode="on", if PHP < 4.3.0
PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND: in file Errors.inc, constant PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND
warning triggered when a { @source } inline tag is used in a docblock not
PDERROR_SOURCE_TAG_IGNORED: in file Errors.inc, constant PDERROR_SOURCE_TAG_IGNORED
warning triggered when an {@source} tag is found in a short description
PDERROR_TAG_NOT_HANDLED: in file Errors.inc, constant PDERROR_TAG_NOT_HANDLED
warning triggered by @filesource, if PHP < 4.3.0
PDERROR_TEMPLATEDIR_DOESNT_EXIST: in file Errors.inc, constant PDERROR_TEMPLATEDIR_DOESNT_EXIST
warning triggered by non-existent template directory
PDERROR_TEXT_OUTSIDE_LI: in file Errors.inc, constant PDERROR_TEXT_OUTSIDE_LI
warning triggered when text in a docblock list is not contained in
PDERROR_TUTORIAL_IS_OWN_CHILD: in file Errors.inc, constant PDERROR_TUTORIAL_IS_OWN_CHILD
warning triggered when a tutorial lists itself as a child tutorial
PDERROR_TUTORIAL_IS_OWN_GRANDPA: in file Errors.inc, constant PDERROR_TUTORIAL_IS_OWN_GRANDPA
warning triggered when a tutorial's child lists the parent tutorial
PDERROR_TUTORIAL_NOT_FOUND: in file Errors.inc, constant PDERROR_TUTORIAL_NOT_FOUND
warning triggered when a tutorial is referenced
PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND: in file Errors.inc, constant PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND
warning triggered when a subsection's title is asked for, but the subsection
PDERROR_UL_IN_UL: in file Errors.inc, constant PDERROR_UL_IN_UL
warning triggered if <ul> is nested inside <ul> and not <li>
PDERROR_UNCLOSED_TAG: in file Errors.inc, constant PDERROR_UNCLOSED_TAG
warning triggered when a DocBlock html tag is unclosed
PDERROR_UNDOCUMENTED_ELEMENT: in file Errors.inc, constant PDERROR_UNDOCUMENTED_ELEMENT
warning triggered when a class or method hasn't got docblock
PDERROR_UNKNOWN_COMMANDLINE: in file Errors.inc, constant PDERROR_UNKNOWN_COMMANDLINE
warning triggered when an entire page is ignored because of @access private
PDERROR_UNKNOWN_TAG: in file Errors.inc, constant PDERROR_UNKNOWN_TAG
warning triggered when classes in the same package have the same name
PDERROR_UNMATCHED_LIST_TAG: in file Errors.inc, constant PDERROR_UNMATCHED_LIST_TAG
warning triggered when a docblock has an unmatched <ol> or <ul>
PDERROR_UNMATCHED_TUTORIAL_TAG: in file Errors.inc, constant PDERROR_UNMATCHED_TUTORIAL_TAG
warning triggered when a docbook tag is not properly matched
PDERROR_UNTERMINATED_ATTRIB: in file Errors.inc, constant PDERROR_UNTERMINATED_ATTRIB
warning triggered when a subsection's title is asked for, but the subsection
PDERROR_UNTERMINATED_ENTITY: in file Errors.inc, constant PDERROR_UNTERMINATED_ENTITY
warning triggered by an unterminated entity in a tutorial
PDERROR_UNTERMINATED_INLINE_TAG: in file Errors.inc, constant PDERROR_UNTERMINATED_INLINE_TAG
warning triggered when an {@inline tag} is not terminated
PDFdefaultConverter: in file PDFdefaultConverter.inc, class PDFdefaultConverter
PDF output converter.
PDFdefaultConverter: in file PDFdefaultConverter.inc, method PDFdefaultConverter::PDFdefaultConverter()
PDFParser: in file ParserPDF.inc, method PDFParser::PDFParser()
Sets up the wordparser for this class
PDFParser: in file ParserPDF.inc, class PDFParser
phpdoc.php: procedural page phpdoc.php
phpdocpdf: in file class.phpdocpdf.php, method phpdocpdf::phpdocpdf()
phpdocpdf: in file class.phpdocpdf.php, class phpdocpdf
ParserPDF.inc: procedural page ParserPDF.inc
PDFdefaultConverter.inc: procedural page PDFdefaultConverter.inc
PackagePageElements.inc: procedural page PackagePageElements.inc
Parser.inc: procedural page Parser.inc
ParserData.inc: procedural page ParserData.inc
ParserDescCleanup.inc: procedural page ParserDescCleanup.inc
ParserDocBlock.inc: procedural page ParserDocBlock.inc
ParserElements.inc: procedural page ParserElements.inc
phpdoc.inc: procedural page phpdoc.inc
phpDocumentorTParser.inc: procedural page phpDocumentorTParser.inc
phpDocumentorTWordParser.inc: procedural page phpDocumentorTWordParser.inc
ProceduralPages.inc: procedural page ProceduralPages.inc
Publisher.inc: procedural page Publisher.inc
phpDocumentorTParser: in file phpDocumentorTParser.inc, class phpDocumentorTParser
Tokenizer-based parser for PHP source code
phpDocumentorTParser: in file phpDocumentorTParser.inc, method phpDocumentorTParser::phpDocumentorTParser()
Constructor
phpDocumentorTWordParser: in file phpDocumentorTWordParser.inc, class phpDocumentorTWordParser
Like WordParser, but expects an array of tokens from the tokenizer instead of a string.
phpDocumentor_clone: in file clone.inc.php, function phpDocumentor_clone()
Clone an object in PHP 4
phpDocumentor_ConfigFileList: in file common.inc.php, function phpDocumentor_ConfigFileList()
used in phpdoc.php and new_phpdoc.php
PHPDOCUMENTOR_EVENT_CLASS: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_CLASS
Class published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_CONST: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_CONST
Class Constant published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DEFINE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_DEFINE
Constant (define) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DOCBLOCK: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_DOCBLOCK
DocBlock published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE
used when a docblock template is encountered in the source
PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE
used when a docblock template is encountered in the source
PHPDOCUMENTOR_EVENT_END_PAGE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_END_PAGE
used to inform phpDocumentor_IntermediateParser that the current file has been completely parsed.
PHPDOCUMENTOR_EVENT_FUNCTION: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_FUNCTION
Function published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_GLOBAL: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_GLOBAL
used when a global variable definition is encountered in the source
PHPDOCUMENTOR_EVENT_INCLUDE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_INCLUDE
Include (include/require/include_once/include_once) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_MESSAGE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_MESSAGE
PHPDOCUMENTOR_EVENT_NEWFILE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_NEWFILE
use to inform ErrorTracker of a new file being parsed
PHPDOCUMENTOR_EVENT_NEWLINENUM: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_NEWLINENUM
use to inform ErrorTracker of the next line number being parsed
PHPDOCUMENTOR_EVENT_NEWSTATE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_NEWSTATE
use to inform IntermediateParser of a new element being parsed
PHPDOCUMENTOR_EVENT_PACKAGEPAGE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_PACKAGEPAGE
Package-level page published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_PAGE: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_PAGE
New File (page) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG
Contents of README/INSTALL/CHANGELOG files published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_TUTORIAL: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_TUTORIAL
Tutorial published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_VAR: in file Parser.inc, constant PHPDOCUMENTOR_EVENT_VAR
Class Variable published to IntermediateParser with this event
phpDocumentor_get_class: in file common.inc.php, function phpDocumentor_get_class()
Returns a lower-cased version of get_class for PHP 5
phpDocumentor_HighlightParser: in file HighlightParser.inc, class phpDocumentor_HighlightParser
Highlights source code using parse()
phpDocumentor_HighlightParser: in file HighlightParser.inc, method phpDocumentor_HighlightParser::phpDocumentor_HighlightParser()
Initialize the $tokenpushEvent, $wordpushEvent arrays
phpDocumentor_HighlightWordParser: in file HighlightParser.inc, class phpDocumentor_HighlightWordParser
Retrieve tokens from an array of tokens organized by line numbers
phpDocumentor_IntermediateParser: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::phpDocumentor_IntermediateParser()
sets up basic data structures
phpDocumentor_IntermediateParser: in file IntermediateParser.inc, class phpDocumentor_IntermediateParser
The phpDocumentor_IntermediateParser Class
phpDocumentor_out: in file Setup.inc.php, function phpDocumentor_out()
Print parse information if quiet setting is off
phpDocumentor_parse_ini_file: in file common.inc.php, function phpDocumentor_parse_ini_file()
Parse an .ini file
PHPDOCUMENTOR_PDF_EVENT_CONTENT: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_CONTENT
used for parsing stuff between <text>
PHPDOCUMENTOR_PDF_EVENT_FONT: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_FONT
when is found in an ezText input
PHPDOCUMENTOR_PDF_EVENT_NEWPAGE: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_NEWPAGE
when <newpage/> is found in an ezText input
PHPDOCUMENTOR_PDF_EVENT_PDFFUNCTION: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_PDFFUNCTION
when <pdffunction> is found in an ezText input
PHPDOCUMENTOR_PDF_EVENT_TEXT: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_TEXT
when <text> is found in an ezText input
PHPDOCUMENTOR_PDF_STATE_CONTENT: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_CONTENT
used for parsing stuff between <text>
PHPDOCUMENTOR_PDF_STATE_FONT: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_FONT
when is found in an ezText input
PHPDOCUMENTOR_PDF_STATE_NEWPAGE: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_NEWPAGE
when <newpage/> is found in an ezText input
PHPDOCUMENTOR_PDF_STATE_PDFFUNCTION: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_PDFFUNCTION
when <pdffunction> is found in an ezText input
PHPDOCUMENTOR_PDF_STATE_TEXT: in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_TEXT
when <text> is found in an ezText input
PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_EVENT_B: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_B
when is found in a desc
PHPDOCUMENTOR_PDP_EVENT_BR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_BR
when is found in a desc
PHPDOCUMENTOR_PDP_EVENT_CDATA: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_CDATA
when <![CDATA[ ]]> is found
PHPDOCUMENTOR_PDP_EVENT_CODE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_CODE
when <code> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_DOUBLECR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_DOUBLECR
when \n\n is found in a desc
PHPDOCUMENTOR_PDP_EVENT_ENTITY: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_ENTITY
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_EVENT_ESCAPE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_ESCAPE
when the << potential escape for tags is found in a desc
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE
when << /code>> is found in a <code></code> section
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE
when << /pre>> is found in a <pre></pre> section
PHPDOCUMENTOR_PDP_EVENT_I: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_I
when is found in a desc
PHPDOCUMENTOR_PDP_EVENT_KBD: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_KBD
when <kbd> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_LIST: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_LIST
when <ul>/<ol> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_P: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_P
when is found in a desc
PHPDOCUMENTOR_PDP_EVENT_PRE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_PRE
when <pre> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_PROGRAMLISTING: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_PROGRAMLISTING
when <programlisting> is found
PHPDOCUMENTOR_PDP_EVENT_SAMP: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_SAMP
when <samp> is found in a desc
PHPDOCUMENTOR_PDP_EVENT_SIMLIST: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_SIMLIST
when a simple list is found in a desc
PHPDOCUMENTOR_PDP_EVENT_TAG: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_EVENT_TAG
when a DocBook <tag> is found
PHPDOCUMENTOR_PDP_EVENT_VAR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_EVENT_VAR
when <var> is found in a desc
PHPDOCUMENTOR_PDP_STATE_ATTRIBUTES: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_ATTRIBUTES
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_STATE_B: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_B
when is found in a desc
PHPDOCUMENTOR_PDP_STATE_BR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_BR
when is found in a desc
PHPDOCUMENTOR_PDP_STATE_CDATA: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_CDATA
when <![CDATA[ ]]> is found
PHPDOCUMENTOR_PDP_STATE_CODE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_CODE
when <code> is found in a desc
PHPDOCUMENTOR_PDP_STATE_DOUBLECR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_DOUBLECR
when \n\n is found in a desc
PHPDOCUMENTOR_PDP_STATE_ENTITY: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_ENTITY
when tag attributes name="value" are found
PHPDOCUMENTOR_PDP_STATE_ESCAPE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_ESCAPE
when the << potential escape for tags is found in a desc
PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE
when << /code>> is found in a <code></code> section
PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE
when << /pre>> is found in a <pre></pre> section
PHPDOCUMENTOR_PDP_STATE_I: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_I
when is found in a desc
PHPDOCUMENTOR_PDP_STATE_KBD: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_KBD
when <kbd> is found in a desc
PHPDOCUMENTOR_PDP_STATE_LIST: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_LIST
when <ul>/<ol> is found in a desc
PHPDOCUMENTOR_PDP_STATE_P: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_P
when is found in a desc
PHPDOCUMENTOR_PDP_STATE_PRE: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_PRE
when <pre> is found in a desc
PHPDOCUMENTOR_PDP_STATE_PROGRAMLISTING: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_PROGRAMLISTING
when <programlisting> is found
PHPDOCUMENTOR_PDP_STATE_SAMP: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_SAMP
when <samp> is found in a desc
PHPDOCUMENTOR_PDP_STATE_SIMLIST: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_SIMLIST
when a simple list is found in a desc
PHPDOCUMENTOR_PDP_STATE_TAG: in file XMLpackagePageParser.inc, constant PHPDOCUMENTOR_PDP_STATE_TAG
when a DocBook <tag> is found
PHPDOCUMENTOR_PDP_STATE_VAR: in file ParserDescCleanup.inc, constant PHPDOCUMENTOR_PDP_STATE_VAR
when <var> is found in a desc
phpDocumentor_peardoc2_XML_Beautifier: in file Beautifier.php, class phpDocumentor_peardoc2_XML_Beautifier
This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer
phpDocumentor_setup: in file Setup.inc.php, method phpDocumentor_setup::phpDocumentor_setup()
Checks PHP version, makes sure it is 4.2.0+, and chooses the
phpDocumentor_setup: in file Setup.inc.php, class phpDocumentor_setup
phpDocumentor_TutorialHighlightParser: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::phpDocumentor_TutorialHighlightParser()
Initialize the $tokenpushEvent, $wordpushEvent arrays
phpDocumentor_TutorialHighlightParser: in file TutorialHighlightParser.inc, class phpDocumentor_TutorialHighlightParser
Highlights source code using parse()
PHPDOCUMENTOR_VER: in file common.inc.php, constant PHPDOCUMENTOR_VER
PHPDOCUMENTOR_WEBSITE: in file common.inc.php, constant PHPDOCUMENTOR_WEBSITE
PHPDOCUMENTOR_WINDOWS: in file common.inc.php, constant PHPDOCUMENTOR_WINDOWS
phpDocumentor_XML_Beautifier_Tokenizer: in file Tokenizer.php, class phpDocumentor_XML_Beautifier_Tokenizer
Highlights source code using parse()
phpDocumentor_XML_Beautifier_Tokenizer: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::phpDocumentor_XML_Beautifier_Tokenizer()
Initialize the $tokenpushEvent, $wordpushEvent arrays
PHPDOC_BEAUTIFIER_CDATA: in file Tokenizer.php, constant PHPDOC_BEAUTIFIER_CDATA
do not remove, needed in plain renderer
PHPDOC_WEBROOT_DIR: in file file_dialog.php, constant PHPDOC_WEBROOT_DIR
PHPDOC_XMLTOKEN_EVENT_ATTRIBUTE: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_ATTRIBUTE
used when a <tag attr="attribute"> is found
PHPDOC_XMLTOKEN_EVENT_CDATA: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_CDATA
used when a <! is found
PHPDOC_XMLTOKEN_EVENT_CLOSETAG: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_CLOSETAG
used when a close </tag> is found
PHPDOC_XMLTOKEN_EVENT_COMMENT: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_COMMENT
used when a  is found
PHPDOC_XMLTOKEN_EVENT_DEF: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_DEF
used when a <! is found
PHPDOC_XMLTOKEN_EVENT_DOUBLEQUOTE: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_DOUBLEQUOTE
used when a  is found
PHPDOC_XMLTOKEN_EVENT_ENTITY: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_ENTITY
used when an &entity; is found
PHPDOC_XMLTOKEN_EVENT_IN_CDATA: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_IN_CDATA
used when a <![CDATA[ section is found
PHPDOC_XMLTOKEN_EVENT_NOEVENTS: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_NOEVENTS
starting state
PHPDOC_XMLTOKEN_EVENT_OPENTAG: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_OPENTAG
used when an open <tag> is found
PHPDOC_XMLTOKEN_EVENT_PI: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_PI
used when a processor instruction is found
PHPDOC_XMLTOKEN_EVENT_SINGLEQUOTE: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_SINGLEQUOTE
used when a  is found
PHPDOC_XMLTOKEN_EVENT_XML: in file Tokenizer.php, constant PHPDOC_XMLTOKEN_EVENT_XML
used when a <?xml is found
PHPUnit_MAIN_METHOD: in file IntermediateParserTests.php, constant PHPUnit_MAIN_METHOD
popEvent: in file EventStack.inc, method EventStack::popEvent()
Pop an event from the stack
postProcess: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::postProcess()
postProcess: in file CHMdefaultConverter.inc, method CHMdefaultConverter::postProcess()
Uses htmlspecialchars() on the input
postProcess: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::postProcess()
Uses htmlspecialchars() on the input
postProcess: in file Converter.inc, method Converter::postProcess()
This version does nothing
postProcess: in file XMLDocBookConverter.inc, method XMLDocBookConverter::postProcess()
postProcess: in file ParserDocBlock.inc, method parserDocBlock::postProcess()
Parse out any html tags from doc comments, and make them into
postProcess: in file HTMLframesConverter.inc, method HTMLframesConverter::postProcess()
Uses htmlspecialchars() on the input
postProcess: in file PDFdefaultConverter.inc, method PDFdefaultConverter::postProcess()
ppageParser: in file Parser.inc, method ppageParser::ppageParser()
set up invariant Parser variables
ppageParser: in file Parser.inc, class ppageParser
Global package page parser
prepareDocBlock: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::prepareDocBlock()
prepareDocBlock: in file Converter.inc, method Converter::prepareDocBlock()
convert the element's DocBlock for output
prepareDocBlock: in file XMLDocBookConverter.inc, method XMLDocBookConverter::prepareDocBlock()
PreserveWhiteSpace: in file Converter.inc, method Converter::PreserveWhiteSpace()
Used to convert the contents of <pre> in a docblock
ProceduralPages: in file ProceduralPages.inc, class ProceduralPages
Intermediate procedural page parsing structure.
processChild: in file Classes.inc, method Classes::processChild()
This function recursively climbs up the class tree, setting inherited information like package and adds the elements to phpDocumentor_IntermediateParser.
ProgramExample: in file CHMdefaultConverter.inc, method CHMdefaultConverter::ProgramExample()
Used to convert the <code> tag in a docblock
ProgramExample: in file HTMLframesConverter.inc, method HTMLframesConverter::ProgramExample()
Used to convert the <code> tag in a docblock
ProgramExample: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ProgramExample()
Used to convert the <code> tag in a docblock
ProgramExample: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::ProgramExample()
ProgramExample: in file Converter.inc, method Converter::ProgramExample()
Used to convert the <code> tag in a docblock
propertyTagHandler: in file Parser.inc, method Parser::propertyTagHandler()
Handles @property(-read or -write) and @method magic tag
Publisher: in file Publisher.inc, class Publisher
a class for handling the publishing of data
publishEvent: in file Publisher.inc, method Publisher::publishEvent()
Publish an event
pushEvent: in file EventStack.inc, method EventStack::pushEvent()
Push an event onto the stack
ParserClassTests.php: procedural page ParserClassTests.php
ParserPageTests.php: procedural page ParserPageTests.php
phpDocumentorSetupTests.php: procedural page phpDocumentorSetupTests.php
phpDocumentorTParserTests.php: procedural page phpDocumentorTParserTests.php

top

q

$quietMode: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$quietMode
set in Setup.inc.php to the value of the quitemode commandline option.
$quietmode: in file Converter.inc, variable Converter::$quietmode
controls display of progress information while parsing.

top

r

$refsect1id: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$refsect1id
$refsect2id: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$refsect2id
$refsect3id: in file XMLpackagePageParser.inc, variable XMLPackagePageParser::$refsect3id
$render: in file Setup.inc.php, variable phpDocumentor_setup::$render
Used to organize output from the Parser before Conversion
$reportContents: in file class.phpdocpdf.php, variable phpdocpdf::$reportContents
$return: in file ParserDocBlock.inc, variable parserDocBlock::$return
This is either a parserReturnTag or false if no return tag is present
$returnsreference: in file ParserElements.inc, variable parserFunction::$returnsreference
Function returns a reference to an element, instead of a value
$returnType: in file DocBlockTags.inc, variable parserPropertyTag::$returnType
the type a property has
$returnType: in file DocBlockTags.inc, variable parserMethodTag::$returnType
the return type a method has
$returnType: in file DocBlockTags.inc, variable parserReturnTag::$returnType
the type a function returns
$returnType: in file DocBlockTags.inc, variable parserVarTag::$returnType
the type a var has
$ric: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$ric
Stores parsed CHANGELOG/INSTALL/README files
$ric_set: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$ric_set
$ric_set: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$ric_set
$ric_set: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$ric_set
$ric_set: in file HTMLframesConverter.inc, variable HTMLframesConverter::$ric_set
rcNatCmp: in file CHMdefaultConverter.inc, method CHMdefaultConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
rcNatCmp: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
rcNatCmp: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::rcNatCmp()
does a nat case sort on the specified second level value of the array
rcNatCmp: in file HTMLframesConverter.inc, method HTMLframesConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
rcNatCmp: in file XMLDocBookConverter.inc, method XMLDocBookConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
rcNatCmp1: in file HTMLframesConverter.inc, method HTMLframesConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
rcNatCmp1: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
rcNatCmp1: in file CHMdefaultConverter.inc, method CHMdefaultConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
rcNatCmp1: in file XMLDocBookConverter.inc, method XMLDocBookConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
rcNatCmp1: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
readCommandLineSettings: in file Setup.inc.php, method phpDocumentor_setup::readCommandLineSettings()
Get phpDocumentor settings from command-line or web interface
readConfigFile: in file Setup.inc.php, method phpDocumentor_setup::readConfigFile()
Get phpDocumentor settings from a user configuration file
readPhpFile: in file Io.inc, method Io::readPhpFile()
Reads a file and returns it as a string Does basic error checking
RecordError: in file Errors.inc, class RecordError
encapsulates error information
RecordWarning: in file Errors.inc, method RecordWarning::RecordWarning()
Constructor
RecordWarning: in file Errors.inc, class RecordWarning
encapsulates warning information
recurseDir: in file utilities.php, function recurseDir()
removeNonMatches: in file Io.inc, method Io::removeNonMatches()
Removes files from the $dir array that do not match the search string in
replaceElement: in file ProceduralPages.inc, method ProceduralPages::replaceElement()
Used to align an element with the package of its parent page prior to Conversion.
replaceInheritDoc: in file ParserDocBlock.inc, method parserDesc::replaceInheritDoc()
replaces {@inheritdoc} with the contents of the parent DocBlock
replaceInheritDoc: in file ParserDocBlock.inc, method parserDocBlock::replaceInheritDoc()
Wrapper for parserDesc::replaceInheritDoc()
resetParams: in file ParserDocBlock.inc, method parserDocBlock::resetParams()
returnErrors: in file Errors.inc, method ErrorTracker::returnErrors()
Get sorted array of all non-fatal errors in parsing/conversion
returnLastError: in file Errors.inc, method ErrorTracker::returnLastError()
Get the error message of the last error
returnLastWarning: in file Errors.inc, method ErrorTracker::returnLastWarning()
Get the warning message of the last warning
returnLink: in file CHMdefaultConverter.inc, method CHMdefaultConverter::returnLink()
returnLink: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::returnLink()
returnLink: in file Converter.inc, method Converter::returnLink()
take URL $link and text $text and return a link in the format needed for the Converter
returnLink: in file XMLDocBookConverter.inc, method XMLDocBookConverter::returnLink()
returnLink: in file PDFdefaultConverter.inc, method PDFdefaultConverter::returnLink()
returnLink: in file HTMLframesConverter.inc, method HTMLframesConverter::returnLink()
returnLink: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::returnLink()
returnSee: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
returnSee: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::returnSee()
This function takes an abstractLink descendant and returns an html link
returnSee: in file HTMLframesConverter.inc, method HTMLframesConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
returnSee: in file XMLDocBookConverter.inc, method XMLDocBookConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
returnSee: in file PDFdefaultConverter.inc, method PDFdefaultConverter::returnSee()
Returns a bookmark using Cezpdf 009
returnSee: in file Converter.inc, method Converter::returnSee()
take abstractLink descendant and text $eltext and return a link
returnSee: in file CHMdefaultConverter.inc, method CHMdefaultConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
returnTagHandler: in file Parser.inc, method Parser::returnTagHandler()
handles @return
returnWarnings: in file Errors.inc, method ErrorTracker::returnWarnings()
Get sorted array of all warnings in parsing/conversion
rf: in file class.phpdocpdf.php, method phpdocpdf::rf()

top

s

$sdesc: in file ParserDocBlock.inc, variable parserDocBlock::$sdesc
$section: in file LinkClasses.inc, variable tutorialLink::$section
$setup: in file Setup.inc.php, variable phpDocumentor_setup::$setup
Used to parse command-line options
$set_pageNumbering: in file class.phpdocpdf.php, variable phpdocpdf::$set_pageNumbering
$smarty_dir: in file Converter.inc, variable Converter::$smarty_dir
Directory that the smarty templates are in
$smarty_dir: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$smarty_dir
$sort_absolutely_everything: in file Converter.inc, variable Converter::$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: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$sort_absolutely_everything
default PDF Converter wants elements sorted by type as well as alphabetically
$sort_absolutely_everything: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$sort_absolutely_everything
Pass elements by package, simplifies generation of package.xml/category.xml
$sort_page_contents_by_type: in file Converter.inc, variable Converter::$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: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$sort_page_contents_by_type
XMLDocBookConverter wants elements sorted by type as well as alphabetically
$sort_page_contents_by_type: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$sort_page_contents_by_type
XMLDocBookConverter wants elements sorted by type as well as alphabetically
$sort_page_contents_by_type: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$sort_page_contents_by_type
Smarty Converter wants elements sorted by type as well as alphabetically
$sort_page_contents_by_type: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$sort_page_contents_by_type
CHMdefaultConverter wants elements sorted by type as well as alphabetically
$sort_page_contents_by_type: in file HTMLframesConverter.inc, variable HTMLframesConverter::$sort_page_contents_by_type
Smarty Converter wants elements sorted by type as well as alphabetically
$source: in file ParserData.inc, variable parserPage::$source
Tokenized source code of the file
$source: in file InlineTags.inc, variable parserSourceInlineTag::$source
tokenized source organized by line numbers for php 4.3.0+, the old
$source: in file ParserElements.inc, variable parserFunction::$source
$source: in file DocBlockTags.inc, variable parserFileSourceTag::$source
$sourceloc: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$sourceloc
$sourceloc: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$sourceloc
$sourceLocation: in file ParserElements.inc, variable parserClass::$sourceLocation
$sourceLocation: in file ParserData.inc, variable parserPage::$sourceLocation
relative source location
$sourcePaths: in file Converter.inc, variable Converter::$sourcePaths
A list of files that have had source code generated
$source_location: in file phpDocumentorTParser.inc, variable phpDocumentorTParser::$source_location
relative path of the parsed file from the base parse directory
$stack: in file EventStack.inc, variable EventStack::$stack
The stack
$start: in file InlineTags.inc, variable parserSourceInlineTag::$start
First line of source code to display
$statics: in file ParserDocBlock.inc, variable parserDocBlock::$statics
array of static variable data.
$statics: in file ParserElements.inc, variable parserFunction::$statics
static variable declarations parsed from function definition
$subpackage: in file LinkClasses.inc, variable abstractLink::$subpackage
$subpackage: in file Parser.inc, variable ppageParser::$subpackage
$subpackage: in file ParserDocBlock.inc, variable parserDocBlock::$subpackage
$subpackage: in file InlineTags.inc, variable parserIdInlineTag::$subpackage
subpackage of the {@id}
$subpackage: in file ParserData.inc, variable parserPage::$subpackage
$subpackage: in file Converter.inc, variable Converter::$subpackage
subpackage name currently being converted
$subpackagedescrip: in file ParserDocBlock.inc, variable parserDocBlock::$subpackagedescrip
description of subpackage parsed from @package tag
$subscriber: in file Publisher.inc, variable Publisher::$subscriber
Array of references objects that have Subscribed to this publisher
Setup.inc.php: procedural page Setup.inc.php
Sampize: in file Converter.inc, method Converter::Sampize()
Used to convert the contents of <samp> in a docblock
setAccessModifiers: in file ParserElements.inc, method parserClass::setAccessModifiers()
Use this method to set access modifiers for a class
setClassParent: in file Classes.inc, method Classes::setClassParent()
Find the parent class of $class, and set up structures to note this fact
setColorArray: in file class.phpdocpdf.php, method phpdocpdf::setColorArray()
setConstructor: in file ParserElements.inc, method parserMethod::setConstructor()
Use this method to tell the parser that this method is the class constructor
setDataType: in file ParserElements.inc, method parserGlobal::setDataType()
Sets the name of the global variable's type
setDesc: in file ParserDocBlock.inc, method parserDocBlock::setDesc()
setDestructor: in file ParserElements.inc, method parserMethod::setDestructor()
Use this method to tell the parser that this method is the class constructor
setDirectoriesToParse: in file Setup.inc.php, method phpDocumentor_setup::setDirectoriesToParse()
setDocBlock: in file ParserData.inc, method parserData::setDocBlock()
sets the docblock
setDocBlock: in file ParserElements.inc, method parserElement::setDocBlock()
setEndLineNumber: in file ParserElements.inc, method parserElement::setEndLineNumber()
Sets the ending line number of elements
setEndLineNumber: in file ParserDocBlock.inc, method parserDocBlock::setEndLineNumber()
Sets the ending line number for the DocBlock
setExplicitCategory: in file ParserDocBlock.inc, method parserDocBlock::setExplicitCategory()
Used if this docblock has a @category tag.
setExplicitPackage: in file ParserDocBlock.inc, method parserDocBlock::setExplicitPackage()
Used if this docblock has a @package tag.
setExtends: in file ParserElements.inc, method parserClass::setExtends()
setFile: in file ParserData.inc, method parserPage::setFile()
Sets the name to display in documentation (can be an alias set with @name)
setFile: in file ParserElements.inc, method parserElement::setFile()
setFilesToParse: in file Setup.inc.php, method phpDocumentor_setup::setFilesToParse()
setHTMLColor: in file class.phpdocpdf.php, method phpdocpdf::setHTMLColor()
setId: in file PackagePageElements.inc, method parserXMLDocBookTag::setId()
If the id attribute is present, this method will set its id
setIgnore: in file Setup.inc.php, method phpDocumentor_setup::setIgnore()
setInterface: in file ParserElements.inc, method parserClass::setInterface()
Use this method to set the type of class to be an interface
setJavadocDesc: in file Setup.inc.php, method phpDocumentor_setup::setJavadocDesc()
setLineNum: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::setLineNum()
Start the parsing at a certain line number
setLineNum: in file HighlightParser.inc, method phpDocumentor_HighlightParser::setLineNum()
Start the parsing at a certain line number
setLineNumber: in file ParserDocBlock.inc, method parserDocBlock::setLineNumber()
Sets the starting line number for the DocBlock
setLineNumber: in file ParserElements.inc, method parserElement::setLineNumber()
Set starting line number
setMemoryLimit: in file Setup.inc.php, method phpDocumentor_setup::setMemoryLimit()
Allow a memory_limit setting in phpDocumentor.ini to override php.ini or default memory limit
setModifiers: in file ParserElements.inc, method parserVar::setModifiers()
Return name of the class that contains this method
setModifiers: in file ParserElements.inc, method parserMethod::setModifiers()
Return name of the class that contains this method
setModifiers: in file ParserElements.inc, method parserClass::setModifiers()
Set the PHP5+ modifiers for this class
setName: in file ParserData.inc, method parserPage::setName()
sets the name
setName: in file ProceduralPages.inc, method ProceduralPages::setName()
Change a page's name from its file to alias $name
setName: in file ParserElements.inc, method parserElement::setName()
setNext: in file ParserElements.inc, method parserTutorial::setNext()
setPackageOutput: in file ParserData.inc, method parserPage::setPackageOutput()
loads the package output array
setPackageOutput: in file Setup.inc.php, method phpDocumentor_setup::setPackageOutput()
setParent: in file ParserData.inc, method parserData::setParent()
sets the parent
setParent: in file ParserElements.inc, method parserTutorial::setParent()
setParent: in file ParserElements.inc, method parserClass::setParent()
setParentNoClass: in file ParserElements.inc, method parserClass::setParentNoClass()
setParseBase: in file ProceduralPages.inc, method ProceduralPages::setParseBase()
sets the parser base
setParsePrivate: in file Setup.inc.php, method phpDocumentor_setup::setParsePrivate()
setParsePrivate: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setParsePrivate()
set display of elements marked with @access private
setPath: in file ParserData.inc, method parserPage::setPath()
sets the path to the file
setPath: in file InlineTags.inc, method parserTocInlineTag::setPath()
set the path
setPath: in file ParserElements.inc, method parserElement::setPath()
setPos: in file WordParser.inc, method WordParser::setPos()
Set the internal cursor within the source code
setPrev: in file ParserElements.inc, method parserTutorial::setPrev()
setQuietMode: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setQuietMode()
set parsing information output mode (quiet or verbose)
setQuietMode: in file Setup.inc.php, method phpDocumentor_setup::setQuietMode()
setReturnsReference: in file ParserElements.inc, method parserFunction::setReturnsReference()
sets $returnsreference to true
setSeperator: in file WordParser.inc, method WordParser::setSeperator()
Sets the list of possible separator tokens
setShortDesc: in file ParserDocBlock.inc, method parserDocBlock::setShortDesc()
Set the short description of the DocBlock
setSource: in file InlineTags.inc, method parserSourceInlineTag::setSource()
sets the source tag's value
setSource: in file InlineTags.inc, method parserExampleInlineTag::setSource()
sets the source
setSource: in file ParserDocBlock.inc, method parserDocBlock::setSource()
Passes to parserStringWithInlineTags::setSource()
setSource: in file ParserData.inc, method parserStringWithInlineTags::setSource()
Pass source code to any {@source} tags contained within the string for later conversion.
setSource: in file ParserData.inc, method parserPage::setSource()
Sets the source code of the file for highlighting.
setSourceLocation: in file ParserData.inc, method parserPage::setSourceLocation()
sets the source location
setSourceLocation: in file ParserElements.inc, method parserClass::setSourceLocation()
setSourcePaths: in file Converter.inc, method Converter::setSourcePaths()
Mark a file as having had source code highlighted
setTargetDir: in file Setup.inc.php, method phpDocumentor_setup::setTargetDir()
setTargetDir: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setTargetDir()
Sets the output directory
setTargetDir: in file CHMdefaultConverter.inc, method CHMdefaultConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
setTargetDir: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
setTargetDir: in file XMLDocBookConverter.inc, method XMLDocBookConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
setTargetDir: in file Converter.inc, method Converter::setTargetDir()
Sets the output directory for generated documentation
setTargetDir: in file HTMLframesConverter.inc, method HTMLframesConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
setTemplateBase: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setTemplateBase()
Sets the template base directory
setTemplateBase: in file Setup.inc.php, method phpDocumentor_setup::setTemplateBase()
setTemplateBase: in file Converter.inc, method Converter::setTemplateBase()
Set the template directory with a different template base directory
setTemplateDir: in file Converter.inc, method Converter::setTemplateDir()
sets the template directory based on the $outputformat and $name
setTemplateDir: in file XMLDocBookConverter.inc, method XMLDocBookConverter::setTemplateDir()
setTemplateDir: in file CHMdefaultConverter.inc, method CHMdefaultConverter::setTemplateDir()
setTemplateDir: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::setTemplateDir()
setTemplateDir: in file PDFdefaultConverter.inc, method PDFdefaultConverter::setTemplateDir()
setTitle: in file Setup.inc.php, method phpDocumentor_setup::setTitle()
setTitle: in file PackagePageElements.inc, method parserXMLDocBookTag::setTitle()
Set the title of a DocBook tag section.
setTOC: in file InlineTags.inc, method parserTocInlineTag::setTOC()
set the TOC
setTOC: in file PackagePageElements.inc, method parserXMLDocBookTag::setTOC()
sets the TOC value
setUndocumentedElementWarnings: in file Setup.inc.php, method phpDocumentor_setup::setUndocumentedElementWarnings()
setUndocumentedElementWarningsMode: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::setUndocumentedElementWarningsMode()
show warnings for undocumented elements
setup: in file ParserDescCleanup.inc, method ObjectWordParser::setup()
Set the word parser to go.
setup: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::setup()
Uses http://www.php.net/token_get_all to tokenize the source code.
setup: in file WordParser.inc, method WordParser::setup()
Initialize the WordParser
setup: in file HighlightParser.inc, method phpDocumentor_HighlightWordParser::setup()
Initialize the parser object
setupPagePackages: in file ProceduralPages.inc, method ProceduralPages::setupPagePackages()
if there is one class package in a file, the parent path inherits the package if its package is default.
setupPages: in file ProceduralPages.inc, method ProceduralPages::setupPages()
Adjusts packages of all pages and removes name conflicts within a package
setupStates: in file ParserPDF.inc, method PDFParser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates: in file HighlightParser.inc, method phpDocumentor_HighlightParser::setupStates()
Initialize all parser state variables
setupStates: in file ParserDescCleanup.inc, method parserDescParser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates: in file Parser.inc, method Parser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates: in file XMLpackagePageParser.inc, method XMLPackagePageParser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
setupStates: in file Tokenizer.php, method phpDocumentor_XML_Beautifier_Tokenizer::setupStates()
Initialize all parser state variables
setupStates: in file TutorialHighlightParser.inc, method phpDocumentor_TutorialHighlightParser::setupStates()
Initialize all parser state variables
setupStates: in file Parser.inc, method ppageParser::setupStates()
set up invariant Parser variables
setupTOC: in file class.phpdocpdf.php, method phpdocpdf::setupTOC()
setup_dirs: in file Io.inc, function setup_dirs()
Recursively move contents of $struc into associative array
setValue: in file ParserData.inc, method parserBase::setValue()
sets the given value
setWhitespace: in file WordParser.inc, method WordParser::setWhitespace()
set parser to return or strip whitespace
set_dir: in file Io.inc, function set_dir()
Recursively add all the subdirectories of $contents to $dir without erasing anything in
showImage: in file utilities.php, function showImage()
Allows png's with alpha transparency to be displayed in IE 6
SmartyInit: in file HTMLframesConverter.inc, method HTMLframesConverter::SmartyInit()
SmartyInit: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::SmartyInit()
SmartyInit: in file XMLDocBookConverter.inc, method XMLDocBookConverter::SmartyInit()
SmartyInit: in file CHMdefaultConverter.inc, method CHMdefaultConverter::SmartyInit()
SMART_PATH_DELIMITER: in file common.inc.php, constant SMART_PATH_DELIMITER
sortPageContentsByElementType: in file Converter.inc, method Converter::sortPageContentsByElementType()
sorts $page_contents by element type as well as alphabetically
sourceLine: in file HTMLframesConverter.inc, method HTMLframesConverter::sourceLine()
Return a line of highlighted source code with formatted line number
sourceLine: in file CHMdefaultConverter.inc, method CHMdefaultConverter::sourceLine()
Return a line of highlighted source code with formatted line number
sourceLine: in file Converter.inc, method Converter::sourceLine()
Return a line of highlighted source code with formatted line number
sourceLine: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::sourceLine()
Return a line of highlighted source code with formatted line number
startCData: in file PackagePageElements.inc, method parserXMLDocBookTag::startCData()
Begin a new CData section
startHighlight: in file Converter.inc, method Converter::startHighlight()
Initialize highlight caching
STATE_ACCESS_MODIFIER: in file Parser.inc, constant STATE_ACCESS_MODIFIER
currently parsing an access modifier
STATE_ARRAY: in file Parser.inc, constant STATE_ARRAY
currently parsing an array
STATE_CLASS: in file Parser.inc, constant STATE_CLASS
currently parsing a class definition
STATE_CLASS_CONSTANT: in file Parser.inc, constant STATE_CLASS_CONSTANT
currently parsing a class constant
STATE_CLASS_MEMBER: in file Parser.inc, constant STATE_CLASS_MEMBER
currently parsing a class member using the HighlightParser
STATE_COMMENT: in file Parser.inc, constant STATE_COMMENT
currently parsing a short comment //
STATE_COMMENTBLOCK: in file Parser.inc, constant STATE_COMMENTBLOCK
currently parsing a long comment /x x/ where x is an asterisk
STATE_DEFINE: in file Parser.inc, constant STATE_DEFINE
currently parsing a define statement
STATE_DEFINE_PARAMS: in file Parser.inc, constant STATE_DEFINE_PARAMS
currently parsing the stuff in ( ) of a define statement
STATE_DEFINE_PARAMS_PARENTHESIS: in file Parser.inc, constant STATE_DEFINE_PARAMS_PARENTHESIS
currently parsing an inner parenthetical statement of a define( )
STATE_DESC: in file Parser.inc, constant STATE_DESC
currently parsing the desc part of a docblock
STATE_DOCBLOCK: in file Parser.inc, constant STATE_DOCBLOCK
currently parsing a DocBlock
STATE_DOCBLOCK_TEMPLATE: in file Parser.inc, constant STATE_DOCBLOCK_TEMPLATE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_DOCKEYWORD: in file Parser.inc, constant STATE_DOCKEYWORD
currently parsing a @tag in a DocBlock
STATE_DOCKEYWORD_EMAIL: in file Parser.inc, constant STATE_DOCKEYWORD_EMAIL
currently parsing an email in brackets in an @author tag of a DocBlock
STATE_END_CLASS: in file Parser.inc, constant STATE_END_CLASS
used to tell Render that a class has been completely parsed, and to flush buffers
STATE_END_DOCBLOCK_TEMPLATE: in file Parser.inc, constant STATE_END_DOCBLOCK_TEMPLATE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_EOFQUOTE: in file Parser.inc, constant STATE_EOFQUOTE
currently parsing a string defined using Perl <<<
STATE_ESCAPE: in file Parser.inc, constant STATE_ESCAPE
used when a backslash is encountered in parsing a string or other escapable entity
STATE_FUNCTION: in file Parser.inc, constant STATE_FUNCTION
currently parsing a Function or Method
STATE_FUNCTION_PARAMS: in file Parser.inc, constant STATE_FUNCTION_PARAMS
currently parsing the stuff in ( ) of a function definition
STATE_FUNCTION_PARAM_VAR: in file Parser.inc, constant STATE_FUNCTION_PARAM_VAR
currently parsing a $param in a function definition
STATE_FUNC_GLOBAL: in file Parser.inc, constant STATE_FUNC_GLOBAL
currently parsing a "global $var1, $var2;" declaration in a function
STATE_GLOBAL: in file Parser.inc, constant STATE_GLOBAL
currently parsing a global variable declaration
STATE_GLOBAL_VALUE: in file Parser.inc, constant STATE_GLOBAL_VALUE
currently parsing the default value in a global variable declaration
STATE_IMPLEMENTS: in file Parser.inc, constant STATE_IMPLEMENTS
currently parsing an implements clause
STATE_INCLUDE: in file Parser.inc, constant STATE_INCLUDE
currently parsing an include/require/include_once/include_once
STATE_INCLUDE_PARAMS: in file Parser.inc, constant STATE_INCLUDE_PARAMS
currently parsing the stuff in ( ) of a define statement
STATE_INCLUDE_PARAMS_PARENTHESIS: in file Parser.inc, constant STATE_INCLUDE_PARAMS_PARENTHESIS
currently parsing an inner parenthetical statement of an include/includeonce/require/requireonce( )
STATE_INLINE_DOCKEYWORD: in file Parser.inc, constant STATE_INLINE_DOCKEYWORD
currently parsing an inline tag like { @link} in a DocBlock
STATE_LOGICBLOCK: in file Parser.inc, constant STATE_LOGICBLOCK
currently parsing a { } block
STATE_METHOD: in file Parser.inc, constant STATE_METHOD
currently parsing a method using the HighlightParser
STATE_METHOD_LOGICBLOCK: in file Parser.inc, constant STATE_METHOD_LOGICBLOCK
currently parsing the method body using the HighlightParser
STATE_NOEVENTS: in file Parser.inc, constant STATE_NOEVENTS
out of < ? php tag
STATE_OUTPHP: in file Parser.inc, constant STATE_OUTPHP
currently out of php code
STATE_PHPCODE: in file Parser.inc, constant STATE_PHPCODE
currently parsing php code
STATE_QUOTE: in file Parser.inc, constant STATE_QUOTE
currently parsing a quote
STATE_QUOTE_VAR: in file Parser.inc, constant STATE_QUOTE_VAR
currently parsing a {$encapsed_var} using the HighlightParser
STATE_SINGLEQUOTE: in file Parser.inc, constant STATE_SINGLEQUOTE
currently parsing a string enclosed in single quotes (')
STATE_STATIC_VAR: in file Parser.inc, constant STATE_STATIC_VAR
currently parsing a "static $var1, $var2;" declaration in a function
STATE_STATIC_VAR_VALUE: in file Parser.inc, constant STATE_STATIC_VAR_VALUE
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_TAGS: in file Parser.inc, constant STATE_TAGS
currently parsing the @tag block of a docblock
STATE_TUTORIAL_ATTRIBUTE: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ATTRIBUTE
currently parsing an open <tag>
STATE_TUTORIAL_CLOSETAG: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_CLOSETAG
currently parsing a close </tag>
STATE_TUTORIAL_COMMENT: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_COMMENT
currently parsing a
STATE_TUTORIAL_DOUBLEQUOTE: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_DOUBLEQUOTE
currently parsing a
STATE_TUTORIAL_ENTITY: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ENTITY
currently parsing an &entity;
STATE_TUTORIAL_ITAG: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_ITAG
currently parsing an {@inline tag}
STATE_TUTORIAL_NOEVENTS: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_NOEVENTS
currently in starting state
STATE_TUTORIAL_OPENTAG: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_OPENTAG
currently parsing an open <tag>
STATE_TUTORIAL_SINGLEQUOTE: in file TutorialHighlightParser.inc, constant STATE_TUTORIAL_SINGLEQUOTE
currently parsing a
STATE_VAR: in file Parser.inc, constant STATE_VAR
currently parsing a Class variable
STATE_VAR_ARRAY: in file Parser.inc, constant STATE_VAR_ARRAY
currently parsing a variable value is an array
STATE_VAR_ARRAY_COMMENT: in file Parser.inc, constant STATE_VAR_ARRAY_COMMENT
currently parsing a comment in a variable array value
STATE_XMLTOKEN_ATTRIBUTE: in file Tokenizer.php, constant STATE_XMLTOKEN_ATTRIBUTE
currently parsing an open <tag>
STATE_XMLTOKEN_CDATA: in file Tokenizer.php, constant STATE_XMLTOKEN_CDATA
currently parsing a <!
STATE_XMLTOKEN_CLOSETAG: in file Tokenizer.php, constant STATE_XMLTOKEN_CLOSETAG
currently parsing a close </tag>
STATE_XMLTOKEN_COMMENT: in file Tokenizer.php, constant STATE_XMLTOKEN_COMMENT
currently parsing a
STATE_XMLTOKEN_DEF: in file Tokenizer.php, constant STATE_XMLTOKEN_DEF
currently parsing a <!
STATE_XMLTOKEN_DOUBLEQUOTE: in file Tokenizer.php, constant STATE_XMLTOKEN_DOUBLEQUOTE
currently parsing a
STATE_XMLTOKEN_ENTITY: in file Tokenizer.php, constant STATE_XMLTOKEN_ENTITY
currently parsing an &entity;
STATE_XMLTOKEN_IN_CDATA: in file Tokenizer.php, constant STATE_XMLTOKEN_IN_CDATA
currently parsing a <![CDATA[ ]]>
STATE_XMLTOKEN_NOEVENTS: in file Tokenizer.php, constant STATE_XMLTOKEN_NOEVENTS
currently in starting state
STATE_XMLTOKEN_OPENTAG: in file Tokenizer.php, constant STATE_XMLTOKEN_OPENTAG
currently parsing an open <tag>
STATE_XMLTOKEN_PI: in file Tokenizer.php, constant STATE_XMLTOKEN_PI
currently in processor instruction
STATE_XMLTOKEN_SINGLEQUOTE: in file Tokenizer.php, constant STATE_XMLTOKEN_SINGLEQUOTE
currently parsing a
STATE_XMLTOKEN_XML: in file Tokenizer.php, constant STATE_XMLTOKEN_XML
currently parsing a <?xml
staticvarTagHandler: in file Parser.inc, method Parser::staticvarTagHandler()
handles @staticvar
stringConvert: in file InlineTags.inc, method parserSourceInlineTag::stringConvert()
converter helper used in PHP 4.2.3-
Strlen: in file InlineTags.inc, method parserInlineTag::Strlen()
get length of the tag
Strlen: in file InlineTags.inc, method parserSourceInlineTag::Strlen()
only used to determine blank lines. {@source} will not be blank, probably
subscribe: in file Publisher.inc, method Publisher::subscribe()
Adds a subscriber to the $subscriber array().
suite: in file phpDocumentorSetupTests.php, method tests_phpDocumentorSetupTests::suite()
suite: in file phpDocumentorTParserTests.php, method tests_phpDocumentorTParserTests::suite()
suite: in file ParserPageTests.php, method tests_ParserPageTests::suite()
suite: in file IntermediateParserTests.php, method tests_IntermediateParserTests::suite()
suite: in file HighlightParserTests.php, method tests_HighlightParserTests::suite()
suite: in file ParserClassTests.php, method tests_ParserClassTests::suite()
switchDirTree: in file utilities.php, function switchDirTree()

top

t

$tags: in file ParserDocBlock.inc, variable parserDocBlock::$tags
array of parserTags
$targetDir: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$targetDir
used to set the output directory
$targetDir: in file Converter.inc, variable Converter::$targetDir
directory that output is sent to. -t command-line sets this.
$templateBase: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$templateBase
used to set the template base directory
$templateDir: in file Converter.inc, variable Converter::$templateDir
Directory that the template is in, relative to phpDocumentor root directory
$templateName: in file Converter.inc, variable Converter::$templateName
Name of the template, from last part of -o
$template_options: in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$template_options
template options. Currently only 1 recognized option usepear
$template_options: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$template_options
template options. Currently only 1 recognized option usepear
$template_options: in file Converter.inc, variable Converter::$template_options
Options for each template, parsed from the options.ini file in the template base directory
$title: in file LinkClasses.inc, variable tutorialLink::$title
$title: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$title
$title: in file Converter.inc, variable Converter::$title
$todoList: in file Converter.inc, variable Converter::$todoList
List of all @todo tags and a link to the element with the @todo
$tokens: in file Publisher.inc, variable Publisher::$tokens
$tutorial: in file ParserElements.inc, variable parserClass::$tutorial
$tutorial: in file ParserData.inc, variable parserData::$tutorial
$tutorial: in file InlineTags.inc, variable parserIdInlineTag::$tutorial
full name of the tutorial
$tutorial_type: in file ParserElements.inc, variable parserTutorial::$tutorial_type
Either cls, pkg, or proc
$type: in file LinkClasses.inc, variable varLink::$type
$type: in file ParserData.inc, variable parserPage::$type
Type is used by many functions to skip the hassle of if
$type: in file ParserDocBlock.inc, variable parserDesc::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserData.inc, variable parserBase::$type
Type is used by many functions to skip the hassle of if
$type: in file ParserData.inc, variable parserData::$type
Type is used by many functions to skip the hassle of if
$type: in file ParserData.inc, variable parserStringWithInlineTags::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...
$type: in file ParserElements.inc, variable parserConst::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserPackagePage::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserTutorial::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserVar::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserMethod::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserInclude::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserDefine::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserFunction::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserGlobal::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file ParserElements.inc, variable parserClass::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
$type: in file LinkClasses.inc, variable tutorialLink::$type
$type: in file LinkClasses.inc, variable globalLink::$type
$type: in file LinkClasses.inc, variable abstractLink::$type
element type linked to.
$type: in file InlineTags.inc, variable parserInlineTag::$type
Element type
$type: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$type
type of the current parser Element being handled
$type: in file LinkClasses.inc, variable functionLink::$type
$type: in file LinkClasses.inc, variable classLink::$type
$type: in file Errors.inc, variable RecordWarning::$type
name of global variable that descriptors for this warning/error is kept
$type: in file LinkClasses.inc, variable methodLink::$type
$type: in file LinkClasses.inc, variable pageLink::$type
$type: in file LinkClasses.inc, variable defineLink::$type
$type: in file LinkClasses.inc, variable constLink::$type
$type: in file DocBlockTags.inc, variable parserTag::$type
Type is used by many functions to skip the hassle of
$type: in file Errors.inc, variable RecordError::$type
name of global variable that descriptors for this warning/error is kept
top.php: procedural page top.php
Tokenizer.php: procedural page Tokenizer.php
TutorialHighlightParser.inc: procedural page TutorialHighlightParser.inc
tests_HighlightParserTests: in file HighlightParserTests.php, class tests_HighlightParserTests
tests_IntermediateParserTests: in file IntermediateParserTests.php, class tests_IntermediateParserTests
tests_ParserClassTests: in file ParserClassTests.php, class tests_ParserClassTests
tests_ParserPageTests: in file ParserPageTests.php, class tests_ParserPageTests
tests_phpDocumentorSetupTests: in file phpDocumentorSetupTests.php, class tests_phpDocumentorSetupTests
tests_phpDocumentorTParserTests: in file phpDocumentorTParserTests.php, class tests_phpDocumentorTParserTests
textcolor: in file class.phpdocpdf.php, method phpdocpdf::textcolor()
tokenEquals: in file phpDocumentorTWordParser.inc, method phpDocumentorTWordParser::tokenEquals()
Utility function to determine whether two tokens from the tokenizer are equal
tokenizer_ext: in file common.inc.php, constant tokenizer_ext
TranslateEntity: in file Converter.inc, method Converter::TranslateEntity()
Used to translate an XML DocBook entity like ” from a tutorial by reading the options.ini file for the template.
TranslateTag: in file Converter.inc, method Converter::TranslateTag()
Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
TranslateTag: in file PDFdefaultConverter.inc, method PDFdefaultConverter::TranslateTag()
Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
trimmedStrlen: in file ParserData.inc, method parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))
TutorialExample: in file Converter.inc, method Converter::TutorialExample()
TutorialExample: in file CHMdefaultConverter.inc, method CHMdefaultConverter::TutorialExample()
TutorialExample: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::TutorialExample()
TutorialExample: in file HTMLframesConverter.inc, method HTMLframesConverter::TutorialExample()
tutorialLink: in file LinkClasses.inc, class tutorialLink
tutorial link
TUTORIAL_EVENT_ATTRIBUTE: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_ATTRIBUTE
used when a <tag attr="attribute"> is found
TUTORIAL_EVENT_CLOSETAG: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_CLOSETAG
used when a close </tag> is found
TUTORIAL_EVENT_COMMENT: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_COMMENT
used when a  is found
TUTORIAL_EVENT_DOUBLEQUOTE: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_DOUBLEQUOTE
used when a  is found
TUTORIAL_EVENT_ENTITY: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_ENTITY
used when an &entity; is found
TUTORIAL_EVENT_ITAG: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_ITAG
used when an {@inline tag} is found
TUTORIAL_EVENT_NOEVENTS: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_NOEVENTS
starting state
TUTORIAL_EVENT_OPENTAG: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_OPENTAG
used when an open <tag> is found
TUTORIAL_EVENT_SINGLEQUOTE: in file TutorialHighlightParser.inc, constant TUTORIAL_EVENT_SINGLEQUOTE
used when a  is found
type_adjust: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::type_adjust()
type_adjust: in file Converter.inc, method Converter::type_adjust()
Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting
type_adjust: in file XMLDocBookConverter.inc, method XMLDocBookConverter::type_adjust()
T_ABSTRACT: in file Parser.inc, constant T_ABSTRACT
T_CONST: in file Parser.inc, constant T_CONST
T_DOC_COMMENT: in file Parser.inc, constant T_DOC_COMMENT
T_FINAL: in file Parser.inc, constant T_FINAL
T_IMPLEMENTS: in file Parser.inc, constant T_IMPLEMENTS
T_INTERFACE: in file Parser.inc, constant T_INTERFACE
T_ML_COMMENT: in file Parser.inc, constant T_ML_COMMENT
T_PRIVATE: in file Parser.inc, constant T_PRIVATE
T_PROTECTED: in file Parser.inc, constant T_PROTECTED
T_PUBLIC: in file Parser.inc, constant T_PUBLIC

top

u

$undocumentedElementWarnings: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$undocumentedElementWarnings
set in Setup.inc.php to the value of the undocumentedElementWarnings commandline option.
$unknown_tags: in file ParserDocBlock.inc, variable parserDocBlock::$unknown_tags
array of unrecognized parserTags
$uses: in file IntermediateParser.inc, variable phpDocumentor_IntermediateParser::$uses
utilities.php: procedural page utilities.php
unmangle: in file HTMLframesConverter.inc, method HTMLframesConverter::unmangle()
unmangle: in file XMLDocBookConverter.inc, method XMLDocBookConverter::unmangle()
unmangle: in file CHMdefaultConverter.inc, method CHMdefaultConverter::unmangle()
unmangle: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::unmangle()
unmangle: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::unmangle()
unmangle: in file Converter.inc, method Converter::unmangle()
Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.
unmangle: in file PDFdefaultConverter.inc, method PDFdefaultConverter::unmangle()
updateGlobals: in file ParserDocBlock.inc, method parserDocBlock::updateGlobals()
replaces nameless global variables in the $funcglobals array with their names
updateModifiers: in file ParserDocBlock.inc, method parserDocBlock::updateModifiers()
updateParams: in file ParserDocBlock.inc, method parserDocBlock::updateParams()
replaces nameless parameters in the $params array with their names
updateStatics: in file ParserDocBlock.inc, method parserDocBlock::updateStatics()
replaces nameless static variables in the $statics array with their names
usesTagHandler: in file Parser.inc, method Parser::usesTagHandler()
handles @uses

top

v

$valid_booleans: in file Io.inc, variable Io::$valid_booleans
A specific array of values that boolean-based arguments can understand, aided by the decideOnOrOff() helper method.
$value: in file ParserData.inc, variable parserBase::$value
set to different things by its descendants
$value: in file ParserData.inc, variable parserStringWithInlineTags::$value
array of strings and parserInlineTags
$var: in file ParserDocBlock.inc, variable parserDocBlock::$var
This is either a parserVarTag or false if no var tag is present
validHTMLColor: in file class.phpdocpdf.php, method phpdocpdf::validHTMLColor()
vardump_tree: in file Converter.inc, method Converter::vardump_tree()
Debugging function for dumping $tutorial_tree
Varize: in file Converter.inc, method Converter::Varize()
Used to convert the contents of <var> in a docblock
varLink: in file LinkClasses.inc, class varLink
class variable link
varTagHandler: in file Parser.inc, method Parser::varTagHandler()
handles @var
vdump_par: in file utilities.php, function vdump_par()

top

w

$warnings: in file Errors.inc, variable ErrorTracker::$warnings
array of RecordWarnings
$wrote: in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$wrote
$wrote: in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$wrote
$wrote: in file HTMLframesConverter.inc, variable HTMLframesConverter::$wrote
WordParser.inc: procedural page WordParser.inc
walk: in file Converter.inc, method Converter::walk()
called by phpDocumentor_IntermediateParser::Convert() to traverse the array of pages and their elements, converting them to the output format
walk_everything: in file Converter.inc, method Converter::walk_everything()
walk over elements by package rather than page
WordParser: in file WordParser.inc, class WordParser
Retrieves tokens from source code for use by the Parser
wordwrap: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::wordwrap()
writeExample: in file HTMLframesConverter.inc, method HTMLframesConverter::writeExample()
writeExample: in file PDFdefaultConverter.inc, method PDFdefaultConverter::writeExample()
writeExample: in file Converter.inc, method Converter::writeExample()
Write out the formatted source code for an example php file
writeExample: in file CHMdefaultConverter.inc, method CHMdefaultConverter::writeExample()
writeExample: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::writeExample()
writeExample: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeExample()
writeFile: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::writeFile()
Writes a file to target dir, beautify any .xml files first
writeFile: in file Converter.inc, method Converter::writeFile()
Writes a file to target dir
writefile: in file CHMdefaultConverter.inc, method CHMdefaultConverter::writefile()
Write a file to disk, and add it to the $hhp_files list of files to include in the generated CHM
writeNewPPage: in file HTMLframesConverter.inc, method HTMLframesConverter::writeNewPPage()
writeNewPPage: in file XMLDocBookConverter.inc, method XMLDocBookConverter::writeNewPPage()
writeNewPPage: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::writeNewPPage()
Does nothing
writeNewPPage: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeNewPPage()
writeNewPPage: in file CHMdefaultConverter.inc, method CHMdefaultConverter::writeNewPPage()
writeRIC: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeRIC()
writeSource: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::writeSource()
Does nothing
writeSource: in file HTMLframesConverter.inc, method HTMLframesConverter::writeSource()
writeSource: in file CHMdefaultConverter.inc, method CHMdefaultConverter::writeSource()
writeSource: in file Converter.inc, method Converter::writeSource()
Write out the formatted source code for a php file
writeSource: in file DocBlockTags.inc, method parserFileSourceTag::writeSource()
have the output converter write the source code
writeSource: in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeSource()
writeSource: in file PDFdefaultConverter.inc, method PDFdefaultConverter::writeSource()

top

x

XMLDocBookpeardoc2Converter.inc: procedural page XMLDocBookpeardoc2Converter.inc
XMLDocBookConverter.inc: procedural page XMLDocBookConverter.inc
XMLpackagePageParser.inc: procedural page XMLpackagePageParser.inc
XMLDocBookConverter: in file XMLDocBookConverter.inc, method XMLDocBookConverter::XMLDocBookConverter()
sets $base_dir to $targetDir
XMLDocBookConverter: in file XMLDocBookConverter.inc, class XMLDocBookConverter
XML DocBook converter.
XMLDocBookpeardoc2Converter: in file XMLDocBookpeardoc2Converter.inc, class XMLDocBookpeardoc2Converter
XML DocBook converter.
XMLDocBookpeardoc2Converter: in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::XMLDocBookpeardoc2Converter()
sets $base_dir to $targetDir
XMLPackagePageParser: in file XMLpackagePageParser.inc, method XMLPackagePageParser::XMLPackagePageParser()
Set up the wordparser
XMLPackagePageParser: in file XMLpackagePageParser.inc, class XMLPackagePageParser
Used to parse XML DocBook-based tutorials

top

_

$_colorStack: in file class.phpdocpdf.php, variable phpdocpdf::$_colorStack
$_implements: in file ParserElements.inc, variable parserClass::$_implements
$_modifiers: in file ParserElements.inc, variable parserVar::$_modifiers
$_modifiers: in file ParserElements.inc, variable parserMethod::$_modifiers
$_peardoc2_constants: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$_peardoc2_constants
Constants, used for constants.tpl
$_peardoc2_globals: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$_peardoc2_globals
Global Variables, used for globals.tpl
$_phpDocumentor_setting: in file Setup.inc.php, global variable $_phpDocumentor_setting
$_phpDocumentor_setting is either the value from the web interface, or is set up by Io::parseArgv()
$_save: in file class.phpdocpdf.php, variable phpdocpdf::$_save
$_sourcecode: in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$_sourcecode
Source files for appendix C are stored here
$_write_constants_xml: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$_write_constants_xml
$_write_globals_xml: in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$_write_globals_xml
$_xml: in file ParserElements.inc, variable parserTutorial::$_xml
_ezText: in file class.phpdocpdf.php, method phpdocpdf::_ezText()
_guessPackage: in file IntermediateParser.inc, method phpDocumentor_IntermediateParser::_guessPackage()
Guess the package/subpackage based on subdirectory if the --pear option
_IN_PHP5: in file common.inc.php, constant _IN_PHP5
_rmdir: in file Converter.inc, method Converter::_rmdir()
Completely remove a directory and its contents
_setHighlightCache: in file Converter.inc, method Converter::_setHighlightCache()
_setupIgnore: in file Io.inc, method Io::_setupIgnore()
Construct the $ignore array
_tutorial_path: in file Converter.inc, method Converter::_tutorial_path()
Returns the path to this tutorial as a string

top

Documentation generated on Tue, 06 Dec 2011 07:10:03 -0600 by phpDocumentor 1.4.4