Element index for package Converters
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ j ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ q ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ x ]
top
b
- Bolden
- in file Converter.inc, method Converter::Bolden()
Used to convert the contents of <b> in a docblock
- Br
- in file Converter.inc, method Converter::Br()
Used to convert <br> in a docblock
- $base_dir
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$base_dir (subpackage: CHMdefault)
target directory passed on the command-line.
- $base_dir
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$base_dir (subpackage: HTMLdefault)
target directory passed on the command-line.
- $base_dir
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$base_dir (subpackage: HTMLframes)
target directory passed on the command-line.
- $base_dir
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$base_dir (subpackage: HTMLSmarty)
target directory passed on the command-line.
- $base_dir
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$base_dir (subpackage: XMLDocBook)
target directory passed on the command-line.
top
c
- $class
- in file Converter.inc, variable Converter::$class
set to a classname if currently parsing a class, false if not
- $classes
- in file Converter.inc, variable Converter::$classes
- $class_contents
- in file Converter.inc, variable Converter::$class_contents
alphabetical index of all methods and vars in a class by package/subpackage
- $class_elements
- in file Converter.inc, variable Converter::$class_elements
alphabetized index of classes by package
- $curfile
- in file Converter.inc, variable Converter::$curfile
name of the current file being converted
- checkState
- in file Converter.inc, method Converter::checkState()
Compare parserStringWithInlineTags::Convert() cache state to $state
- Convert
- in file Converter.inc, method Converter::Convert()
Convert all elements to output format
- Converter
- in file Converter.inc, method Converter::Converter()
Initialize Converter data structures
- Converter
- in file Converter.inc, class Converter
Base class for all output converters.
- ConvertErrorLog
- in file Converter.inc, method Converter::ConvertErrorLog()
- ConvertTitle
- in file Converter.inc, method Converter::ConvertTitle()
Convert the title of a Tutorial docbook tag section
- 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
- createParentDir
- in file Converter.inc, method Converter::createParentDir()
Recursively creates all subdirectories that don't exist in the $dir path
- Converter.inc
- procedural page Converter.inc
- $class
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$class (subpackage: CHMdefault)
name of current class being converted
- $class_data
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$class_data (subpackage: CHMdefault)
template for the class currently being processed
- $class_dir
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$class_dir (subpackage: CHMdefault)
output directory for the current class being processed
- $current
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$current (subpackage: CHMdefault)
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$currentclass (subpackage: CHMdefault)
contains all of the template class element loop data needed for the current template
- checkState
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::checkState() (subpackage: CHMdefault)
checks $state to see if it is the same as $local
- CHMdefaultConverter
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::CHMdefaultConverter() (subpackage: CHMdefault)
- CHMdefaultConverter
- in file CHMdefaultConverter.inc, class CHMdefaultConverter (subpackage: CHMdefault)
CHM output converter.
- Convert
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::Convert() (subpackage: CHMdefault)
Convert abstract $element for template
- convertClass
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertClass() (subpackage: CHMdefault)
Converts class for template output
- convertDefine
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertDefine() (subpackage: CHMdefault)
Converts defines for template output
- ConvertErrorLog
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::ConvertErrorLog() (subpackage: CHMdefault)
Create errors.html template file output
- convertFunction
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertFunction() (subpackage: CHMdefault)
Converts function for template output
- convertGlobal
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertGlobal() (subpackage: CHMdefault)
Converts global variables for template output
- convertInclude
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertInclude() (subpackage: CHMdefault)
Converts include elements for template output
- convertMethod
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertMethod() (subpackage: CHMdefault)
Converts method for template output
- convertPackagePage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertPackagePage() (subpackage: CHMdefault)
Converts package page and sets its package as used in $package_pages
- convertPage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertPage() (subpackage: CHMdefault)
converts procedural pages for template output
- convertTutorial
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertTutorial() (subpackage: CHMdefault)
- convertVar
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertVar() (subpackage: CHMdefault)
Converts class variables for template output.
- Convert_RIC
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::Convert_RIC() (subpackage: CHMdefault)
Convert README/INSTALL/CHANGELOG file contents to output format
- copyMediaRecursively
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::copyMediaRecursively() (subpackage: CHMdefault)
- CHMdefaultConverter.inc
- procedural page CHMdefaultConverter.inc (subpackage: CHMdefault)
- $class
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$class (subpackage: HTMLdefault)
name of current class being converted
- $class_data
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$class_data (subpackage: HTMLdefault)
template for the class currently being processed
- $class_dir
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$class_dir (subpackage: HTMLdefault)
output directory for the current class being processed
- $current
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$current (subpackage: HTMLdefault)
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$currentclass (subpackage: HTMLdefault)
contains all of the template class element loop data needed for the current template
- checkState
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::checkState() (subpackage: HTMLdefault)
checks $state to see if it is the same as $local
- Convert
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::Convert() (subpackage: HTMLdefault)
Convert abstract $element for template
- convertClass
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertClass() (subpackage: HTMLdefault)
Converts class for template output
- convertDefine
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertDefine() (subpackage: HTMLdefault)
Converts defines for template output
- ConvertErrorLog
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::ConvertErrorLog() (subpackage: HTMLdefault)
Create errors.html template file output
- convertFunction
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertFunction() (subpackage: HTMLdefault)
Converts function for template output
- convertGlobal
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertGlobal() (subpackage: HTMLdefault)
Converts global variables for template output
- convertInclude
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertInclude() (subpackage: HTMLdefault)
Converts include elements for template output
- convertMethod
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertMethod() (subpackage: HTMLdefault)
Converts method for template output
- convertPackagePage
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertPackagePage() (subpackage: HTMLdefault)
Converts package page and sets its package as used in $package_pages
- convertPage
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertPage() (subpackage: HTMLdefault)
converts procedural pages for template output
- convertVar
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::convertVar() (subpackage: HTMLdefault)
Converts class variables for template output.
- $class
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$class (subpackage: HTMLframes)
name of current class being converted
- $class_data
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$class_data (subpackage: HTMLframes)
template for the class currently being processed
- $class_dir
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$class_dir (subpackage: HTMLframes)
output directory for the current class being processed
- $current
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$current (subpackage: HTMLframes)
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$currentclass (subpackage: HTMLframes)
contains all of the template class element loop data needed for the current template
- checkState
- in file HTMLframesConverter.inc, method HTMLframesConverter::checkState() (subpackage: HTMLframes)
checks $state to see if it is the same as $local
- Convert
- in file HTMLframesConverter.inc, method HTMLframesConverter::Convert() (subpackage: HTMLframes)
Convert abstract $element for template
- convertClass
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertClass() (subpackage: HTMLframes)
Converts class for template output
- convertDefine
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertDefine() (subpackage: HTMLframes)
Converts defines for template output
- ConvertErrorLog
- in file HTMLframesConverter.inc, method HTMLframesConverter::ConvertErrorLog() (subpackage: HTMLframes)
Create errors.html template file output
- convertFunction
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertFunction() (subpackage: HTMLframes)
Converts function for template output
- convertGlobal
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertGlobal() (subpackage: HTMLframes)
Converts global variables for template output
- convertInclude
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertInclude() (subpackage: HTMLframes)
Converts include elements for template output
- convertMethod
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertMethod() (subpackage: HTMLframes)
Converts method for template output
- convertPackagePage
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertPackagePage() (subpackage: HTMLframes)
Converts package page and sets its package as used in $package_pages
- convertPage
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertPage() (subpackage: HTMLframes)
converts procedural pages for template output
- convertTutorial
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertTutorial() (subpackage: HTMLframes)
- convertVar
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertVar() (subpackage: HTMLframes)
Converts class variables for template output.
- Convert_RIC
- in file HTMLframesConverter.inc, method HTMLframesConverter::Convert_RIC() (subpackage: HTMLframes)
Convert README/INSTALL/CHANGELOG file contents to output format
- copyMediaRecursively
- in file HTMLframesConverter.inc, method HTMLframesConverter::copyMediaRecursively() (subpackage: HTMLframes)
- $class
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$class (subpackage: HTMLSmarty)
name of current class being converted
- $class_data
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$class_data (subpackage: HTMLSmarty)
template for the class currently being processed
- $class_dir
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$class_dir (subpackage: HTMLSmarty)
output directory for the current class being processed
- $current
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$current (subpackage: HTMLSmarty)
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$currentclass (subpackage: HTMLSmarty)
contains all of the template class element loop data needed for the current template
- checkState
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::checkState() (subpackage: HTMLSmarty)
checks $state to see if it is the same as $local
- Convert
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::Convert() (subpackage: HTMLSmarty)
Convert abstract $element for template
- convertClass
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertClass() (subpackage: HTMLSmarty)
Converts class for template output
- convertDefine
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertDefine() (subpackage: HTMLSmarty)
Converts defines for template output
- ConvertErrorLog
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ConvertErrorLog() (subpackage: HTMLSmarty)
Create errors.html template file output
- convertFunction
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertFunction() (subpackage: HTMLSmarty)
Converts function for template output
- convertGlobal
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertGlobal() (subpackage: HTMLSmarty)
Converts global variables for template output
- convertInclude
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertInclude() (subpackage: HTMLSmarty)
Converts include elements for template output
- convertMethod
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertMethod() (subpackage: HTMLSmarty)
Converts method for template output
- convertPackagePage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertPackagePage() (subpackage: HTMLSmarty)
Converts package page and sets its package as used in $package_pages
- convertPage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertPage() (subpackage: HTMLSmarty)
converts procedural pages for template output
- convertTutorial
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertTutorial() (subpackage: HTMLSmarty)
- convertVar
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertVar() (subpackage: HTMLSmarty)
Converts class variables for template output.
- Convert_RIC
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::Convert_RIC() (subpackage: HTMLSmarty)
Convert README/INSTALL/CHANGELOG file contents to output format
- copyMediaRecursively
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::copyMediaRecursively() (subpackage: HTMLSmarty)
- $classpackage_pagenums
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$classpackage_pagenums (subpackage: PDFdefault)
- $curclasspackage
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$curclasspackage (subpackage: PDFdefault)
- $curpagepackage
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$curpagepackage (subpackage: PDFdefault)
- Convert
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::Convert() (subpackage: PDFdefault)
Convert abstract $element for template
- convertClass
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertClass() (subpackage: PDFdefault)
- convertDefine
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertDefine() (subpackage: PDFdefault)
- convertDocBlock
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertDocBlock() (subpackage: PDFdefault)
- convertFunction
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertFunction() (subpackage: PDFdefault)
- convertGlobal
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertGlobal() (subpackage: PDFdefault)
- convertInclude
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertInclude() (subpackage: PDFdefault)
- convertMethod
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertMethod() (subpackage: PDFdefault)
- convertPackagePage
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertPackagePage() (subpackage: PDFdefault)
- convertPage
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertPage() (subpackage: PDFdefault)
- convertParams
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertParams() (subpackage: PDFdefault)
- convertTutorial
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertTutorial() (subpackage: PDFdefault)
- convertVar
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertVar() (subpackage: PDFdefault)
- Convert_RIC
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::Convert_RIC() (subpackage: PDFdefault)
Convert README/INSTALL/CHANGELOG file contents to output format
- $class
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class (subpackage: XMLDocBook)
name of current class being converted
- $class_data
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class_data (subpackage: XMLDocBook)
template for the class currently being processed
- $class_dir
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class_dir (subpackage: XMLDocBook)
output directory for the current class being processed
- $current
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$current (subpackage: XMLDocBook)
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$currentclass (subpackage: XMLDocBook)
contains all of the template class element loop data needed for the current template
- checkState
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::checkState() (subpackage: XMLDocBook)
checks $state to see if it is the same as $local
- Convert
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::Convert() (subpackage: XMLDocBook)
Convert abstract $element for template
- convertClass
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertClass() (subpackage: XMLDocBook)
Converts class for template output
- convertDefine
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertDefine() (subpackage: XMLDocBook)
Converts defines for template output
- ConvertErrorLog
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::ConvertErrorLog() (subpackage: XMLDocBook)
Create errors.html template file output
- convertFunction
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertFunction() (subpackage: XMLDocBook)
Converts function for template output
- convertGlobal
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertGlobal() (subpackage: XMLDocBook)
Converts global variables for template output
- convertInclude
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertInclude() (subpackage: XMLDocBook)
Converts include elements for template output
- convertMethod
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertMethod() (subpackage: XMLDocBook)
Converts method for template output
- convertPackagePage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertPackagePage() (subpackage: XMLDocBook)
Converts package page and sets its package as used in $package_pages
- convertPage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertPage() (subpackage: XMLDocBook)
converts procedural pages for template output
- convertTutorial
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertTutorial() (subpackage: XMLDocBook)
- convertVar
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertVar() (subpackage: XMLDocBook)
Converts class variables for template output.
top
top
e
- $elements
- in file Converter.inc, variable Converter::$elements
alphabetical index of all elements
- 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
- endClass
- in file Converter.inc, method Converter::endClass()
Called by walk() while converting, when the last class element has been parsed.
- endPage
- in file Converter.inc, method Converter::endPage()
Called by walk() while converting, when the last procedural page element has been parsed.
- endClass
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::endClass() (subpackage: CHMdefault)
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::endPage() (subpackage: CHMdefault)
Writes out the template file of $page_data and unsets the template to save memory
- endClass
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::endClass() (subpackage: HTMLdefault)
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::endPage() (subpackage: HTMLdefault)
Writes out the template file of $page_data and unsets the template to save memory
- endClass
- in file HTMLframesConverter.inc, method HTMLframesConverter::endClass() (subpackage: HTMLframes)
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file HTMLframesConverter.inc, method HTMLframesConverter::endPage() (subpackage: HTMLframes)
Writes out the template file of $page_data and unsets the template to save memory
- endClass
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::endClass() (subpackage: HTMLSmarty)
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::endPage() (subpackage: HTMLSmarty)
Writes out the template file of $page_data and unsets the template to save memory
- $eventHandlers
- in file ParserPDF.inc, variable PDFParser::$eventHandlers (subpackage: PDFdefault)
- endClass
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::endClass() (subpackage: XMLDocBook)
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::endPage() (subpackage: XMLDocBook)
Writes out the template file of $page_data and unsets the template to save memory
top
f
- $function_elements
- in file Converter.inc, variable Converter::$function_elements
alphabetized index of functions by package
- formatIndex
- in file Converter.inc, method Converter::formatIndex()
Called by walk() while converting.
- formatLeftIndex
- in file Converter.inc, method Converter::formatLeftIndex()
Called by walk() while converting.
- formatPkgIndex
- in file Converter.inc, method Converter::formatPkgIndex()
Called by walk() while converting.
- formatTutorialTOC
- in file Converter.inc, method Converter::formatTutorialTOC()
Creates a table of contents for a {@toc} inline tag in a tutorial
- formatIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatIndex() (subpackage: CHMdefault)
HTMLdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatLeftIndex() (subpackage: CHMdefault)
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatPkgIndex() (subpackage: CHMdefault)
HTMLdefaultConverter chooses to format both package indexes and the complete index here
- formatIndex
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::formatIndex() (subpackage: HTMLdefault)
HTMLdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::formatLeftIndex() (subpackage: HTMLdefault)
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::formatPkgIndex() (subpackage: HTMLdefault)
HTMLdefaultConverter chooses to format both package indexes and the complete index here
- formatUsesList
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::formatUsesList() (subpackage: HTMLdefault)
- formatIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::formatIndex() (subpackage: HTMLframes)
HTMLdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::formatLeftIndex() (subpackage: HTMLframes)
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::formatPkgIndex() (subpackage: HTMLframes)
HTMLdefaultConverter chooses to format both package indexes and the complete index here
- formatTutorialTOC
- in file HTMLframesConverter.inc, method HTMLframesConverter::formatTutorialTOC() (subpackage: HTMLframes)
Use the template tutorial_toc.tpl to generate a table of contents for HTML
- formatIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatIndex() (subpackage: HTMLSmarty)
HTMLdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatLeftIndex() (subpackage: HTMLSmarty)
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatPkgIndex() (subpackage: HTMLSmarty)
HTMLdefaultConverter chooses to format both package indexes and the complete index here
- formatTutorialTOC
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatTutorialTOC() (subpackage: HTMLSmarty)
Use the template tutorial_toc.tpl to generate a table of contents for HTML
- $function_data
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$function_data (subpackage: XMLDocBook)
- formatIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatIndex() (subpackage: XMLDocBook)
HTMLdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatLeftIndex() (subpackage: XMLDocBook)
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatPkgIndex() (subpackage: XMLDocBook)
HTMLdefaultConverter chooses to format both package indexes and the complete index here
top
g
- $global_elements
- in file Converter.inc, variable Converter::$global_elements
alphabetized index of global variables by package
- getClassLink
- in file Converter.inc, method Converter::getClassLink()
return false or a classLink to $expr
- getConverterDir
- in file Converter.inc, method Converter::getConverterDir()
Get the absolute path to the converter's base directory
- getDefineLink
- in file Converter.inc, method Converter::getDefineLink()
return false or a defineLink to $expr
- getFunctionLink
- in file Converter.inc, method Converter::getFunctionLink()
return false or a functionLink to $expr
- getGlobalLink
- in file Converter.inc, method Converter::getGlobalLink()
return false or a globalLink to $expr
- getGlobalValue
- in file Converter.inc, method Converter::getGlobalValue()
Parse a global variable's default value for class initialization.
- getIncludeValue
- in file Converter.inc, method Converter::getIncludeValue()
Parse an include's file to see if it is a file documented in this project
- getLink
- in file Converter.inc, method Converter::getLink()
The meat of the @see tag and inline {@link} tag
- getMethodLink
- in file Converter.inc, method Converter::getMethodLink()
return false or a methodLink to $expr in $class
- getPageLink
- in file Converter.inc, method Converter::getPageLink()
return false or a pageLink to $expr
- getPPageId
- in file Converter.inc, method Converter::getPPageId()
Used by {@id}
- getSortedClassTreeFromClass
- in file Converter.inc, method Converter::getSortedClassTreeFromClass()
Return a tree of all classes that extend this class
- getSourceLink
- in file Converter.inc, method Converter::getSourceLink()
- getState
- in file Converter.inc, method Converter::getState()
Return parserStringWithInlineTags::Convert() cache state
- getTutorialLink
- in file Converter.inc, method Converter::getTutorialLink()
The meat of the @tutorial tag and inline { @tutorial} tag
- getTutorialTree
- in file Converter.inc, method Converter::getTutorialTree()
- getVarLink
- in file Converter.inc, method Converter::getVarLink()
return false or a varLink to $expr in $class
- generateChildClassList
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateChildClassList() (subpackage: CHMdefault)
returns a list of child classes
- generateElementIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateElementIndex() (subpackage: CHMdefault)
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateFormattedClassTree() (subpackage: CHMdefault)
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateFormattedClassTrees() (subpackage: CHMdefault)
returns a template-enabled array of class trees
- generatePkgElementIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generatePkgElementIndex() (subpackage: CHMdefault)
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generatePkgElementIndexes() (subpackage: CHMdefault)
- generateTOC
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateTOC() (subpackage: CHMdefault)
- getCData
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getCData() (subpackage: CHMdefault)
- getClassesOnPage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getClassesOnPage() (subpackage: CHMdefault)
gets a list of all classes declared on a procedural page represented by $element, a parserData class
- getClassLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getClassLink() (subpackage: CHMdefault)
- getDefineLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getDefineLink() (subpackage: CHMdefault)
- getFormattedConflicts
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getFormattedConflicts() (subpackage: CHMdefault)
- getFormattedDescMethods
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getFormattedDescMethods() (subpackage: CHMdefault)
Get a list of methods in child classes that override this method
- getFormattedInheritedMethods
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getFormattedInheritedMethods() (subpackage: CHMdefault)
Return template-enabled list of inherited methods
- getFormattedInheritedVars
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getFormattedInheritedVars() (subpackage: CHMdefault)
Return template-enabled list of inherited variables
- getFormattedOverrides
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getFormattedOverrides() (subpackage: CHMdefault)
Get the method this method overrides, if any
- getFunctionLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getFunctionLink() (subpackage: CHMdefault)
- getGlobalLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getGlobalLink() (subpackage: CHMdefault)
- getMethodLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getMethodLink() (subpackage: CHMdefault)
- getPageLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getPageLink() (subpackage: CHMdefault)
- getPageName
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getPageName() (subpackage: CHMdefault)
- getPPageId
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getPPageId() (subpackage: CHMdefault)
- getRootTree
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getRootTree() (subpackage: CHMdefault)
return formatted class tree for the Class Trees page
- getState
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getState() (subpackage: CHMdefault)
returns $local
- getVarLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getVarLink() (subpackage: CHMdefault)
- generateChildClassList
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::generateChildClassList() (subpackage: HTMLdefault)
returns a string containing a comma-delimited list of child classes
- generateElementIndex
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::generateElementIndex() (subpackage: HTMLdefault)
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::generateFormattedClassTree() (subpackage: HTMLdefault)
returns a string containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::generateFormattedClassTrees() (subpackage: HTMLdefault)
returns a template-enabled array of class trees
- generatePkgElementIndex
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::generatePkgElementIndex() (subpackage: HTMLdefault)
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::generatePkgElementIndexes() (subpackage: HTMLdefault)
- getCData
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getCData() (subpackage: HTMLdefault)
- getClassesOnPage
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getClassesOnPage() (subpackage: HTMLdefault)
gets a list of all classes declared on a procedural page represented by $element, a parserData class
- getClassLink
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getClassLink() (subpackage: HTMLdefault)
- getDefineLink
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getDefineLink() (subpackage: HTMLdefault)
- getFormattedConflicts
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getFormattedConflicts() (subpackage: HTMLdefault)
- getFormattedDescMethods
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getFormattedDescMethods() (subpackage: HTMLdefault)
- getFormattedInheritedMethods
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getFormattedInheritedMethods() (subpackage: HTMLdefault)
Return template-enabled list of inherited methods
- getFormattedInheritedVars
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getFormattedInheritedVars() (subpackage: HTMLdefault)
Return template-enabled list of inherited variables
- getFormattedOverrides
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getFormattedOverrides() (subpackage: HTMLdefault)
- getFunctionLink
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getFunctionLink() (subpackage: HTMLdefault)
- getGlobalLink
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getGlobalLink() (subpackage: HTMLdefault)
- getMethodLink
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getMethodLink() (subpackage: HTMLdefault)
- getPageLink
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getPageLink() (subpackage: HTMLdefault)
- getPageName
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getPageName() (subpackage: HTMLdefault)
- getRootTree
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getRootTree() (subpackage: HTMLdefault)
return formatted class tree for the Class Trees page
- getState
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getState() (subpackage: HTMLdefault)
returns $local
- getVarLink
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::getVarLink() (subpackage: HTMLdefault)
- generateChildClassList
- in file HTMLframesConverter.inc, method HTMLframesConverter::generateChildClassList() (subpackage: HTMLframes)
returns a list of child classes
- generateElementIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::generateElementIndex() (subpackage: HTMLframes)
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file HTMLframesConverter.inc, method HTMLframesConverter::generateFormattedClassTree() (subpackage: HTMLframes)
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file HTMLframesConverter.inc, method HTMLframesConverter::generateFormattedClassTrees() (subpackage: HTMLframes)
returns a template-enabled array of class trees
- generatePkgElementIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::generatePkgElementIndex() (subpackage: HTMLframes)
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file HTMLframesConverter.inc, method HTMLframesConverter::generatePkgElementIndexes() (subpackage: HTMLframes)
- getCData
- in file HTMLframesConverter.inc, method HTMLframesConverter::getCData() (subpackage: HTMLframes)
- getClassesOnPage
- in file HTMLframesConverter.inc, method HTMLframesConverter::getClassesOnPage() (subpackage: HTMLframes)
gets a list of all classes declared on a procedural page represented by $element, a parserData class
- getClassLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getClassLink() (subpackage: HTMLframes)
- getDefineLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getDefineLink() (subpackage: HTMLframes)
- getExampleLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getExampleLink() (subpackage: HTMLframes)
- getFormattedConflicts
- in file HTMLframesConverter.inc, method HTMLframesConverter::getFormattedConflicts() (subpackage: HTMLframes)
- getFormattedDescMethods
- in file HTMLframesConverter.inc, method HTMLframesConverter::getFormattedDescMethods() (subpackage: HTMLframes)
Get a list of methods in child classes that override this method
- getFormattedInheritedMethods
- in file HTMLframesConverter.inc, method HTMLframesConverter::getFormattedInheritedMethods() (subpackage: HTMLframes)
Return template-enabled list of inherited methods
- getFormattedInheritedVars
- in file HTMLframesConverter.inc, method HTMLframesConverter::getFormattedInheritedVars() (subpackage: HTMLframes)
Return template-enabled list of inherited variables
- getFormattedOverrides
- in file HTMLframesConverter.inc, method HTMLframesConverter::getFormattedOverrides() (subpackage: HTMLframes)
Get the method this method overrides, if any
- getFunctionLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getFunctionLink() (subpackage: HTMLframes)
- getGlobalLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getGlobalLink() (subpackage: HTMLframes)
- getMethodLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getMethodLink() (subpackage: HTMLframes)
- getPageLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getPageLink() (subpackage: HTMLframes)
- getPageName
- in file HTMLframesConverter.inc, method HTMLframesConverter::getPageName() (subpackage: HTMLframes)
- getPPageId
- in file HTMLframesConverter.inc, method HTMLframesConverter::getPPageId() (subpackage: HTMLframes)
- getRootTree
- in file HTMLframesConverter.inc, method HTMLframesConverter::getRootTree() (subpackage: HTMLframes)
return formatted class tree for the Class Trees page
- getSourceLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getSourceLink() (subpackage: HTMLframes)
- getState
- in file HTMLframesConverter.inc, method HTMLframesConverter::getState() (subpackage: HTMLframes)
returns $local
- getTutorialTree
- in file HTMLframesConverter.inc, method HTMLframesConverter::getTutorialTree() (subpackage: HTMLframes)
- getVarLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getVarLink() (subpackage: HTMLframes)
- generateChildClassList
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateChildClassList() (subpackage: HTMLSmarty)
returns a list of child classes
- generateElementIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateElementIndex() (subpackage: HTMLSmarty)
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateFormattedClassTree() (subpackage: HTMLSmarty)
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateFormattedClassTrees() (subpackage: HTMLSmarty)
returns a template-enabled array of class trees
- generatePkgElementIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generatePkgElementIndex() (subpackage: HTMLSmarty)
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generatePkgElementIndexes() (subpackage: HTMLSmarty)
- getCData
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getCData() (subpackage: HTMLSmarty)
- getClassContents
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassContents() (subpackage: HTMLSmarty)
- getClassesOnPage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassesOnPage() (subpackage: HTMLSmarty)
gets a list of all classes declared on a procedural page represented by $element, a parserData class
- getClassLeft
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassLeft() (subpackage: HTMLSmarty)
- getClassLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassLink() (subpackage: HTMLSmarty)
- getDefineLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getDefineLink() (subpackage: HTMLSmarty)
- getExampleLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getExampleLink() (subpackage: HTMLSmarty)
- getFormattedConflicts
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getFormattedConflicts() (subpackage: HTMLSmarty)
- getFormattedDescMethods
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getFormattedDescMethods() (subpackage: HTMLSmarty)
Get a list of methods in child classes that override this method
- getFormattedInheritedMethods
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getFormattedInheritedMethods() (subpackage: HTMLSmarty)
Return template-enabled list of inherited methods
- getFormattedInheritedVars
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getFormattedInheritedVars() (subpackage: HTMLSmarty)
Return template-enabled list of inherited variables
- getFormattedOverrides
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getFormattedOverrides() (subpackage: HTMLSmarty)
Get the method this method overrides, if any
- getFunctionLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getFunctionLink() (subpackage: HTMLSmarty)
- getGlobalLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getGlobalLink() (subpackage: HTMLSmarty)
- getMethodLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getMethodLink() (subpackage: HTMLSmarty)
- getPageContents
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageContents() (subpackage: HTMLSmarty)
- getPageLeft
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageLeft() (subpackage: HTMLSmarty)
- getPageLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageLink() (subpackage: HTMLSmarty)
- getPageName
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageName() (subpackage: HTMLSmarty)
- getPPageId
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPPageId() (subpackage: HTMLSmarty)
- getRootTree
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getRootTree() (subpackage: HTMLSmarty)
return formatted class tree for the Class Trees page
- getSourceLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getSourceLink() (subpackage: HTMLSmarty)
- getState
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getState() (subpackage: HTMLSmarty)
returns $local
- getTutorialList
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getTutorialList() (subpackage: HTMLSmarty)
- getTutorialTree
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getTutorialTree() (subpackage: HTMLSmarty)
- getVarLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getVarLink() (subpackage: HTMLSmarty)
- generateFormattedClassTrees
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::generateFormattedClassTrees() (subpackage: PDFdefault)
returns a template-enabled array of class trees
- getCData
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getCData() (subpackage: PDFdefault)
- getClassLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getClassLink() (subpackage: PDFdefault)
- getDefineLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getDefineLink() (subpackage: PDFdefault)
- getFunctionLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getFunctionLink() (subpackage: PDFdefault)
- getGlobalLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getGlobalLink() (subpackage: PDFdefault)
- getMethodLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getMethodLink() (subpackage: PDFdefault)
- getPageLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getPageLink() (subpackage: PDFdefault)
- getPageName
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getPageName() (subpackage: PDFdefault)
- getParserEventName
- in file ParserPDF.inc, method PDFParser::getParserEventName() (subpackage: PDFdefault)
- getPPageId
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getPPageId() (subpackage: PDFdefault)
- getRootTree
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getRootTree() (subpackage: PDFdefault)
return formatted class tree for the Class Trees page
- getState
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getState() (subpackage: PDFdefault)
- getVarLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getVarLink() (subpackage: PDFdefault)
- generateChildClassList
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateChildClassList() (subpackage: XMLDocBook)
returns a list of child classes
- generateElementIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateElementIndex() (subpackage: XMLDocBook)
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateFormattedClassTree() (subpackage: XMLDocBook)
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateFormattedClassTrees() (subpackage: XMLDocBook)
returns a template-enabled array of class trees
- generatePkgElementIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generatePkgElementIndex() (subpackage: XMLDocBook)
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generatePkgElementIndexes() (subpackage: XMLDocBook)
- getCData
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getCData() (subpackage: XMLDocBook)
- getClassesOnPage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getClassesOnPage() (subpackage: XMLDocBook)
gets a list of all classes declared on a procedural page represented by $element, a parserData class
- getClassLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getClassLink() (subpackage: XMLDocBook)
- getDefineLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getDefineLink() (subpackage: XMLDocBook)
- getFormattedConflicts
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getFormattedConflicts() (subpackage: XMLDocBook)
- getFormattedDescMethods
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getFormattedDescMethods() (subpackage: XMLDocBook)
- getFormattedInheritedMethods
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getFormattedInheritedMethods() (subpackage: XMLDocBook)
Return template-enabled list of inherited methods
- getFormattedInheritedVars
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getFormattedInheritedVars() (subpackage: XMLDocBook)
Return template-enabled list of inherited variables
- getFormattedOverrides
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getFormattedOverrides() (subpackage: XMLDocBook)
Get the method this method overrides, if any
- getFunctionLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getFunctionLink() (subpackage: XMLDocBook)
- getGlobalLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getGlobalLink() (subpackage: XMLDocBook)
- getId
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getId() (subpackage: XMLDocBook)
Get the id value needed to allow linking
- getLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getLink() (subpackage: XMLDocBook)
do that stuff in $template_options
- getMethodLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getMethodLink() (subpackage: XMLDocBook)
- getPageLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getPageLink() (subpackage: XMLDocBook)
- getPageName
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getPageName() (subpackage: XMLDocBook)
- getPPageId
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getPPageId() (subpackage: XMLDocBook)
- getRootTree
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getRootTree() (subpackage: XMLDocBook)
return formatted class tree for the Class Trees page
- getState
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getState() (subpackage: XMLDocBook)
returns $local
- getVarLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getVarLink() (subpackage: XMLDocBook)
top
h
- hasTutorial
- in file Converter.inc, method Converter::hasTutorial()
- highlightSource
- in file Converter.inc, method Converter::highlightSource()
Called by parserSourceInlineTag::arrayConvert() to allow converters to format the source code the way they'd like.
- HTMLdefaultConverter
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::HTMLdefaultConverter() (subpackage: HTMLdefault)
sets $base_dir to $targetDir
- HTMLdefaultConverter
- in file HTMLdefaultConverter.inc, class HTMLdefaultConverter (subpackage: HTMLdefault)
HTML output converter.
- HTMLdefaultConverter.inc
- procedural page HTMLdefaultConverter.inc (subpackage: HTMLdefault)
- highlightSource
- in file HTMLframesConverter.inc, method HTMLframesConverter::highlightSource() (subpackage: HTMLframes)
Called by parserSourceInlineTag::arrayConvert() to allow converters to format the source code the way they'd like.
- HTMLframesConverter
- in file HTMLframesConverter.inc, method HTMLframesConverter::HTMLframesConverter() (subpackage: HTMLframes)
- HTMLframesConverter
- in file HTMLframesConverter.inc, class HTMLframesConverter (subpackage: HTMLframes)
HTML output converter.
- HTMLframesConverter.inc
- procedural page HTMLframesConverter.inc (subpackage: HTMLframes)
- highlightSource
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::highlightSource() (subpackage: HTMLSmarty)
Called by parserSourceInlineTag::arrayConvert() to allow converters to format the source code the way they'd like.
- HTMLSmartyConverter
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::HTMLSmartyConverter() (subpackage: HTMLSmarty)
- HTMLSmartyConverter
- in file HTMLSmartyConverter.inc, class HTMLSmartyConverter (subpackage: HTMLSmarty)
HTML output converter.
- HTMLSmartyConverter.inc
- procedural page HTMLSmartyConverter.inc (subpackage: HTMLSmarty)
- handleContent
- in file ParserPDF.inc, method PDFParser::handleContent() (subpackage: PDFdefault)
- handleFont
- in file ParserPDF.inc, method PDFParser::handleFont() (subpackage: PDFdefault)
- handleNewPage
- in file ParserPDF.inc, method PDFParser::handleNewPage() (subpackage: PDFdefault)
- handlePDFFunction
- in file ParserPDF.inc, method PDFParser::handlePDFFunction() (subpackage: PDFdefault)
- handleText
- in file ParserPDF.inc, method PDFParser::handleText() (subpackage: PDFdefault)
- highlightSource
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::highlightSource() (subpackage: PDFdefault)
Called by parserSourceInlineTag::arrayConvert() to allow converters to format the source code the way they'd like.
top
i
- Italicize
- in file Converter.inc, method Converter::Italicize()
Used to convert the contents of <i> in a docblock
top
top
l
- $leftindex
- in file Converter.inc, variable Converter::$leftindex
Controls which of the one-element-only indexes are generated.
- ListItem
- in file Converter.inc, method Converter::ListItem()
Used to convert the contents of <li> in a docblock
- $leftindex
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$leftindex (subpackage: CHMdefault)
indexes of elements by package that need to be generated
- $local
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$local (subpackage: CHMdefault)
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
- $leftindex
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$leftindex (subpackage: HTMLdefault)
indexes of elements by package that need to be generated
- $local
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$local (subpackage: HTMLdefault)
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
- $leftindex
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$leftindex (subpackage: HTMLframes)
indexes of elements by package that need to be generated
- $local
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$local (subpackage: HTMLframes)
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
- $leftindex
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$leftindex (subpackage: HTMLSmarty)
indexes of elements by package that need to be generated
- $local
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$local (subpackage: HTMLSmarty)
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
- $leftindex
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$leftindex (subpackage: PDFdefault)
- $leftindex
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$leftindex (subpackage: XMLDocBook)
indexes of elements by package that need to be generated
- $local
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$local (subpackage: XMLDocBook)
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
top
top
n
- $name
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$name (subpackage: CHMdefault)
- newSmarty
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::newSmarty() (subpackage: CHMdefault)
- $name
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$name (subpackage: HTMLdefault)
- $name
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$name (subpackage: HTMLframes)
- newSmarty
- in file HTMLframesConverter.inc, method HTMLframesConverter::newSmarty() (subpackage: HTMLframes)
- $name
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$name (subpackage: HTMLSmarty)
- newSmarty
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::newSmarty() (subpackage: HTMLSmarty)
- $name
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$name (subpackage: PDFdefault)
- newSmarty
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::newSmarty() (subpackage: PDFdefault)
- $name
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$name (subpackage: XMLDocBook)
- newSmarty
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::newSmarty() (subpackage: XMLDocBook)
top
o
- $outputformat
- in file Converter.inc, variable Converter::$outputformat
output format of this converter
- Output
- in file Converter.inc, method Converter::Output()
do all necessary output
- $outputformat
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$outputformat (subpackage: CHMdefault)
- Output
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::Output() (subpackage: CHMdefault)
This function will be used by CHMdefaultConverter to call html help compiler
- $outputformat
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$outputformat (subpackage: HTMLdefault)
- Output
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::Output() (subpackage: HTMLdefault)
This function is not used by HTMLdefaultConverter, but is required by Converter
- $outputformat
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$outputformat (subpackage: HTMLframes)
- Output
- in file HTMLframesConverter.inc, method HTMLframesConverter::Output() (subpackage: HTMLframes)
This function is not used by HTMLdefaultConverter, but is required by Converter
- $outputformat
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$outputformat (subpackage: HTMLSmarty)
- Output
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::Output() (subpackage: HTMLSmarty)
This function is not used by HTMLdefaultConverter, but is required by Converter
- $outputformat
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$outputformat (subpackage: PDFdefault)
- Output
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::Output() (subpackage: PDFdefault)
calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir
- $outputformat
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$outputformat (subpackage: XMLDocBook)
- Output
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::Output() (subpackage: XMLDocBook)
This function is not used by HTMLdefaultConverter, but is required by Converter
top
p
- $package
- in file Converter.inc, variable Converter::$package
package name
- $package_elements
- in file Converter.inc, variable Converter::$package_elements
alphabetical index of all elements sorted by package, subpackage, page, and class. Used by
- $package_output
- in file Converter.inc, variable Converter::$package_output
set to value of -po commandline
- $package_parents
- in file Converter.inc, variable Converter::$package_parents
- $page_contents
- in file Converter.inc, variable Converter::$page_contents
alphabetical index of all elements on a page by package/subpackage
- $page_elements
- in file Converter.inc, variable Converter::$page_elements
alphabetized index of procedural pages by package
- $parseprivate
- in file Converter.inc, variable Converter::$parseprivate
controls processing of elements marked private with @access private
- $pkg_elements
- in file Converter.inc, variable Converter::$pkg_elements
alphabetical index of all elements
- postProcess
- in file Converter.inc, method Converter::postProcess()
This version does nothing
- PreserveWhiteSpace
- in file Converter.inc, method Converter::PreserveWhiteSpace()
Used to convert the contents of <pre> in a docblock
- ProgramExample
- in file Converter.inc, method Converter::ProgramExample()
Used to convert the <code> tag in a docblock
- $package_pages
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$package_pages (subpackage: CHMdefault)
array of converted package page names.
- $page
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$page (subpackage: CHMdefault)
name of current page being converted
- $page_data
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$page_data (subpackage: CHMdefault)
template for the procedural page currently being processed
- $page_dir
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$page_dir (subpackage: CHMdefault)
output directory for the current procedural page being processed
- $path
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$path (subpackage: CHMdefault)
path of current page being converted
- postProcess
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::postProcess() (subpackage: CHMdefault)
- prepareDocBlock
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::prepareDocBlock() (subpackage: CHMdefault)
convert the element's DocBlock for output
- ProgramExample
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::ProgramExample() (subpackage: CHMdefault)
- $package_pages
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$package_pages (subpackage: HTMLdefault)
array of converted package page names.
- $page
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$page (subpackage: HTMLdefault)
name of current page being converted
- $page_data
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$page_data (subpackage: HTMLdefault)
template for the procedural page currently being processed
- $page_dir
- in file HTMLdefaultConverter.inc, variable HTMLdefaultConverter::$page_dir (subpackage: HTMLdefault)
output directory for the current procedural page being processed
- postProcess
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::postProcess() (subpackage: HTMLdefault)
- prepareDocBlock
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::prepareDocBlock() (subpackage: HTMLdefault)
convert the element's DocBlock for output
- $package_pages
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$package_pages (subpackage: HTMLframes)
array of converted package page names.
- $page
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$page (subpackage: HTMLframes)
name of current page being converted
- $page_data
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$page_data (subpackage: HTMLframes)
template for the procedural page currently being processed
- $page_dir
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$page_dir (subpackage: HTMLframes)
output directory for the current procedural page being processed
- $path
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$path (subpackage: HTMLframes)
path of current page being converted
- postProcess
- in file HTMLframesConverter.inc, method HTMLframesConverter::postProcess() (subpackage: HTMLframes)
- prepareDocBlock
- in file HTMLframesConverter.inc, method HTMLframesConverter::prepareDocBlock() (subpackage: HTMLframes)
convert the element's DocBlock for output
- ProgramExample
- in file HTMLframesConverter.inc, method HTMLframesConverter::ProgramExample() (subpackage: HTMLframes)
- $package_pages
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$package_pages (subpackage: HTMLSmarty)
array of converted package page names.
- $page
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$page (subpackage: HTMLSmarty)
name of current page being converted
- $page_data
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$page_data (subpackage: HTMLSmarty)
template for the procedural page currently being processed
- $page_dir
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$page_dir (subpackage: HTMLSmarty)
output directory for the current procedural page being processed
- $path
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$path (subpackage: HTMLSmarty)
path of current page being converted
- postProcess
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::postProcess() (subpackage: HTMLSmarty)
- prepareDocBlock
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::prepareDocBlock() (subpackage: HTMLSmarty)
convert the element's DocBlock for output
- ProgramExample
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ProgramExample() (subpackage: HTMLSmarty)
- $pagepackage_pagenums
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$pagepackage_pagenums (subpackage: PDFdefault)
- $pdf
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$pdf (subpackage: PDFdefault)
- parse
- in file ParserPDF.inc, method PDFParser::parse() (subpackage: PDFdefault)
Parse a new file
- PDFdefaultConverter
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::PDFdefaultConverter() (subpackage: PDFdefault)
- PDFdefaultConverter
- in file PDFdefaultConverter.inc, class PDFdefaultConverter (subpackage: PDFdefault)
PDF output converter.
- PDFParser
- in file ParserPDF.inc, method PDFParser::PDFParser() (subpackage: PDFdefault)
- PDFParser
- in file ParserPDF.inc, class PDFParser (subpackage: PDFdefault)
- ParserPDF.inc
- procedural page ParserPDF.inc (subpackage: PDFdefault)
- PDFdefaultConverter.inc
- procedural page PDFdefaultConverter.inc (subpackage: PDFdefault)
- PHPDOCUMENTOR_PDF_EVENT_CONTENT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_CONTENT (subpackage: PDFdefault)
used for parsing stuff between <text>
- PHPDOCUMENTOR_PDF_EVENT_FONT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_FONT (subpackage: PDFdefault)
when <text> is found in an ezText input
- PHPDOCUMENTOR_PDF_EVENT_NEWPAGE
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_NEWPAGE (subpackage: PDFdefault)
when <newpage/> is found in an ezText input
- PHPDOCUMENTOR_PDF_EVENT_PDFFUNCTION
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_PDFFUNCTION (subpackage: PDFdefault)
when <pdffunction> is found in an ezText input
- PHPDOCUMENTOR_PDF_EVENT_TEXT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_TEXT (subpackage: PDFdefault)
when <text> is found in an ezText input
- PHPDOCUMENTOR_PDF_STATE_CONTENT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_CONTENT (subpackage: PDFdefault)
used for parsing stuff between <text>
- PHPDOCUMENTOR_PDF_STATE_FONT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_FONT (subpackage: PDFdefault)
when <text> is found in an ezText input
- PHPDOCUMENTOR_PDF_STATE_NEWPAGE
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_NEWPAGE (subpackage: PDFdefault)
when <newpage/> is found in an ezText input
- PHPDOCUMENTOR_PDF_STATE_PDFFUNCTION
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_PDFFUNCTION (subpackage: PDFdefault)
when <pdffunction> is found in an ezText input
- PHPDOCUMENTOR_PDF_STATE_TEXT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_TEXT (subpackage: PDFdefault)
when <text> is found in an ezText input
- $package_pages
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$package_pages (subpackage: XMLDocBook)
array of converted package page names.
- $page
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page (subpackage: XMLDocBook)
name of current page being converted
- $page_data
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page_data (subpackage: XMLDocBook)
template for the procedural page currently being processed
- $page_dir
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page_dir (subpackage: XMLDocBook)
output directory for the current procedural page being processed
- $path
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$path (subpackage: XMLDocBook)
path of current page being converted
- postProcess
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::postProcess() (subpackage: XMLDocBook)
- prepareDocBlock
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::prepareDocBlock() (subpackage: XMLDocBook)
convert the element's DocBlock for output
top
q
- $quietmode
- in file Converter.inc, variable Converter::$quietmode
controls display of progress information while parsing.
top
r
- 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
- returnSee
- in file Converter.inc, method Converter::returnSee()
take abstractLink descendant and text $eltext and return a link in the format needed for the Converter
- $ric_set
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$ric_set (subpackage: CHMdefault)
sets $base_dir to $targetDir
- rcNatCmp
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::rcNatCmp() (subpackage: CHMdefault)
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::rcNatCmp1() (subpackage: CHMdefault)
does a nat case sort on the specified second level value of the array.
- returnLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::returnLink() (subpackage: CHMdefault)
- returnSee
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::returnSee() (subpackage: CHMdefault)
This function takes an abstractLink descendant and returns an html link
- rcNatCmp
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::rcNatCmp() (subpackage: HTMLdefault)
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::rcNatCmp1() (subpackage: HTMLdefault)
does a nat case sort on the specified second level value of the array.
- registerCurrent
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::registerCurrent() (subpackage: HTMLdefault)
Registers all of the procedural page elements on a page for variable substitution and output
- registerCurrentClass
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::registerCurrentClass() (subpackage: HTMLdefault)
Registers all of the class elements in a class for variable substitution and output
- returnLink
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::returnLink() (subpackage: HTMLdefault)
- returnSee
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::returnSee() (subpackage: HTMLdefault)
This function takes an abstractLink descendant and returns an html link
- $ric_set
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$ric_set (subpackage: HTMLframes)
- rcNatCmp
- in file HTMLframesConverter.inc, method HTMLframesConverter::rcNatCmp() (subpackage: HTMLframes)
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file HTMLframesConverter.inc, method HTMLframesConverter::rcNatCmp1() (subpackage: HTMLframes)
does a nat case sort on the specified second level value of the array.
- returnLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::returnLink() (subpackage: HTMLframes)
- returnSee
- in file HTMLframesConverter.inc, method HTMLframesConverter::returnSee() (subpackage: HTMLframes)
This function takes an abstractLink descendant and returns an html link
- rcNatCmp
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::rcNatCmp() (subpackage: HTMLSmarty)
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::rcNatCmp1() (subpackage: HTMLSmarty)
does a nat case sort on the specified second level value of the array.
- returnLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::returnLink() (subpackage: HTMLSmarty)
- returnSee
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::returnSee() (subpackage: HTMLSmarty)
This function takes an abstractLink descendant and returns an html link
- $ric_set
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$ric_set (subpackage: PDFdefault)
- returnLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::returnLink() (subpackage: PDFdefault)
- returnSee
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::returnSee() (subpackage: PDFdefault)
Returns a bookmark using Cezpdf 009
- rcNatCmp
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::rcNatCmp() (subpackage: XMLDocBook)
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::rcNatCmp1() (subpackage: XMLDocBook)
does a nat case sort on the specified second level value of the array.
- returnLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::returnLink() (subpackage: XMLDocBook)
- returnSee
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::returnSee() (subpackage: XMLDocBook)
This function takes an abstractLink descendant and returns an html link
top
s
- $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_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
- $subpackage
- in file Converter.inc, variable Converter::$subpackage
subpackage name
- setTargetDir
- in file Converter.inc, method Converter::setTargetDir()
Sets the output directory for generated documentation
- setTemplateDir
- in file Converter.inc, method Converter::setTemplateDir()
sets the template directory based on the $outputformat and $name
- sortPageContentsByElementType
- in file Converter.inc, method Converter::sortPageContentsByElementType()
sorts $page_contents by element type as well as alphabetically
- sourceLine
- in file Converter.inc, method Converter::sourceLine()
- $sort_page_contents_by_type
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$sort_page_contents_by_type (subpackage: CHMdefault)
CHMdefaultConverter wants elements sorted by type as well as alphabetically
- setTargetDir
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::setTargetDir() (subpackage: CHMdefault)
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- setTemplateDir
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::setTemplateDir() (subpackage: CHMdefault)
- setTargetDir
- in file HTMLdefaultConverter.inc, method HTMLdefaultConverter::setTargetDir() (subpackage: HTMLdefault)
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- $sort_page_contents_by_type
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$sort_page_contents_by_type (subpackage: HTMLframes)
Smarty Converter wants elements sorted by type as well as alphabetically
- setTargetDir
- in file HTMLframesConverter.inc, method HTMLframesConverter::setTargetDir() (subpackage: HTMLframes)
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- setTemplateDir
- in file HTMLframesConverter.inc, method HTMLframesConverter::setTemplateDir() (subpackage: HTMLframes)
- $sort_page_contents_by_type
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$sort_page_contents_by_type (subpackage: HTMLSmarty)
Smarty Converter wants elements sorted by type as well as alphabetically
- setTargetDir
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::setTargetDir() (subpackage: HTMLSmarty)
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- setTemplateDir
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::setTemplateDir() (subpackage: HTMLSmarty)
- $smarty_dir
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$smarty_dir (subpackage: PDFdefault)
- $sort_absolutely_everything
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$sort_absolutely_everything (subpackage: PDFdefault)
default PDF Converter wants elements sorted by type as well as alphabetically
- setTemplateDir
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::setTemplateDir() (subpackage: PDFdefault)
- setupStates
- in file ParserPDF.inc, method PDFParser::setupStates() (subpackage: PDFdefault)
setup the parser tokens, and the pushEvent/popEvent arrays
- $sort_page_contents_by_type
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$sort_page_contents_by_type (subpackage: XMLDocBook)
XMLDocBookConverter wants elements sorted by type as well as alphabetically
- $sourceloc
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$sourceloc (subpackage: XMLDocBook)
- setTargetDir
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::setTargetDir() (subpackage: XMLDocBook)
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- setTemplateDir
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::setTemplateDir() (subpackage: XMLDocBook)
top
t
- $targetDir
- in file Converter.inc, variable Converter::$targetDir
directory that output is sent to. -t command-line sets this.
- $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
- $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 Converter.inc, variable Converter::$title
- 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.
- type_adjust
- in file Converter.inc, method Converter::type_adjust()
Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting
- $template_options
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$template_options (subpackage: XMLDocBook)
template options. Currently only 1 recognized option usepear
- type_adjust
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::type_adjust() (subpackage: XMLDocBook)
top
top
top
w
- 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
- writeExample
- in file Converter.inc, method Converter::writeExample()
Write out the formatted source code for an example php file
- writeFile
- in file Converter.inc, method Converter::writeFile()
Writes a file to target dir
- writeSource
- in file Converter.inc, method Converter::writeSource()
Write out the formatted source code for a php file
- writeSourceFunction
- in file Converter.inc, method Converter::writeSourceFunction()
Write out the formatted source code for a function
- writefile
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::writefile() (subpackage: CHMdefault)
- writeNewPPage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::writeNewPPage() (subpackage: CHMdefault)
- $wrote
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$wrote (subpackage: HTMLframes)
sets $base_dir to $targetDir
- writeExample
- in file HTMLframesConverter.inc, method HTMLframesConverter::writeExample() (subpackage: HTMLframes)
- writeNewPPage
- in file HTMLframesConverter.inc, method HTMLframesConverter::writeNewPPage() (subpackage: HTMLframes)
- writeSource
- in file HTMLframesConverter.inc, method HTMLframesConverter::writeSource() (subpackage: HTMLframes)
- writeExample
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeExample() (subpackage: HTMLSmarty)
- writeNewPPage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeNewPPage() (subpackage: HTMLSmarty)
- writeRIC
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeRIC() (subpackage: HTMLSmarty)
- writeSource
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeSource() (subpackage: HTMLSmarty)
- writeNewPPage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::writeNewPPage() (subpackage: XMLDocBook)
top
top
Documentation generated on Fri, 30 Apr 2004 22:08:43 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.
|
|
