|
XML DocBook formatter.
|
Base Classes
|
|
happydoclib.formatter.xmlformatterbase.XMLFormatter
|
|
Methods
|
|
|
|
|
|
__init__
|
__init__ (
self,
docset,
title='',
encoding='iso-8859-1',
index_file_name='index',
file_name_ext='xml',
**conf,
)
Initialize the XMLDocBookFormatter.
Parameters
-
docset
- the DocSet instance containing global cross-reference
information
-
title
- documentation title
-
encoding
- documentation file encoding (default
iso-8859-1)
-
index_file_name
- package index filename (default
index)
-
file_name_ext
- documentation filename extension (default
xml)
-
**conf
- additional, optional, configuration values
|
|
|
classIndex
|
classIndex (
self,
class_info,
output,
)
XMLFormatter class abstract method implementation.
|
|
|
moduleIndex
|
moduleIndex (
self,
module_info,
output,
)
XMLFormatter class abstract method implementation.
|
|
|
packageIndex
|
packageIndex (
self,
package_info,
output,
)
XMLFormatter class abstract method implementation.
|
|
|
processClass
|
processClass (
self,
info,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processClassBase
|
processClassBase (
self,
info,
cinfo,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processDocString
|
processDocString (
self,
info,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processException
|
processException (
self,
einfo,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processFunction
|
processFunction (
self,
info,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processImport
|
processImport (
self,
iinfo,
minfo,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processImportSymbol
|
processImportSymbol (
self,
info,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processModule
|
processModule (
self,
info,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processPackage
|
processPackage (
self,
info,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processParam
|
processParam (
self,
info,
output,
stage,
)
XMLFormatter class abstract method implementation.
|
|
|
processRoot
|
processRoot (
self,
output,
stage,
rtype,
)
XMLFormatter class abstract method implementation.
|
|