Class CHMdefaultConverter

Description

Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)

The free MS HTML Help compiler takes the project file (phpdoc.hhp) and reads the table of contents file specified in the project (which is always contents.hhc in phpDocumentor). When the converter reaches stable state, it will also output an index file index.hhk. The free download for MS HTML Help Workshop is available below

Located in /phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc (line 56)

Converter
   |
   --CHMdefaultConverter
Variable Summary
string $base_dir
string $class_dir
array $current
boolean $juststarted
array $KLinks
array $leftindex
string $name
string $outputformat
string $page_dir
mixed $ric_set
mixed $wrote
Method Summary
CHMdefaultConverter CHMdefaultConverter ( &$allp,  &$packp,  &$classes,  &$procpages,  $po,  $pp,  $qm,  $targetDir,  $templateDir,  $title)
void addHHP ( $file)
void addKLink (string $name, string $file, [string $bookmark = ''], [string $group = ''])
void addSourceTOC ( $name,  $file,  $package,  $subpackage, [ $source = false])
void addTOC ( $name,  $file,  $package,  $subpackage, [ $class = false], [ $tutorial = false])
void convertClass (parserClass &$element)
void convertConst (parserDefine &$element)
void convertDefine (parserDefine &$element)
void ConvertErrorLog ()
void convertFunction (parserFunction &$element)
void convertGlobal (parserGlobal &$element)
void convertInclude (parserInclude &$element)
void convertMethod (parserDefine &$element)
void convertPage (parserData &$element)
void ConvertTodoList ()
void convertTutorial (parserTutorial &$element)
void convertVar (parserDefine &$element)
void Convert_RIC (README|INSTALL|CHANGELOG $name, string $contents)
void copyMediaRecursively ( $media,  $targetdir, [ $subdir = ''])
void endClass ()
void endPage ()
void formatIndex ()
void formatLeftIndex ()
void formatPkgIndex ()
string formatTutorialTOC (array $toc)
void generateFormattedClassTrees (string $package)
void generateFormattedInterfaceTrees (string $package)
string generateKLinks ()
void generatePkgElementIndex (string $package)
void generateTOC ()
void getCData ( $value)
mixed getClassLink (string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $with_a = true])
mixed getConstLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
mixed getDefineLink (string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
void getExampleLink ( $path,  $title)
mixed getFunctionLink (string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
mixed getGlobalLink (string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
void getId ( $element, [ $fullpath = true])
mixed getMethodLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
mixed getPageLink (string $expr, string $package, [string $path = false], [boolean $text = false], boolean 4)
void getPageName ( &$element)
string getRootTree (array $tree, string $package, [ $noparent = false], boolean $nounknownparent)
string getSourceAnchor (string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])
void getSourceLink ( $path)
void getTutorialId ( $package,  $subpackage,  $tutorial,  $id)
mixed getVarLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
void Output ()
void postProcess ( $text)
string ProgramExample (string $example, [boolean $tutorial = false], [ $inlinesourceparse = null], [ $class = null], [ $linenum = null], [ $filesourcepath = null])
int rcNatCmp (mixed $a, mixed $b)
int rcNatCmp1 (mixed $a, mixed $b)
string returnLink (string $link, string $text)
void returnSee (abstractLink &$element, [string $eltext = false], [boolean $with_a = true], boolean 3)
void setTargetDir ( $dir)
void setTemplateDir ( $dir)
void &SmartyInit ( &$templ)
string sourceLine (integer $linenumber, string $line, [false|string $path = false])
void TutorialExample (string $example)
void unmangle ( $sourcecode)
void writeExample ( $title,  $path,  $source)
void writefile ( $file,  $contents)
void writeNewPPage ( $key)
void writeSource (string $path, string $value)
Variables
string $base_dir (line 85)

target directory passed on the command-line.

$targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.

string $class_dir (line 91)

output directory for the current class being processed

array $current (line 116)

contains all of the template procedural page element loop data needed for the current template

array $currentclass (line 122)

contains all of the template class element loop data needed for the current template

boolean $juststarted = false (line 110)

controls formatting of parser informative output

Converter prints: "Converting /path/to/file.php... Procedural Page Elements... Classes..." Since CHMdefaultConverter outputs files while converting, it needs to send a \n to start a new line. However, if there is more than one class, output is messy, with multiple \n's just between class file output. This variable prevents that and is purely cosmetic

array $KLinks = array() (line 129)

Table of Contents entry for index.hhk

array $leftindex = array('classes' => true, 'pages' => true, 'functions' => true, 'defines' => false, 'globals' => false) (line 72)

indexes of elements by package that need to be generated


Redefinition of:
Converter::$leftindex
Controls which of the one-element-only indexes are generated.
string $name = 'default' (line 67)
string $outputformat = 'CHM' (line 65)

Redefinition of:
Converter::$outputformat
output format of this converter
array $package_pages = array() (line 98)

array of converted package page names.

Used to link to the package page in the left index

  • var: Format: array(package => 1)
string $page_dir (line 78)

output directory for the current procedural page being processed

mixed $ric_set = array() (line 124)
boolean $sort_page_contents_by_type = true (line 63)

CHMdefaultConverter wants elements sorted by type as well as alphabetically


Redefinition of:
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
mixed $wrote = false (line 123)

Inherited Variables

Inherited from Converter

Converter::$all_packages
Converter::$class
Converter::$classes
Converter::$class_contents
Converter::$class_data
Converter::$class_elements
Converter::$curfile
Converter::$curpage
Converter::$define_elements
Converter::$elements
Converter::$function_elements
Converter::$global_elements
Converter::$highlightingSource
Converter::$package
Converter::$packagecategories
Converter::$package_elements
Converter::$package_output
Converter::$package_parents
Converter::$page
Converter::$page_contents
Converter::$page_data
Converter::$page_elements
Converter::$parseprivate
Converter::$path
Converter::$pkg_elements
Converter::$processSpecialRoots
Converter::$quietmode
Converter::$smarty_dir
Converter::$sort_absolutely_everything
Converter::$sourcePaths
Converter::$subpackage
Converter::$targetDir
Converter::$templateDir
Converter::$templateName
Converter::$template_options
Converter::$title
Converter::$todoList
Methods
Constructor CHMdefaultConverter (line 135)

sets $base_dir to $targetDir

CHMdefaultConverter CHMdefaultConverter ( &$allp,  &$packp,  &$classes,  &$procpages,  $po,  $pp,  $qm,  $targetDir,  $templateDir,  $title)
  • &$allp
  • &$packp
  • &$classes
  • &$procpages
  • $po
  • $pp
  • $qm
  • $targetDir
  • $templateDir
  • $title
addHHP (line 1701)
  • uses: $hhp_files - creates the array by adding parameter $file
void addHHP ( $file)
  • $file
addKLink (line 1795)

Add an item to the index.hhk file

void addKLink (string $name, string $file, [string $bookmark = ''], [string $group = ''])
  • string $name: index entry name
  • string $file: filename containing index
  • string $bookmark: html anchor of location in file, if any
  • string $group: group this entry with a string
addSourceTOC (line 1762)
void addSourceTOC ( $name,  $file,  $package,  $subpackage, [ $source = false])
  • $name
  • $file
  • $package
  • $subpackage
  • $source
addTOC (line 1773)
void addTOC ( $name,  $file,  $package,  $subpackage, [ $class = false], [ $tutorial = false])
  • $name
  • $file
  • $package
  • $subpackage
  • $class
  • $tutorial
convertConst (line 860)

Converts class constants for template output

void convertConst (parserDefine &$element)

Redefinition of:
Converter::convertConst()
Converts class constants for template output.
convertDefine (line 909)

Converts defines for template output

void convertDefine (parserDefine &$element)

Redefinition of:
Converter::convertDefine()
Converts defines for template output
ConvertErrorLog (line 698)

Create errors.html template file output

This method takes all parsing errors and warnings and spits them out ordered by file and line number.

  • global: ErrorTracker $phpDocumentor_errors: We'll be using it's output facility
void ConvertErrorLog ()

Redefinition of:
Converter::ConvertErrorLog()
Convert the phpDocumentor parsing/conversion error log
convertFunction (line 884)

Converts function for template output

void convertFunction (parserFunction &$element)

Redefinition of:
Converter::convertFunction()
Converts function for template output
convertGlobal (line 920)

Converts global variables for template output

void convertGlobal (parserGlobal &$element)

Redefinition of:
Converter::convertGlobal()
Converts global variables for template output
convertInclude (line 897)

Converts include elements for template output

void convertInclude (parserInclude &$element)

Redefinition of:
Converter::convertInclude()
Converts includes for template output
convertMethod (line 872)

Converts class methods for template output

void convertMethod (parserDefine &$element)

Redefinition of:
Converter::convertMethod()
Converts method for template output
convertPackagepage (line 773)

Converts package page and sets its package as used in $package_pages

void convertPackagepage (parserPackagePage &$element)
convertPage (line 932)

converts procedural pages for template output

void convertPage (parserData &$element)

Redefinition of:
Converter::convertPage()
Default Page Handler
ConvertTodoList (line 644)
void ConvertTodoList ()

Redefinition of:
Converter::ConvertTodoList()
Convert the list of all @todo tags
convertTutorial (line 794)
void convertTutorial (parserTutorial &$element)

Redefinition of:
Converter::convertTutorial()
Default Tutorial Handler
convertVar (line 848)

Converts class variables for template output

void convertVar (parserDefine &$element)

Redefinition of:
Converter::convertVar()
Converts class variables for template output.
Convert_RIC (line 680)

Convert README/INSTALL/CHANGELOG file contents to output format

void Convert_RIC (README|INSTALL|CHANGELOG $name, string $contents)
  • README|INSTALL|CHANGELOG $name
  • string $contents: contents of the file

Redefinition of:
Converter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
copyMediaRecursively (line 1361)
void copyMediaRecursively ( $media,  $targetdir, [ $subdir = ''])
  • $media
  • $targetdir
  • $subdir
endClass (line 340)

Writes out the template file of $class_data and unsets the template to save memory

void endClass ()

Redefinition of:
Converter::endClass()
Called by walk() while converting, when the last class element has been parsed.
endPage (line 363)

Writes out the template file of $page_data and unsets the template to save memory

void endPage ()

Redefinition of:
Converter::endPage()
Called by walk() while converting, when the last procedural page element has been parsed.
formatIndex (line 427)

CHMdefaultConverter uses this function to format template index.html and packages.html

This function generates the package list from $all_packages, eliminating any packages that don't have any entries in their package index (no files at all, due to @ignore or other factors). Then it uses the default package name as the first package index to display. It sets the right pane to be either a blank file with instructions on making package-level docs, or the package-level docs for the default package.

  • global: string $phpDocumentor_DefaultPackageName: Used to set the starting package to display
void formatIndex ()

Redefinition of:
Converter::formatIndex()
Called by walk() while converting.
formatLeftIndex (line 523)

Generate indexes for li_package.html and classtree output files

This function generates the li_package.html files from the template file left.html. It does this by iterating through each of the $page_elements, $class_elements and $function_elements arrays to retrieve the pre-sorted abstractLink descendants needed for index generation. Conversion of these links to text is done by returnSee(). The $local parameter is set to false to ensure that paths are correct.

Then it uses generateFormattedClassTrees() to create class trees from the template file classtrees.html. Output filename is classtrees_packagename.html. This function also unsets $elements and $pkg_elements to free up the considerable memory these two class vars use

void formatLeftIndex ()

Redefinition of:
Converter::formatLeftIndex()
Called by walk() while converting.
formatPkgIndex (line 395)

CHMdefaultConverter chooses to format both package indexes and the complete index here

This function formats output for the elementindex.html and pkgelementindex.html template files. It then writes them to the target directory

void formatPkgIndex ()

Redefinition of:
Converter::formatPkgIndex()
Called by walk() while converting.
formatTutorialTOC (line 311)

Use the template tutorial_toc.tpl to generate a table of contents for HTML

  • return: table of contents formatted for use in the current output format
string formatTutorialTOC (array $toc)
  • array $toc: format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)

Redefinition of:
Converter::formatTutorialTOC()
Creates a table of contents for a {@toc} inline tag in a tutorial
generateElementIndex (line 1322)

Generate alphabetical index of all elements

void generateElementIndex ()
generateFormattedClassTree (line 959)

returns an array containing the class inheritance tree from the root object to the class

array generateFormattedClassTree (parserClass $class)

Redefinition of:
Converter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class.
generateFormattedClassTrees (line 1023)

returns a template-enabled array of class trees

  • see: $roots, HTMLConverter::getRootTree()
void generateFormattedClassTrees (string $package)
  • string $package: package to generate a class tree for
generateFormattedInterfaceTrees (line 1077)

returns a template-enabled array of interface inheritance trees

  • see: $roots, HTMLConverter::getRootTree()
void generateFormattedInterfaceTrees (string $package)
  • string $package: package to generate a class tree for
generateKLinks (line 1816)

Get the table of contents for index.hhk

string generateKLinks ()
generatePkgElementIndex (line 1426)

Generate alphabetical index of all elements by package and subpackage

void generatePkgElementIndex (string $package)
  • string $package: name of a package
generatePkgElementIndexes (line 1477)
void generatePkgElementIndexes ()
generateTOC (line 1710)
void generateTOC ()
getCData (line 759)
void getCData ( $value)
  • $value
getClassLink (line 1517)
mixed getClassLink (string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $with_a = true])
  • string $expr: name of class
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated
  • boolean $with_a: return just the URL, or enclose it in an html a tag

Redefinition of:
Converter::getClassLink()
return false or a classLink to $expr
getConstLink (line 1632)
mixed getConstLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
  • boolean 5: return just the URL, or enclose it in an html a tag
  • string $expr: name of class constant
  • string $class: class containing class constant
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Redefinition of:
Converter::getConstLink()
return false or a constLink to $expr in $class
getCurrentPageLink (line 289)
void getCurrentPageLink ()

Redefinition of:
Converter::getCurrentPageLink()
getDefineLink (line 1549)
mixed getDefineLink (string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
  • boolean 4: return just the URL, or enclose it in an html a tag
  • string $expr: name of define
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Redefinition of:
Converter::getDefineLink()
return false or a defineLink to $expr
getExampleLink (line 199)
void getExampleLink ( $path,  $title)
  • $path
  • $title
getFunctionLink (line 1533)
mixed getFunctionLink (string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
  • boolean 4: return just the URL, or enclose it in an html a tag
  • string $expr: name of function
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Redefinition of:
Converter::getFunctionLink()
return false or a functionLink to $expr
getGlobalLink (line 1565)
mixed getGlobalLink (string $expr, string $package, [string $file = false], [boolean $text = false], boolean 4)
  • boolean 4: return just the URL, or enclose it in an html a tag
  • string $expr: name of global variable
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Redefinition of:
Converter::getGlobalLink()
return false or a globalLink to $expr
getId (line 591)
void getId ( $element, [ $fullpath = true])
  • $element
  • $fullpath

Redefinition of:
Converter::getId()
take abstractLink descendant and text $eltext and return a
getIndexInformation (line 1205)

Generate indexing information for given element

array getIndexInformation (parserElement $elt)
getMethodLink (line 1598)
mixed getMethodLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
  • boolean 5: return just the URL, or enclose it in an html a tag
  • string $expr: name of method
  • string $class: class containing method
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Redefinition of:
Converter::getMethodLink()
return false or a methodLink to $expr in $class
getPageLink (line 1581)
mixed getPageLink (string $expr, string $package, [string $path = false], [boolean $text = false], boolean 4)
  • boolean 4: return just the URL, or enclose it in an html a tag
  • string $expr: name of procedural page
  • string $package: package name
  • string $path: full path to look in (used in index generation)
  • boolean $text: deprecated

Redefinition of:
Converter::getPageLink()
return false or a pageLink to $expr
getPageName (line 945)
void getPageName ( &$element)
  • &$element
getRootTree (line 1134)

return formatted class tree for the Class Trees page

string getRootTree (array $tree, string $package, [ $noparent = false], boolean $nounknownparent)
  • array $tree: output from getSortedClassTreeFromClass()
  • string $package: package
  • boolean $nounknownparent: if true, an object's parent will not be checked
  • $noparent
getSourceAnchor (line 220)

Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.

  • return: link to an anchor, or the anchor
string getSourceAnchor (string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])
  • string $sourcefile: full path to source file
  • string $anchor: name of anchor
  • string $text: link text, if this is a link
  • boolean $link: returns either a link or a destination based on this parameter
getSourceLink (line 204)
void getSourceLink ( $path)
  • $path

Redefinition of:
Converter::getSourceLink()
getTutorialId (line 764)
void getTutorialId ( $package,  $subpackage,  $tutorial,  $id)
  • $package
  • $subpackage
  • $tutorial
  • $id

Redefinition of:
Converter::getTutorialId()
Return a converter-specific id to distinguish tutorials and their sections
getVarLink (line 1615)
mixed getVarLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
  • boolean 5: return just the URL, or enclose it in an html a tag
  • string $expr: name of var
  • string $class: class containing var
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Redefinition of:
Converter::getVarLink()
return false or a varLink to $expr in $class
Output (line 1860)

Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file

The output function generates the table of contents (contents.hhc) and file list (phpdoc.hhp) files used to create a .CHM by the free MS HTML Help compiler. {@, a list of all separate .html files is created in CHM format, and written to phpdoc.hhp. This list was generated by writefile.

Next, a call to the table of contents:

  1.         phpDocumentor_out("NOTE: to create the documentation.chm file, you must now run Microsoft Help Workshop on phpdoc.hhp\n");
  2.         phpDocumentor_out("To get the free Microsoft Help Workshop, browse to: http://go.microsoft.com/fwlink/?LinkId=14188\n");

finishes things off}}

void Output ()

Redefinition of:
Converter::Output()
do all necessary output
postProcess (line 297)

Uses htmlspecialchars() on the input

void postProcess ( $text)
  • $text

Redefinition of:
Converter::postProcess()
This version does nothing
ProgramExample (line 266)

Used to convert the <code> tag in a docblock

string ProgramExample (string $example, [boolean $tutorial = false], [ $inlinesourceparse = null], [ $class = null], [ $linenum = null], [ $filesourcepath = null])
  • string $example
  • boolean $tutorial
  • $inlinesourceparse
  • $class
  • $linenum
  • $filesourcepath

Redefinition of:
Converter::ProgramExample()
Used to convert the <code> tag in a docblock
rcNatCmp (line 1646)

does a nat case sort on the specified second level value of the array

int rcNatCmp (mixed $a, mixed $b)
  • mixed $a
  • mixed $b
rcNatCmp1 (line 1662)

does a nat case sort on the specified second level value of the array.

this one puts constructors first

int rcNatCmp1 (mixed $a, mixed $b)
  • mixed $a
  • mixed $b
returnLink (line 383)
  • return: &lt;a href="'.$link.'">'.$text.'</a&gt;
string returnLink (string $link, string $text)
  • string $link
  • string $text

Redefinition of:
Converter::returnLink()
take URL $link and text $text and return a link in the format needed for the Converter
returnSee (line 561)

This function takes an abstractLink descendant and returns an html link

void returnSee (abstractLink &$element, [string $eltext = false], [boolean $with_a = true], boolean 3)
  • boolean 3: determines whether the returned text is enclosed in an <a> tag
  • abstractLink &$element: a descendant of abstractlink should be passed, and never text
  • string $eltext: text to display in the link
  • boolean $with_a: this parameter is not used, and is deprecated

Redefinition of:
Converter::returnSee()
take abstractLink descendant and text $eltext and return a link
setTargetDir (line 1406)

calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

void setTargetDir ( $dir)
  • $dir

Redefinition of:
Converter::setTargetDir()
Sets the output directory for generated documentation
setTemplateDir (line 1355)
void setTemplateDir ( $dir)
  • $dir

Redefinition of:
Converter::setTemplateDir()
sets the template directory based on the $outputformat and $name
SmartyInit (line 318)
void &SmartyInit ( &$templ)
  • &$templ
sourceLine (line 242)

Return a line of highlighted source code with formatted line number

If the $path is a full path, then an anchor to the line number will be added as well

  • return: formatted source code line with line number
string sourceLine (integer $linenumber, string $line, [false|string $path = false])
  • integer $linenumber: line number
  • string $line: highlighted source code line
  • false|string $path: full path to @filesource file this line is a part of, if this is a single line from a complete file.

Redefinition of:
Converter::sourceLine()
Return a line of highlighted source code with formatted line number
TutorialExample (line 275)
void TutorialExample (string $example)
  • string $example

Redefinition of:
Converter::TutorialExample()
unmangle (line 144)
  • deprecated: in favor of PHP 4.3.0+ tokenizer-based source highlighting
void unmangle ( $sourcecode)
  • $sourcecode

Redefinition of:
Converter::unmangle()
Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.
writeExample (line 179)
void writeExample ( $title,  $path,  $source)
  • $title
  • $path
  • $source

Redefinition of:
Converter::writeExample()
Write out the formatted source code for an example php file
writefile (line 1692)

Write a file to disk, and add it to the $hhp_files list of files to include in the generated CHM

  1. function writefile($file,$contents)
  2.     {
  3.         $this->addHHP($this->targetDir PATH_DELIMITER $file);
  4.         Converter::writefile($file,$contents);
  5.     }

void writefile ( $file,  $contents)
  • $file
  • $contents
writeNewPPage (line 491)
void writeNewPPage ( $key)
  • $key
writeSource (line 160)
void writeSource (string $path, string $value)
  • string $path: full path to the source file
  • string $value: fully highlighted source code

Redefinition of:
Converter::writeSource()
Write out the formatted source code for a php file

Inherited Methods

Inherited From Converter

Converter::Converter()
Converter::AttrToString()
Converter::Bolden()
Converter::Br()
Converter::checkState()
Converter::cleanup()
Converter::Convert()
Converter::convertClass()
Converter::convertConst()
Converter::convertDefine()
Converter::ConvertErrorLog()
Converter::convertFunction()
Converter::convertGlobal()
Converter::convertInclude()
Converter::convertMethod()
Converter::convertPage()
Converter::ConvertTitle()
Converter::ConvertTodoList()
Converter::convertTutorial()
Converter::convertVar()
Converter::Convert_RIC()
Converter::copyFile()
Converter::createParentDir()
Converter::EncloseList()
Converter::EncloseParagraph()
Converter::endClass()
Converter::endPage()
Converter::exampleProgramExample()
Converter::flushHighlightCache()
Converter::formatIndex()
Converter::formatLeftIndex()
Converter::formatPkgIndex()
Converter::formatTutorialTOC()
Converter::generateChildClassList()
Converter::generateFormattedClassTree()
Converter::getClassesOnPage()
Converter::getClassLink()
Converter::getConstLink()
Converter::getConverterDir()
Converter::getCurrentPageLink()
Converter::getCurrentPageURL()
Converter::getDefineLink()
Converter::getFileSourceName()
Converter::getFileSourcePath()
Converter::getFormattedConflicts()
Converter::getFormattedDescMethods()
Converter::getFormattedDescVars()
Converter::getFormattedImplements()
Converter::getFormattedInheritedConsts()
Converter::getFormattedInheritedMethods()
Converter::getFormattedInheritedVars()
Converter::getFormattedMethodImplements()
Converter::getFormattedOverrides()
Converter::getFunctionLink()
Converter::getGlobalLink()
Converter::getGlobalValue()
Converter::getHighlightState()
Converter::getId()
Converter::getIncludeValue()
Converter::getLink()
Converter::getMethodLink()
Converter::getPageLink()
Converter::getSortedClassTreeFromClass()
Converter::getSourceLink()
Converter::getState()
Converter::getTutorialId()
Converter::getTutorialLink()
Converter::getTutorialTree()
Converter::getVarLink()
Converter::hasSourceCode()
Converter::hasTutorial()
Converter::highlightDocBlockSource()
Converter::highlightSource()
Converter::highlightTutorialSource()
Converter::Italicize()
Converter::Kbdize()
Converter::ListItem()
Converter::newSmarty()
Converter::Output()
Converter::postProcess()
Converter::prepareDocBlock()
Converter::PreserveWhiteSpace()
Converter::ProgramExample()
Converter::returnLink()
Converter::returnSee()
Converter::Sampize()
Converter::setSourcePaths()
Converter::setTargetDir()
Converter::setTemplateBase()
Converter::setTemplateDir()
Converter::sortPageContentsByElementType()
Converter::sourceLine()
Converter::startHighlight()
Converter::TranslateEntity()
Converter::TranslateTag()
Converter::TutorialExample()
Converter::type_adjust()
Converter::unmangle()
Converter::vardump_tree()
Converter::Varize()
Converter::walk()
Converter::walk_everything()
Converter::writeExample()
Converter::writeFile()
Converter::writeSource()
Converter::_rmdir()
Converter::_setHighlightCache()
Converter::_tutorial_path()

Documentation generated on Mon, 05 Dec 2011 21:41:31 -0600 by phpDocumentor 1.4.4