[Converters] element index

Package indexes

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