-
$class
-
set to a classname if currently parsing a class, false if not
-
$classes
-
All class information, organized by path, and by package
-
$class_contents
-
alphabetical index of all methods and vars in a class by package/subpackage
-
$class_data
-
template for the class currently being processed
-
$class_elements
-
alphabetized index of classes by package
-
$curfile
-
full path of the current file being converted
-
$curpage
-
current procedural page being processed
-
checkState
-
Compare parserStringWithInlineTags::Convert() cache state to $state
-
cleanup
-
Finish up parsing/cleanup directories
-
Convert
-
Convert all elements to output format
-
convertClass
-
Default Class Handler
-
convertConst
-
Converts class constants for template output.
-
convertDefine
-
Converts defines for template output
-
Converter
-
Initialize Converter data structures
-
Converter
-
Base class for all output converters.
-
ConvertErrorLog
-
Convert the phpDocumentor parsing/conversion error log
-
convertFunction
-
Converts function for template output
-
convertGlobal
-
Converts global variables for template output
-
convertInclude
-
Converts includes for template output
-
convertMethod
-
Converts method for template output
-
convertPage
-
Default Page Handler
-
ConvertTitle
-
Convert the title of a Tutorial docbook tag section
-
ConvertTodoList
-
Convert the list of all @todo tags
-
convertTutorial
-
Default Tutorial Handler
-
convertVar
-
Converts class variables for template output.
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
copyFile
-
Copies a file from the template directory to the target directory
-
createParentDir
-
Recursively creates all subdirectories that don't exist in the $dir path
-
Converter.inc
-
-
$class_dir
-
output directory for the current class being processed
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
CHMdefaultConverter
-
Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)
-
CHMdefaultConverter
-
sets $base_dir to $targetDir
-
convertClass
-
Converts class for template output
-
convertConst
-
Converts class constants for template output
-
convertDefine
-
Converts defines for template output
-
ConvertErrorLog
-
Create errors.html template file output
-
convertFunction
-
Converts function for template output
-
convertGlobal
-
Converts global variables for template output
-
convertInclude
-
Converts include elements for template output
-
convertMethod
-
Converts class methods for template output
-
convertPackagepage
-
Converts package page and sets its package as used in $package_pages
-
convertPage
-
converts procedural pages for template output
-
ConvertTodoList
-
-
convertTutorial
-
-
convertVar
-
Converts class variables for template output
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
copyMediaRecursively
-
-
CHMdefaultConverter.inc
-
-
$class_dir
-
output directory for the current class being processed
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
convertClass
-
Converts class for template output
-
convertConst
-
Converts class variables for template output
-
convertDefine
-
Converts defines for template output
-
ConvertErrorLog
-
Create errors.html template file output
-
convertFunction
-
Converts function for template output
-
convertGlobal
-
Converts global variables for template output
-
convertInclude
-
Converts include elements for template output
-
convertMethod
-
Converts class methods for template output
-
convertPackagepage
-
Converts package page and sets its package as used in $package_pages
-
convertPage
-
converts procedural pages for template output
-
ConvertTodoList
-
-
convertTutorial
-
-
convertVar
-
Converts class variables for template output
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
copyMediaRecursively
-
-
$class_dir
-
output directory for the current class being processed
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
convertClass
-
Converts class for template output
-
convertConst
-
Converts class variables for template output
-
convertDefine
-
Converts defines for template output
-
ConvertErrorLog
-
Create errors.html template file output
-
convertFunction
-
Converts function for template output
-
convertGlobal
-
Converts global variables for template output
-
convertInclude
-
Converts include elements for template output
-
convertMethod
-
Converts class methods for template output
-
convertPackagepage
-
Converts package page and sets its package as used in $package_pages
-
convertPage
-
converts procedural pages for template output
-
ConvertTodoList
-
-
convertTutorial
-
-
convertVar
-
Converts class variables for template output
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
copyMediaRecursively
-
-
$classpackage_pagenums
-
-
$converter
-
-
$curclasspackage
-
-
$curpagepackage
-
-
convertClass
-
-
convertConst
-
-
convertDefine
-
-
convertDocBlock
-
-
convertFunction
-
-
convertGlobal
-
-
convertInclude
-
-
convertMethod
-
-
convertPackagepage
-
-
convertPage
-
-
convertParams
-
-
convertTutorial
-
-
convertVar
-
-
Convert_RIC
-
Convert README/INSTALL/CHANGELOG file contents to output format
-
class.phpdocpdf.php
-
-
$category
-
peardoc2 Category
-
$category
-
peardoc2 Category
-
$class
-
name of current class being converted
-
$class
-
name of current class being converted
-
$class_data
-
template for the class currently being processed
-
$class_data
-
template for the class currently being processed
-
$class_dir
-
output directory for the current class being processed
-
$class_dir
-
output directory for the current class being processed
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$current
-
contains all of the template procedural page element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
$currentclass
-
contains all of the template class element loop data needed for the current template
-
convertClass
-
Converts class for template output
-
convertClass
-
Converts class for template output
-
convertDefine
-
Converts defines for template output
-
convertDefine
-
Converts defines for template output
-
ConvertErrorLog
-
Create errors.html template file output
-
ConvertErrorLog
-
Create errors.html template file output
-
convertFunction
-
Converts function for template output - does nothing in peardoc2!
-
convertFunction
-
Converts function for template output
-
convertGlobal
-
Converts global variables for template output
-
convertGlobal
-
Converts global variables for template output
-
convertInclude
-
Converts include elements for template output
-
convertInclude
-
Converts include elements for template output
-
convertMethod
-
Converts method for template output
-
convertMethod
-
Converts method for template output
-
convertPackagePage
-
Does nothing - use tutorials for DocBook
-
convertPackagePage
-
Converts package page and sets its package as used in $package_pages
-
convertPage
-
converts procedural pages for template output
-
convertPage
-
converts procedural pages for template output
-
convertTutorial
-
-
convertTutorial
-
Convert tutorials for output
-
convertVar
-
Does nothing in this converter
-
convertVar
-
Converts class variables for template output.
-
$function_elements
-
alphabetized index of functions by package
-
flushHighlightCache
-
Return the close text for the current token
-
formatIndex
-
Called by walk() while converting.
-
formatLeftIndex
-
Called by walk() while converting.
-
formatPkgIndex
-
Called by walk() while converting.
-
formatTutorialTOC
-
Creates a table of contents for a {@toc} inline tag in a tutorial
-
formatIndex
-
CHMdefaultConverter uses this function to format template index.html and packages.html
-
formatLeftIndex
-
Generate indexes for li_package.html and classtree output files
-
formatPkgIndex
-
CHMdefaultConverter chooses to format both package indexes and the complete index here
-
formatTutorialTOC
-
Use the template tutorial_toc.tpl to generate a table of contents for HTML
-
formatIndex
-
HTMLdefaultConverter uses this function to format template index.html and packages.html
-
formatLeftIndex
-
Generate indexes for li_package.html and classtree output files
-
formatPkgIndex
-
HTMLdefaultConverter chooses to format both package indexes and the complete index here
-
formatTutorialTOC
-
Use the template tutorial_toc.tpl to generate a table of contents for HTML
-
formatIndex
-
HTMLdefaultConverter uses this function to format template index.html and packages.html
-
formatLeftIndex
-
Generate indexes for li_package.html and classtree output files
-
formatPkgIndex
-
HTMLdefaultConverter chooses to format both package indexes and the complete index here
-
formatTutorialTOC
-
Use the template tutorial_toc.tpl to generate a table of contents for HTML
-
$font_dir
-
-
$function_data
-
-
$function_data
-
-
flushPackageXml
-
-
formatIndex
-
Does nothing
-
formatIndex
-
HTMLdefaultConverter uses this function to format template index.html and packages.html
-
formatLeftIndex
-
Creates package/lang/categoryname/packagename.xml for each package
-
formatLeftIndex
-
Generate indexes for li_package.html and classtree output files
-
formatPkgIndex
-
Does nothing
-
formatPkgIndex
-
HTMLdefaultConverter chooses to format both package indexes and the complete index here
-
$global_elements
-
alphabetized index of global variables by package
-
generateChildClassList
-
returns a list of child classes
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class.
-
getClassesOnPage
-
gets a list of all classes declared on a procedural page represented by
-
getClassLink
-
-
getConstLink
-
return false or a
constLink to $expr in $class
-
getConverterDir
-
Get the absolute path to the converter's base directory
-
getCurrentPageLink
-
-
getCurrentPageURL
-
Return the path to the current
-
getDefineLink
-
-
getFileSourceName
-
Translate the path info into a unique file name for the highlighted source code.
-
getFileSourcePath
-
Return the fixed path to the source-code file folder.
-
getFormattedConflicts
-
-
getFormattedDescMethods
-
Get a list of methods in child classes that override this method
-
getFormattedDescVars
-
Get a list of vars in child classes that override this var
-
getFormattedImplements
-
returns an array containing the class inheritance tree from the root object to the class.
-
getFormattedInheritedConsts
-
Return template-enabled list of inherited class constants
-
getFormattedInheritedMethods
-
Return template-enabled list of inherited methods
-
getFormattedInheritedVars
-
Return template-enabled list of inherited variables
-
getFormattedMethodImplements
-
Get the method this method(s) implemented from an interface, if any
-
getFormattedOverrides
-
Get the method this method overrides, if any
-
getFunctionLink
-
-
getGlobalLink
-
-
getGlobalValue
-
Parse a global variable's default value for class initialization.
-
getHighlightState
-
-
getId
-
-
getIncludeValue
-
Parse an include's file to see if it is a file documented in this project
-
getLink
-
The meat of the @see tag and inline {@link} tag
-
getMethodLink
-
-
getPageLink
-
-
getSortedClassTreeFromClass
-
Return a tree of all classes that extend this class
-
getSourceLink
-
-
getState
-
Return parserStringWithInlineTags::Convert() cache state
-
getTutorialId
-
Return a converter-specific id to distinguish tutorials and their sections
-
getTutorialLink
-
The meat of the @tutorial tag and inline {@tutorial} tag
-
getTutorialTree
-
Get a tree structure representing the hierarchy of tutorials
-
getVarLink
-
return false or a
varLink to $expr in $class
-
generateElementIndex
-
Generate alphabetical index of all elements
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedInterfaceTrees
-
returns a template-enabled array of interface inheritance trees
-
generateKLinks
-
Get the table of contents for index.hhk
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndexes
-
-
generateTOC
-
-
getCData
-
-
getClassLink
-
-
getConstLink
-
-
getCurrentPageLink
-
-
getDefineLink
-
-
getExampleLink
-
-
getFunctionLink
-
-
getGlobalLink
-
-
getId
-
-
getIndexInformation
-
Generate indexing information for given element
-
getMethodLink
-
-
getPageLink
-
-
getPageName
-
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceLink
-
-
getTutorialId
-
-
getVarLink
-
-
generateElementIndex
-
Generate alphabetical index of all elements
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedInterfaceTrees
-
returns a template-enabled array of interface inheritance trees
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndexes
-
-
getCData
-
-
getClassLink
-
-
getConstLink
-
-
getCurrentPageLink
-
-
getDefineLink
-
-
getExampleLink
-
-
getFunctionLink
-
-
getGlobalLink
-
-
getId
-
-
getIndexInformation
-
Generate indexing information for given element
-
getMethodLink
-
-
getPageLink
-
-
getPageName
-
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceLink
-
-
getTutorialId
-
-
getTutorialTree
-
-
getVarLink
-
-
generateElementIndex
-
Generate alphabetical index of all elements
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedInterfaceTrees
-
returns a template-enabled array of interface inheritance trees
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndexes
-
-
getCData
-
-
getClassContents
-
-
getClassLeft
-
-
getClassLink
-
-
getConstLink
-
-
getCurrentPageLink
-
-
getDefineLink
-
-
getExampleLink
-
-
getFunctionLink
-
-
getGlobalLink
-
-
getId
-
-
getIndexInformation
-
Generate indexing information for given element
-
getMethodLink
-
-
getPageContents
-
-
getPageLeft
-
-
getPageLink
-
-
getPageName
-
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceLink
-
-
getTutorialId
-
-
getTutorialList
-
-
getTutorialTree
-
-
getVarLink
-
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
getCData
-
-
getClassLink
-
-
getColor
-
This really should be in the parent class
-
getConstLink
-
-
getDefineLink
-
-
getExampleLink
-
-
getFileSourceName
-
-
getFunctionLink
-
-
getGlobalLink
-
-
getGlobalValue
-
-
getMethodLink
-
-
getPageLink
-
-
getPageName
-
-
getParserEventName
-
Return the name of the parser event
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getSourceLink
-
-
getState
-
-
getTutorialId
-
-
getVarLink
-
-
getYPlusOffset
-
-
generateChildClassList
-
returns a list of child classes
-
generateElementIndex
-
Generate alphabetical index of all elements
-
generateElementIndex
-
does nothing
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTree
-
returns an array containing the class inheritance tree from the root object to the class
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedClassTrees
-
returns a template-enabled array of class trees
-
generateFormattedInterfaceTrees
-
returns a template-enabled array of interface inheritance trees
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndex
-
Generate alphabetical index of all elements by package and subpackage
-
generatePkgElementIndexes
-
-
generatePkgElementIndexes
-
-
getCData
-
-
getCData
-
-
getClassLink
-
-
getClassLink
-
-
getDefineLink
-
-
getDefineLink
-
-
getExampleLink
-
-
getFunctionLink
-
-
getFunctionLink
-
-
getGlobalLink
-
-
getGlobalLink
-
-
getId
-
Get the id value needed to allow linking
-
getId
-
Get the id value needed to allow linking
-
getLink
-
do that stuff in $template_options
-
getLink
-
do that stuff in $template_options
-
getMethodLink
-
-
getMethodLink
-
-
getPageLink
-
-
getPageLink
-
-
getPageName
-
-
getPageName
-
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getRootTree
-
return formatted class tree for the Class Trees page
-
getSourceAnchor
-
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a
@filesource tag.
-
getTutorialId
-
-
getTutorialId
-
-
getVarLink
-
-
getVarLink
-
-
$package
-
package name currently being converted
-
$packagecategories
-
Packages associated with categories
-
$package_elements
-
alphabetical index of all elements sorted by package, subpackage, page, and class.
-
$package_output
-
set to value of -po commandline
-
$package_parents
-
Hierarchy of packages
-
$page
-
name of current page being converted
-
$page_contents
-
alphabetical index of all elements on a page by package/subpackage
-
$page_data
-
template for the procedural page currently being processed
-
$page_elements
-
alphabetized index of procedural pages by package
-
$parseprivate
-
controls processing of elements marked private with @access private
-
$path
-
path of current page being converted
-
$pkg_elements
-
alphabetical index of all elements, indexed by package/subpackage
-
$processSpecialRoots
-
This converter knows about the new root tree processing
-
postProcess
-
This version does nothing
-
prepareDocBlock
-
convert the element's DocBlock for output
-
PreserveWhiteSpace
-
Used to convert the contents of <pre> in a docblock
-
ProgramExample
-
Used to convert the <code> tag in a docblock
-
$package_pages
-
array of converted package page names.
-
$page_dir
-
output directory for the current procedural page being processed
-
postProcess
-
Uses htmlspecialchars() on the input
-
ProgramExample
-
Used to convert the <code> tag in a docblock
-
$package_pages
-
array of converted package page names.
-
$page_dir
-
output directory for the current procedural page being processed
-
$processSpecialRoots
-
This converter knows about the new root tree processing
-
postProcess
-
Uses htmlspecialchars() on the input
-
ProgramExample
-
Used to convert the <code> tag in a docblock
-
$package_pages
-
array of converted package page names.
-
$page_dir
-
output directory for the current procedural page being processed
-
$processSpecialRoots
-
This converter knows about the new root tree processing
-
postProcess
-
Uses htmlspecialchars() on the input
-
ProgramExample
-
Used to convert the <code> tag in a docblock
-
$pagepackage_pagenums
-
-
$pdf
-
-
parse
-
Parse text for PDFParser XML tags, and add the text to the PDF file
-
PDFdefaultConverter
-
-
PDFdefaultConverter
-
PDF output converter.
-
PDFParser
-
-
PDFParser
-
Sets up the wordparser for this class
-
phpdocpdf
-
-
phpdocpdf
-
-
ParserPDF.inc
-
-
PDFdefaultConverter.inc
-
-
PHPDOCUMENTOR_PDF_EVENT_CONTENT
-
used for parsing stuff between <text>
-
PHPDOCUMENTOR_PDF_EVENT_FONT
-
when <font> is found in an ezText input
-
PHPDOCUMENTOR_PDF_EVENT_NEWPAGE
-
when <newpage/> is found in an ezText input
-
PHPDOCUMENTOR_PDF_EVENT_PDFFUNCTION
-
when <pdffunction> is found in an ezText input
-
PHPDOCUMENTOR_PDF_EVENT_TEXT
-
when <text> is found in an ezText input
-
PHPDOCUMENTOR_PDF_STATE_CONTENT
-
used for parsing stuff between <text>
-
PHPDOCUMENTOR_PDF_STATE_FONT
-
when <font> is found in an ezText input
-
PHPDOCUMENTOR_PDF_STATE_NEWPAGE
-
when <newpage/> is found in an ezText input
-
PHPDOCUMENTOR_PDF_STATE_PDFFUNCTION
-
when <pdffunction> is found in an ezText input
-
PHPDOCUMENTOR_PDF_STATE_TEXT
-
when <text> is found in an ezText input
-
postProcess
-
-
$packagexml
-
Contents of the packagename.xml file are stored in this template variable
-
$package_pages
-
array of converted package page names.
-
$package_pages
-
array of converted package page names.
-
$page
-
name of current page being converted
-
$page
-
name of current page being converted
-
$page_data
-
template for the procedural page currently being processed
-
$page_data
-
template for the procedural page currently being processed
-
$page_dir
-
output directory for the current procedural page being processed
-
$page_dir
-
output directory for the current procedural page being processed
-
$path
-
path of current page being converted
-
$path
-
path of current page being converted
-
$processSpecialRoots
-
This converter knows about the new root tree processing
-
postProcess
-
-
postProcess
-
-
prepareDocBlock
-
-
prepareDocBlock
-
-
ProgramExample
-
-
$smarty_dir
-
Directory that the smarty templates are in
-
$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_page_contents_by_type
-
This determines whether the $page_contents array should be sorted by element type as well as alphabetically by name
-
$sourcePaths
-
A list of files that have had source code generated
-
$subpackage
-
subpackage name currently being converted
-
Sampize
-
Used to convert the contents of <samp> in a docblock
-
setSourcePaths
-
Mark a file as having had source code highlighted
-
setTargetDir
-
Sets the output directory for generated documentation
-
setTemplateBase
-
Set the template directory with a different template base directory
-
setTemplateDir
-
sets the template directory based on the $outputformat and $name
-
sortPageContentsByElementType
-
sorts $page_contents by element type as well as alphabetically
-
sourceLine
-
Return a line of highlighted source code with formatted line number
-
startHighlight
-
Initialize highlight caching
-
$sort_page_contents_by_type
-
CHMdefaultConverter wants elements sorted by type as well as alphabetically
-
setTargetDir
-
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
-
setTemplateDir
-
-
SmartyInit
-
-
sourceLine
-
Return a line of highlighted source code with formatted line number
-
$sort_page_contents_by_type
-
Smarty Converter wants elements sorted by type as well as alphabetically
-
setTargetDir
-
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
-
SmartyInit
-
-
sourceLine
-
Return a line of highlighted source code with formatted line number
-
$sort_page_contents_by_type
-
Smarty Converter wants elements sorted by type as well as alphabetically
-
setTargetDir
-
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
-
SmartyInit
-
-
sourceLine
-
Return a line of highlighted source code with formatted line number
-
$set_pageNumbering
-
-
$smarty_dir
-
-
$sort_absolutely_everything
-
default PDF Converter wants elements sorted by type as well as alphabetically
-
setColorArray
-
-
setHTMLColor
-
-
setTemplateDir
-
-
setupStates
-
setup the parser tokens, and the pushEvent/popEvent arrays
-
setupTOC
-
-
$sort_absolutely_everything
-
Pass elements by package, simplifies generation of package.xml/category.xml
-
$sort_page_contents_by_type
-
XMLDocBookConverter wants elements sorted by type as well as alphabetically
-
$sort_page_contents_by_type
-
XMLDocBookConverter wants elements sorted by type as well as alphabetically
-
$sourceloc
-
-
$sourceloc
-
-
setTargetDir
-
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
-
setTemplateDir
-
-
setTemplateDir
-
-
SmartyInit
-