Element index for package Converters
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ j ]
[ k ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ q ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ x ]
[ _ ]
_
- _rmdir
- in file Converter.inc, method Converter::_rmdir()
Completely remove a directory and its contents
- _setHighlightCache
- in file Converter.inc, method Converter::_setHighlightCache()
- _tutorial_path
- in file Converter.inc, method Converter::_tutorial_path()
Returns the path to this tutorial as a string
- $_colorStack
- in file class.phpdocpdf.php, variable phpdocpdf::$_colorStack
- $_save
- in file class.phpdocpdf.php, variable phpdocpdf::$_save
- $_sourcecode
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$_sourcecode
Source files for appendix C are stored here
- _ezText
- in file class.phpdocpdf.php, method phpdocpdf::_ezText()
- $_peardoc2_constants
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$_peardoc2_constants
Constants, used for constants.tpl
- $_peardoc2_globals
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$_peardoc2_globals
Global Variables, used for globals.tpl
- $_write_constants_xml
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$_write_constants_xml
- $_write_globals_xml
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$_write_globals_xml
top
a
- $all_packages
- in file Converter.inc, variable Converter::$all_packages
All packages encountered in parsing
- adv_htmlentities
- in file Converter.inc, function adv_htmlentities()
smart htmlentities, doesn't entity the allowed tags list
- AttrToString
- in file Converter.inc, method Converter::AttrToString()
Convert the attribute of a Tutorial docbook tag's attribute list
- addHHP
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::addHHP()
- addKLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::addKLink()
Add an item to the index.hhk file
- addSourceTOC
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::addSourceTOC()
- addTOC
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::addTOC()
- addMessage
- in file class.phpdocpdf.php, method phpdocpdf::addMessage()
- addSummaryToPackageXml
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::addSummaryToPackageXml()
top
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
All class information, organized by path, and by package
- $class_contents
- in file Converter.inc, variable Converter::$class_contents
alphabetical index of all methods and vars in a class by package/subpackage
- $class_data
- in file Converter.inc, variable Converter::$class_data
template for the class currently being processed
- $class_elements
- in file Converter.inc, variable Converter::$class_elements
alphabetized index of classes by package
- $curfile
- in file Converter.inc, variable Converter::$curfile
full path of the current file being converted
- $curpage
- in file Converter.inc, variable Converter::$curpage
current procedural page being processed
- checkState
- in file Converter.inc, method Converter::checkState()
Compare parserStringWithInlineTags::Convert() cache state to $state
- cleanup
- in file Converter.inc, method Converter::cleanup()
Finish up parsing/cleanup directories
- Convert
- in file Converter.inc, method Converter::Convert()
Convert all elements to output format
- convertClass
- in file Converter.inc, method Converter::convertClass()
Default Class Handler
- convertConst
- in file Converter.inc, method Converter::convertConst()
Converts class constants for template output.
- convertDefine
- in file Converter.inc, method Converter::convertDefine()
Converts defines for template output
- 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()
Convert the phpDocumentor parsing/conversion error log
- convertFunction
- in file Converter.inc, method Converter::convertFunction()
Converts function for template output
- convertGlobal
- in file Converter.inc, method Converter::convertGlobal()
Converts global variables for template output
- convertInclude
- in file Converter.inc, method Converter::convertInclude()
Converts includes for template output
- convertMethod
- in file Converter.inc, method Converter::convertMethod()
Converts method for template output
- convertPage
- in file Converter.inc, method Converter::convertPage()
Default Page Handler
- ConvertTitle
- in file Converter.inc, method Converter::ConvertTitle()
Convert the title of a Tutorial docbook tag section
- ConvertTodoList
- in file Converter.inc, method Converter::ConvertTodoList()
Convert the list of all @todo tags
- convertTutorial
- in file Converter.inc, method Converter::convertTutorial()
Default Tutorial Handler
- convertVar
- in file Converter.inc, method Converter::convertVar()
Converts class variables for template output.
- 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_dir
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$class_dir
output directory for the current class being processed
- $current
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$current
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$currentclass
contains all of the template class element loop data needed for the current template
- CHMdefaultConverter
- in file CHMdefaultConverter.inc, class CHMdefaultConverter
Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)
- CHMdefaultConverter
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::CHMdefaultConverter()
sets $base_dir to $targetDir
- convertClass
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertClass()
Converts class for template output
- convertConst
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertConst()
Converts class constants for template output
- convertDefine
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertDefine()
Converts defines for template output
- ConvertErrorLog
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::ConvertErrorLog()
Create errors.html template file output
- convertFunction
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertFunction()
Converts function for template output
- convertGlobal
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertGlobal()
Converts global variables for template output
- convertInclude
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertInclude()
Converts include elements for template output
- convertMethod
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertMethod()
Converts class methods for template output
- convertPackagepage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
- convertPage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertPage()
converts procedural pages for template output
- ConvertTodoList
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::ConvertTodoList()
- convertTutorial
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertTutorial()
- convertVar
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::convertVar()
Converts class variables for template output
- Convert_RIC
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
- copyMediaRecursively
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::copyMediaRecursively()
- CHMdefaultConverter.inc
- procedural page CHMdefaultConverter.inc
- $class_dir
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$class_dir
output directory for the current class being processed
- $current
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$current
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$currentclass
contains all of the template class element loop data needed for the current template
- convertClass
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertClass()
Converts class for template output
- convertConst
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertConst()
Converts class variables for template output
- convertDefine
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertDefine()
Converts defines for template output
- ConvertErrorLog
- in file HTMLframesConverter.inc, method HTMLframesConverter::ConvertErrorLog()
Create errors.html template file output
- convertFunction
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertFunction()
Converts function for template output
- convertGlobal
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertGlobal()
Converts global variables for template output
- convertInclude
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertInclude()
Converts include elements for template output
- convertMethod
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertMethod()
Converts class methods for template output
- convertPackagepage
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
- convertPage
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertPage()
converts procedural pages for template output
- ConvertTodoList
- in file HTMLframesConverter.inc, method HTMLframesConverter::ConvertTodoList()
- convertTutorial
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertTutorial()
- convertVar
- in file HTMLframesConverter.inc, method HTMLframesConverter::convertVar()
Converts class variables for template output
- Convert_RIC
- in file HTMLframesConverter.inc, method HTMLframesConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
- copyMediaRecursively
- in file HTMLframesConverter.inc, method HTMLframesConverter::copyMediaRecursively()
- $class_dir
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$class_dir
output directory for the current class being processed
- $current
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$current
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$currentclass
contains all of the template class element loop data needed for the current template
- convertClass
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertClass()
Converts class for template output
- convertConst
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertConst()
Converts class variables for template output
- convertDefine
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertDefine()
Converts defines for template output
- ConvertErrorLog
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ConvertErrorLog()
Create errors.html template file output
- convertFunction
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertFunction()
Converts function for template output
- convertGlobal
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertGlobal()
Converts global variables for template output
- convertInclude
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertInclude()
Converts include elements for template output
- convertMethod
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertMethod()
Converts class methods for template output
- convertPackagepage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertPackagepage()
Converts package page and sets its package as used in $package_pages
- convertPage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertPage()
converts procedural pages for template output
- ConvertTodoList
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ConvertTodoList()
- convertTutorial
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertTutorial()
- convertVar
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::convertVar()
Converts class variables for template output
- Convert_RIC
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
- copyMediaRecursively
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::copyMediaRecursively()
- $classpackage_pagenums
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$classpackage_pagenums
- $converter
- in file class.phpdocpdf.php, variable phpdocpdf::$converter
- $curclasspackage
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$curclasspackage
- $curpagepackage
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$curpagepackage
- convertClass
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertClass()
- convertConst
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertConst()
- convertDefine
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertDefine()
- convertDocBlock
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertDocBlock()
- convertFunction
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertFunction()
- convertGlobal
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertGlobal()
- convertInclude
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertInclude()
- convertMethod
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertMethod()
- convertPackagepage
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertPackagepage()
- convertPage
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertPage()
- convertParams
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertParams()
- convertTutorial
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertTutorial()
- convertVar
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::convertVar()
- Convert_RIC
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
- class.phpdocpdf.php
- procedural page class.phpdocpdf.php
- $category
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$category
peardoc2 Category
- $category
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$category
peardoc2 Category
- $class
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class
name of current class being converted
- $class
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class
name of current class being converted
- $class_data
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class_data
template for the class currently being processed
- $class_data
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class_data
template for the class currently being processed
- $class_dir
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$class_dir
output directory for the current class being processed
- $class_dir
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$class_dir
output directory for the current class being processed
- $current
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$current
contains all of the template procedural page element loop data needed for the current template
- $current
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$current
contains all of the template procedural page element loop data needed for the current template
- $currentclass
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$currentclass
contains all of the template class element loop data needed for the current template
- $currentclass
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$currentclass
contains all of the template class element loop data needed for the current template
- convertClass
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertClass()
Converts class for template output
- convertClass
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertClass()
Converts class for template output
- convertDefine
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertDefine()
Converts defines for template output
- convertDefine
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertDefine()
Converts defines for template output
- ConvertErrorLog
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::ConvertErrorLog()
Create errors.html template file output
- ConvertErrorLog
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::ConvertErrorLog()
Create errors.html template file output
- convertFunction
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertFunction()
Converts function for template output - does nothing in peardoc2!
- convertFunction
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertFunction()
Converts function for template output
- convertGlobal
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertGlobal()
Converts global variables for template output
- convertGlobal
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertGlobal()
Converts global variables for template output
- convertInclude
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertInclude()
Converts include elements for template output
- convertInclude
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertInclude()
Converts include elements for template output
- convertMethod
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertMethod()
Converts method for template output
- convertMethod
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertMethod()
Converts method for template output
- convertPackagePage
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertPackagePage()
Does nothing - use tutorials for DocBook
- convertPackagePage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertPackagePage()
Converts package page and sets its package as used in $package_pages
- convertPage
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertPage()
converts procedural pages for template output
- convertPage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertPage()
converts procedural pages for template output
- convertTutorial
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertTutorial()
- convertTutorial
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertTutorial()
Convert tutorials for output
- convertVar
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::convertVar()
Does nothing in this converter
- convertVar
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::convertVar()
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.
- exampleProgramExample
- in file Converter.inc, method Converter::exampleProgramExample()
Used to convert the {@example} inline tag in a docblock.
- endClass
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
- endClass
- in file HTMLframesConverter.inc, method HTMLframesConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file HTMLframesConverter.inc, method HTMLframesConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
- endClass
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
- ezNewPage
- in file class.phpdocpdf.php, method phpdocpdf::ezNewPage()
- ezOutput
- in file class.phpdocpdf.php, method phpdocpdf::ezOutput()
- ezProcessText
- in file class.phpdocpdf.php, method phpdocpdf::ezProcessText()
- ezText
- in file class.phpdocpdf.php, method phpdocpdf::ezText()
- endClass
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
- endClass
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
- endPage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
- exampleProgramExample
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::exampleProgramExample()
Used to convert the {@example} inline tag in a docblock.
top
f
- $function_elements
- in file Converter.inc, variable Converter::$function_elements
alphabetized index of functions by package
- flushHighlightCache
- in file Converter.inc, method Converter::flushHighlightCache()
Return the close text for the current token
- 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()
CHMdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatPkgIndex()
CHMdefaultConverter chooses to format both package indexes and the complete index here
- formatTutorialTOC
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::formatTutorialTOC()
Use the template tutorial_toc.tpl to generate a table of contents for HTML
- formatIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here
- formatTutorialTOC
- in file HTMLframesConverter.inc, method HTMLframesConverter::formatTutorialTOC()
Use the template tutorial_toc.tpl to generate a table of contents for HTML
- formatIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here
- formatTutorialTOC
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::formatTutorialTOC()
Use the template tutorial_toc.tpl to generate a table of contents for HTML
- $font_dir
- in file class.phpdocpdf.php, variable phpdocpdf::$font_dir
- $function_data
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$function_data
- $function_data
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$function_data
- flushPackageXml
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::flushPackageXml()
- formatIndex
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::formatIndex()
Does nothing
- formatIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html
- formatLeftIndex
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::formatLeftIndex()
Creates package/lang/categoryname/packagename.xml for each package
- formatLeftIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
- formatPkgIndex
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::formatPkgIndex()
Does nothing
- formatPkgIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::formatPkgIndex()
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
- generateChildClassList
- in file Converter.inc, method Converter::generateChildClassList()
returns a list of child classes
- generateFormattedClassTree
- in file Converter.inc, method Converter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class.
- getClassesOnPage
- in file Converter.inc, method Converter::getClassesOnPage()
gets a list of all classes declared on a procedural page represented by
- getClassLink
- in file Converter.inc, method Converter::getClassLink()
return false or a classLink to $expr
- getConstLink
- in file Converter.inc, method Converter::getConstLink()
return false or a constLink to $expr in $class
- getConverterDir
- in file Converter.inc, method Converter::getConverterDir()
Get the absolute path to the converter's base directory
- getCurrentPageLink
- in file Converter.inc, method Converter::getCurrentPageLink()
- getCurrentPageURL
- in file Converter.inc, method Converter::getCurrentPageURL()
Return the path to the current
- getDefineLink
- in file Converter.inc, method Converter::getDefineLink()
return false or a defineLink to $expr
- getFileSourceName
- in file Converter.inc, method Converter::getFileSourceName()
Translate the path info into a unique file name for the highlighted source code.
- getFileSourcePath
- in file Converter.inc, method Converter::getFileSourcePath()
Return the fixed path to the source-code file folder.
- getFormattedConflicts
- in file Converter.inc, method Converter::getFormattedConflicts()
- getFormattedDescMethods
- in file Converter.inc, method Converter::getFormattedDescMethods()
Get a list of methods in child classes that override this method
- getFormattedDescVars
- in file Converter.inc, method Converter::getFormattedDescVars()
Get a list of vars in child classes that override this var
- getFormattedImplements
- in file Converter.inc, method Converter::getFormattedImplements()
returns an array containing the class inheritance tree from the root object to the class.
- getFormattedInheritedConsts
- in file Converter.inc, method Converter::getFormattedInheritedConsts()
Return template-enabled list of inherited class constants
- getFormattedInheritedMethods
- in file Converter.inc, method Converter::getFormattedInheritedMethods()
Return template-enabled list of inherited methods
- getFormattedInheritedVars
- in file Converter.inc, method Converter::getFormattedInheritedVars()
Return template-enabled list of inherited variables
- getFormattedMethodImplements
- in file Converter.inc, method Converter::getFormattedMethodImplements()
Get the method this method(s) implemented from an interface, if any
- getFormattedOverrides
- in file Converter.inc, method Converter::getFormattedOverrides()
Get the method this method overrides, if any
- 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.
- getHighlightState
- in file Converter.inc, method Converter::getHighlightState()
- getId
- in file Converter.inc, method Converter::getId()
take abstractLink descendant and text $eltext and return a
- 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
- 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
- getTutorialId
- in file Converter.inc, method Converter::getTutorialId()
Return a converter-specific id to distinguish tutorials and their sections
- 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()
Get a tree structure representing the hierarchy of tutorials
- getVarLink
- in file Converter.inc, method Converter::getVarLink()
return false or a varLink to $expr in $class
- generateElementIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateElementIndex()
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
- generateFormattedInterfaceTrees
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
- generateKLinks
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateKLinks()
Get the table of contents for index.hhk
- generatePkgElementIndex
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generatePkgElementIndexes()
- generateTOC
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::generateTOC()
- getCData
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getCData()
- getClassLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getClassLink()
- getConstLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getConstLink()
- getCurrentPageLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getCurrentPageLink()
- getDefineLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getDefineLink()
- getExampleLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getExampleLink()
- getFunctionLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getFunctionLink()
- getGlobalLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getGlobalLink()
- getId
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getId()
- getIndexInformation
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getIndexInformation()
Generate indexing information for given element
- getMethodLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getMethodLink()
- getPageLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getPageLink()
- getPageName
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getPageName()
- getRootTree
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getRootTree()
return formatted class tree for the Class Trees page
- getSourceAnchor
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
- getSourceLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getSourceLink()
- getTutorialId
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getTutorialId()
- getVarLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::getVarLink()
- generateElementIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::generateElementIndex()
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file HTMLframesConverter.inc, method HTMLframesConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file HTMLframesConverter.inc, method HTMLframesConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
- generateFormattedInterfaceTrees
- in file HTMLframesConverter.inc, method HTMLframesConverter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
- generatePkgElementIndex
- in file HTMLframesConverter.inc, method HTMLframesConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file HTMLframesConverter.inc, method HTMLframesConverter::generatePkgElementIndexes()
- getCData
- in file HTMLframesConverter.inc, method HTMLframesConverter::getCData()
- getClassLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getClassLink()
- getConstLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getConstLink()
- getCurrentPageLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getCurrentPageLink()
- getDefineLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getDefineLink()
- getExampleLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getExampleLink()
- getFunctionLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getFunctionLink()
- getGlobalLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getGlobalLink()
- getId
- in file HTMLframesConverter.inc, method HTMLframesConverter::getId()
- getIndexInformation
- in file HTMLframesConverter.inc, method HTMLframesConverter::getIndexInformation()
Generate indexing information for given element
- getMethodLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getMethodLink()
- getPageLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getPageLink()
- getPageName
- in file HTMLframesConverter.inc, method HTMLframesConverter::getPageName()
- getRootTree
- in file HTMLframesConverter.inc, method HTMLframesConverter::getRootTree()
return formatted class tree for the Class Trees page
- getSourceAnchor
- in file HTMLframesConverter.inc, method HTMLframesConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
- getSourceLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getSourceLink()
- getTutorialId
- in file HTMLframesConverter.inc, method HTMLframesConverter::getTutorialId()
- getTutorialTree
- in file HTMLframesConverter.inc, method HTMLframesConverter::getTutorialTree()
- getVarLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::getVarLink()
- generateElementIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateElementIndex()
Generate alphabetical index of all elements
- generateFormattedClassTree
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
- generateFormattedInterfaceTrees
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
- generatePkgElementIndex
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::generatePkgElementIndexes()
- getCData
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getCData()
- getClassContents
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassContents()
- getClassLeft
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassLeft()
- getClassLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getClassLink()
- getConstLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getConstLink()
- getCurrentPageLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getCurrentPageLink()
- getDefineLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getDefineLink()
- getExampleLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getExampleLink()
- getFunctionLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getFunctionLink()
- getGlobalLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getGlobalLink()
- getId
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getId()
- getIndexInformation
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getIndexInformation()
Generate indexing information for given element
- getMethodLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getMethodLink()
- getPageContents
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageContents()
- getPageLeft
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageLeft()
- getPageLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageLink()
- getPageName
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getPageName()
- getRootTree
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getRootTree()
return formatted class tree for the Class Trees page
- getSourceAnchor
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
- getSourceLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getSourceLink()
- getTutorialId
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getTutorialId()
- getTutorialList
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getTutorialList()
- getTutorialTree
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getTutorialTree()
- getVarLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::getVarLink()
- generateFormattedClassTrees
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
- getCData
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getCData()
- getClassLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getClassLink()
- getColor
- in file class.phpdocpdf.php, method phpdocpdf::getColor()
This really should be in the parent class
- getConstLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getConstLink()
- getDefineLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getDefineLink()
- getExampleLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getExampleLink()
- getFileSourceName
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getFileSourceName()
- getFunctionLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getFunctionLink()
- getGlobalLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getGlobalLink()
- getGlobalValue
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getGlobalValue()
- getMethodLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getMethodLink()
- getPageLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getPageLink()
- getPageName
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getPageName()
- getParserEventName
- in file ParserPDF.inc, method PDFParser::getParserEventName()
Return the name of the parser event
- getRootTree
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getRootTree()
return formatted class tree for the Class Trees page
- getSourceAnchor
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
- getSourceLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getSourceLink()
- getState
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getState()
- getTutorialId
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getTutorialId()
- getVarLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::getVarLink()
- getYPlusOffset
- in file class.phpdocpdf.php, method phpdocpdf::getYPlusOffset()
- generateChildClassList
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateChildClassList()
returns a list of child classes
- generateElementIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateElementIndex()
Generate alphabetical index of all elements
- generateElementIndex
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateElementIndex()
does nothing
- generateFormattedClassTree
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTree
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
- generateFormattedClassTrees
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generateFormattedClassTrees()
returns a template-enabled array of class trees
- generateFormattedClassTrees
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateFormattedClassTrees()
returns a template-enabled array of class trees
- generateFormattedInterfaceTrees
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generateFormattedInterfaceTrees()
returns a template-enabled array of interface inheritance trees
- generatePkgElementIndex
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndex
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generatePkgElementIndex()
Generate alphabetical index of all elements by package and subpackage
- generatePkgElementIndexes
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::generatePkgElementIndexes()
- generatePkgElementIndexes
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::generatePkgElementIndexes()
- getCData
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getCData()
- getCData
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getCData()
- getClassLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getClassLink()
- getClassLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getClassLink()
- getDefineLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getDefineLink()
- getDefineLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getDefineLink()
- getExampleLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getExampleLink()
- getFunctionLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getFunctionLink()
- getFunctionLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getFunctionLink()
- getGlobalLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getGlobalLink()
- getGlobalLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getGlobalLink()
- getId
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getId()
Get the id value needed to allow linking
- getId
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getId()
Get the id value needed to allow linking
- getLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getLink()
do that stuff in $template_options
- getLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getLink()
do that stuff in $template_options
- getMethodLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getMethodLink()
- getMethodLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getMethodLink()
- getPageLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getPageLink()
- getPageLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getPageLink()
- getPageName
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getPageName()
- getPageName
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getPageName()
- getRootTree
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getRootTree()
return formatted class tree for the Class Trees page
- getRootTree
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getRootTree()
return formatted class tree for the Class Trees page
- getSourceAnchor
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getSourceAnchor()
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
- getTutorialId
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getTutorialId()
- getTutorialId
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getTutorialId()
- getVarLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::getVarLink()
- getVarLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::getVarLink()
top
h
- $highlightingSource
- in file Converter.inc, variable Converter::$highlightingSource
Flag used to help converters determine whether to do special source highlighting
- hasSourceCode
- in file Converter.inc, method Converter::hasSourceCode()
Determine whether an element's file has generated source code, used for linking to line numbers of source.
- hasTutorial
- in file Converter.inc, method Converter::hasTutorial()
- highlightDocBlockSource
- in file Converter.inc, method Converter::highlightDocBlockSource()
Used to allow converters to format the source code of DocBlocks the way they'd like.
- highlightSource
- in file Converter.inc, method Converter::highlightSource()
Used to allow converters to format the source code the way they'd like.
- highlightTutorialSource
- in file Converter.inc, method Converter::highlightTutorialSource()
Used to allow converters to format the source code of Tutorial XML the way they'd like.
- HTMLframesConverter
- in file HTMLframesConverter.inc, method HTMLframesConverter::HTMLframesConverter()
sets $base_dir to $targetDir
- HTMLframesConverter
- in file HTMLframesConverter.inc, class HTMLframesConverter
HTML output converter.
- HTMLframesConverter.inc
- procedural page HTMLframesConverter.inc
- HTMLSmartyConverter.inc
- procedural page HTMLSmartyConverter.inc
- HTMLSmartyConverter
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::HTMLSmartyConverter()
- HTMLSmartyConverter
- in file HTMLSmartyConverter.inc, class HTMLSmartyConverter
HTML output converter.
top
top
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
indexes of elements by package that need to be generated
- $leftindex
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$leftindex
indexes of elements by package that need to be generated
- $leftindex
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$leftindex
indexes of elements by package that need to be generated
- $leftindex
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$leftindex
- $listType
- in file class.phpdocpdf.php, variable phpdocpdf::$listType
- $leftindex
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$leftindex
indexes of elements by package that need to be generated
- $leftindex
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$leftindex
indexes of elements by package that need to be generated
- $local
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$local
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
- $local
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$local
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
top
top
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
- Output
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::Output()
Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file
- $outputformat
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$outputformat
- Output
- in file HTMLframesConverter.inc, method HTMLframesConverter::Output()
This function is not used by HTMLdefaultConverter, but is required by Converter
- $outputformat
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$outputformat
- Output
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::Output()
This function is not used by HTMLdefaultConverter, but is required by Converter
- $outputformat
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$outputformat
- orderedBullet
- in file class.phpdocpdf.php, method phpdocpdf::orderedBullet()
- Output
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::Output()
calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir
- $outputformat
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$outputformat
- $outputformat
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$outputformat
- Output
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::Output()
Generate the constants.xml, packagename.xml, and globals.xml files
- Output
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::Output()
This function is not used by HTMLdefaultConverter, but is required by Converter
top
p
- $package
- in file Converter.inc, variable Converter::$package
package name currently being converted
- $packagecategories
- in file Converter.inc, variable Converter::$packagecategories
Packages associated with categories
- $package_elements
- in file Converter.inc, variable Converter::$package_elements
alphabetical index of all elements sorted by package, subpackage, page, and class.
- $package_output
- in file Converter.inc, variable Converter::$package_output
set to value of -po commandline
- $package_parents
- in file Converter.inc, variable Converter::$package_parents
Hierarchy of packages
- $page
- in file Converter.inc, variable Converter::$page
name of current page being converted
- $page_contents
- in file Converter.inc, variable Converter::$page_contents
alphabetical index of all elements on a page by package/subpackage
- $page_data
- in file Converter.inc, variable Converter::$page_data
template for the procedural page currently being processed
- $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
- $path
- in file Converter.inc, variable Converter::$path
path of current page being converted
- $pkg_elements
- in file Converter.inc, variable Converter::$pkg_elements
alphabetical index of all elements, indexed by package/subpackage
- $processSpecialRoots
- in file Converter.inc, variable Converter::$processSpecialRoots
This converter knows about the new root tree processing
- postProcess
- in file Converter.inc, method Converter::postProcess()
This version does nothing
- prepareDocBlock
- in file Converter.inc, method Converter::prepareDocBlock()
convert the element's DocBlock for output
- 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
array of converted package page names.
- $page_dir
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$page_dir
output directory for the current procedural page being processed
- postProcess
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::postProcess()
Uses htmlspecialchars() on the input
- ProgramExample
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::ProgramExample()
Used to convert the <code> tag in a docblock
- $package_pages
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$package_pages
array of converted package page names.
- $page_dir
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$page_dir
output directory for the current procedural page being processed
- $processSpecialRoots
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$processSpecialRoots
This converter knows about the new root tree processing
- postProcess
- in file HTMLframesConverter.inc, method HTMLframesConverter::postProcess()
Uses htmlspecialchars() on the input
- ProgramExample
- in file HTMLframesConverter.inc, method HTMLframesConverter::ProgramExample()
Used to convert the <code> tag in a docblock
- $package_pages
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$package_pages
array of converted package page names.
- $page_dir
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$page_dir
output directory for the current procedural page being processed
- $processSpecialRoots
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$processSpecialRoots
This converter knows about the new root tree processing
- postProcess
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::postProcess()
Uses htmlspecialchars() on the input
- ProgramExample
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::ProgramExample()
Used to convert the <code> tag in a docblock
- $pagepackage_pagenums
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$pagepackage_pagenums
- $pdf
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$pdf
- parse
- in file ParserPDF.inc, method PDFParser::parse()
Parse text for PDFParser XML tags, and add the text to the PDF file
- PDFdefaultConverter
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::PDFdefaultConverter()
- PDFdefaultConverter
- in file PDFdefaultConverter.inc, class PDFdefaultConverter
PDF output converter.
- PDFParser
- in file ParserPDF.inc, class PDFParser
- PDFParser
- in file ParserPDF.inc, method PDFParser::PDFParser()
Sets up the wordparser for this class
- phpdocpdf
- in file class.phpdocpdf.php, class phpdocpdf
- phpdocpdf
- in file class.phpdocpdf.php, method phpdocpdf::phpdocpdf()
- ParserPDF.inc
- procedural page ParserPDF.inc
- PDFdefaultConverter.inc
- procedural page PDFdefaultConverter.inc
- PHPDOCUMENTOR_PDF_EVENT_CONTENT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_CONTENT
used for parsing stuff between <text>
- PHPDOCUMENTOR_PDF_EVENT_FONT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_FONT
when <font> is found in an ezText input
- PHPDOCUMENTOR_PDF_EVENT_NEWPAGE
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_NEWPAGE
when <newpage/> is found in an ezText input
- PHPDOCUMENTOR_PDF_EVENT_PDFFUNCTION
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_PDFFUNCTION
when <pdffunction> is found in an ezText input
- PHPDOCUMENTOR_PDF_EVENT_TEXT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_EVENT_TEXT
when <text> is found in an ezText input
- PHPDOCUMENTOR_PDF_STATE_CONTENT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_CONTENT
used for parsing stuff between <text>
- PHPDOCUMENTOR_PDF_STATE_FONT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_FONT
when <font> is found in an ezText input
- PHPDOCUMENTOR_PDF_STATE_NEWPAGE
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_NEWPAGE
when <newpage/> is found in an ezText input
- PHPDOCUMENTOR_PDF_STATE_PDFFUNCTION
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_PDFFUNCTION
when <pdffunction> is found in an ezText input
- PHPDOCUMENTOR_PDF_STATE_TEXT
- in file ParserPDF.inc, constant PHPDOCUMENTOR_PDF_STATE_TEXT
when <text> is found in an ezText input
- postProcess
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::postProcess()
- $packagexml
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$packagexml
Contents of the packagename.xml file are stored in this template variable
- $package_pages
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$package_pages
array of converted package page names.
- $package_pages
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$package_pages
array of converted package page names.
- $page
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page
name of current page being converted
- $page
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$page
name of current page being converted
- $page_data
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page_data
template for the procedural page currently being processed
- $page_data
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$page_data
template for the procedural page currently being processed
- $page_dir
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$page_dir
output directory for the current procedural page being processed
- $page_dir
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$page_dir
output directory for the current procedural page being processed
- $path
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$path
path of current page being converted
- $path
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$path
path of current page being converted
- $processSpecialRoots
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$processSpecialRoots
This converter knows about the new root tree processing
- postProcess
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::postProcess()
- postProcess
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::postProcess()
- prepareDocBlock
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::prepareDocBlock()
- prepareDocBlock
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::prepareDocBlock()
- ProgramExample
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::ProgramExample()
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
- $ric_set
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$ric_set
- rcNatCmp
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
- returnLink
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::returnLink()
- returnSee
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
- $ric_set
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$ric_set
- rcNatCmp
- in file HTMLframesConverter.inc, method HTMLframesConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file HTMLframesConverter.inc, method HTMLframesConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
- returnLink
- in file HTMLframesConverter.inc, method HTMLframesConverter::returnLink()
- returnSee
- in file HTMLframesConverter.inc, method HTMLframesConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
- $ric_set
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$ric_set
- rcNatCmp
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
- returnLink
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::returnLink()
- returnSee
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
- $reportContents
- in file class.phpdocpdf.php, variable phpdocpdf::$reportContents
- $ric_set
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$ric_set
- returnLink
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::returnLink()
- returnSee
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::returnSee()
Returns a bookmark using Cezpdf 009
- rf
- in file class.phpdocpdf.php, method phpdocpdf::rf()
- rcNatCmp
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::rcNatCmp()
does a nat case sort on the specified second level value of the array
- rcNatCmp
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::rcNatCmp()
does a nat case sort on the specified second level value of the array
- rcNatCmp1
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
- rcNatCmp1
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::rcNatCmp1()
does a nat case sort on the specified second level value of the array.
- returnLink
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::returnLink()
- returnLink
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::returnLink()
- returnSee
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::returnSee()
This function takes an abstractLink descendant and returns an html link
- returnSee
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::returnSee()
This function takes an abstractLink descendant and returns an html link
top
s
- $smarty_dir
- in file Converter.inc, variable Converter::$smarty_dir
Directory that the smarty templates are in
- $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
- $sourcePaths
- in file Converter.inc, variable Converter::$sourcePaths
A list of files that have had source code generated
- $subpackage
- in file Converter.inc, variable Converter::$subpackage
subpackage name currently being converted
- Sampize
- in file Converter.inc, method Converter::Sampize()
Used to convert the contents of <samp> in a docblock
- setSourcePaths
- in file Converter.inc, method Converter::setSourcePaths()
Mark a file as having had source code highlighted
- setTargetDir
- in file Converter.inc, method Converter::setTargetDir()
Sets the output directory for generated documentation
- setTemplateBase
- in file Converter.inc, method Converter::setTemplateBase()
Set the template directory with a different template base directory
- setTemplateDir
- in file Converter.inc, method Converter::setTemplateDir()
sets the template directory based on the $outputformat and $name
- 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()
Return a line of highlighted source code with formatted line number
- startHighlight
- in file Converter.inc, method Converter::startHighlight()
Initialize highlight caching
- $sort_page_contents_by_type
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$sort_page_contents_by_type
CHMdefaultConverter wants elements sorted by type as well as alphabetically
- setTargetDir
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- setTemplateDir
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::setTemplateDir()
- SmartyInit
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::SmartyInit()
- sourceLine
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::sourceLine()
Return a line of highlighted source code with formatted line number
- $sort_page_contents_by_type
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$sort_page_contents_by_type
Smarty Converter wants elements sorted by type as well as alphabetically
- setTargetDir
- in file HTMLframesConverter.inc, method HTMLframesConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- SmartyInit
- in file HTMLframesConverter.inc, method HTMLframesConverter::SmartyInit()
- sourceLine
- in file HTMLframesConverter.inc, method HTMLframesConverter::sourceLine()
Return a line of highlighted source code with formatted line number
- $sort_page_contents_by_type
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$sort_page_contents_by_type
Smarty Converter wants elements sorted by type as well as alphabetically
- setTargetDir
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- SmartyInit
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::SmartyInit()
- sourceLine
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::sourceLine()
Return a line of highlighted source code with formatted line number
- $set_pageNumbering
- in file class.phpdocpdf.php, variable phpdocpdf::$set_pageNumbering
- $smarty_dir
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$smarty_dir
- $sort_absolutely_everything
- in file PDFdefaultConverter.inc, variable PDFdefaultConverter::$sort_absolutely_everything
default PDF Converter wants elements sorted by type as well as alphabetically
- setColorArray
- in file class.phpdocpdf.php, method phpdocpdf::setColorArray()
- setHTMLColor
- in file class.phpdocpdf.php, method phpdocpdf::setHTMLColor()
- setTemplateDir
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::setTemplateDir()
- setupStates
- in file ParserPDF.inc, method PDFParser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
- setupTOC
- in file class.phpdocpdf.php, method phpdocpdf::setupTOC()
- $sort_absolutely_everything
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$sort_absolutely_everything
Pass elements by package, simplifies generation of package.xml/category.xml
- $sort_page_contents_by_type
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$sort_page_contents_by_type
XMLDocBookConverter wants elements sorted by type as well as alphabetically
- $sort_page_contents_by_type
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$sort_page_contents_by_type
XMLDocBookConverter wants elements sorted by type as well as alphabetically
- $sourceloc
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$sourceloc
- $sourceloc
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$sourceloc
- setTargetDir
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::setTargetDir()
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
- setTemplateDir
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::setTemplateDir()
- setTemplateDir
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::setTemplateDir()
- SmartyInit
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::SmartyInit()
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, from last part of -o
- $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
- $todoList
- in file Converter.inc, variable Converter::$todoList
List of all @todo tags and a link to the element with the @todo
- TranslateEntity
- in file Converter.inc, method Converter::TranslateEntity()
Used to translate an XML DocBook entity like ” from a tutorial by reading the options.ini file for the template.
- TranslateTag
- in file Converter.inc, method Converter::TranslateTag()
Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
- TutorialExample
- in file Converter.inc, method Converter::TutorialExample()
- type_adjust
- in file Converter.inc, method Converter::type_adjust()
Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting
- TutorialExample
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::TutorialExample()
- TutorialExample
- in file HTMLframesConverter.inc, method HTMLframesConverter::TutorialExample()
- TutorialExample
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::TutorialExample()
- textcolor
- in file class.phpdocpdf.php, method phpdocpdf::textcolor()
- TranslateTag
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::TranslateTag()
Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
- $template_options
- in file XMLDocBookpeardoc2Converter.inc, variable XMLDocBookpeardoc2Converter::$template_options
template options. Currently only 1 recognized option usepear
- $template_options
- in file XMLDocBookConverter.inc, variable XMLDocBookConverter::$template_options
template options. Currently only 1 recognized option usepear
- type_adjust
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::type_adjust()
- type_adjust
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::type_adjust()
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
- $wrote
- in file CHMdefaultConverter.inc, variable CHMdefaultConverter::$wrote
- writeExample
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::writeExample()
- writefile
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::writefile()
Write a file to disk, and add it to the $hhp_files list of files to include in the generated CHM
- writeNewPPage
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::writeNewPPage()
- writeSource
- in file CHMdefaultConverter.inc, method CHMdefaultConverter::writeSource()
- $wrote
- in file HTMLframesConverter.inc, variable HTMLframesConverter::$wrote
- writeExample
- in file HTMLframesConverter.inc, method HTMLframesConverter::writeExample()
- writeNewPPage
- in file HTMLframesConverter.inc, method HTMLframesConverter::writeNewPPage()
- writeSource
- in file HTMLframesConverter.inc, method HTMLframesConverter::writeSource()
- $wrote
- in file HTMLSmartyConverter.inc, variable HTMLSmartyConverter::$wrote
- writeExample
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeExample()
- writeNewPPage
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeNewPPage()
- writeRIC
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeRIC()
- writeSource
- in file HTMLSmartyConverter.inc, method HTMLSmartyConverter::writeSource()
- writeExample
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::writeExample()
- writeSource
- in file PDFdefaultConverter.inc, method PDFdefaultConverter::writeSource()
- wordwrap
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::wordwrap()
- writeExample
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::writeExample()
- writeFile
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::writeFile()
Writes a file to target dir, beautify any .xml files first
- writeNewPPage
- in file XMLDocBookConverter.inc, method XMLDocBookConverter::writeNewPPage()
- writeNewPPage
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::writeNewPPage()
Does nothing
- writeSource
- in file XMLDocBookpeardoc2Converter.inc, method XMLDocBookpeardoc2Converter::writeSource()
Does nothing
top
top
|
|
