HappyDoc Generated Documentation Class: DocSet

HappyDoc3-r3_1 / happydoclib / docset / base.py / DocSet 

Docset Parameters

Pass parameters to the docset using the syntax:

docset_=value

Common parameters for all documentation sets
includeComments
Boolean. False means to skip the comment parsing step in the parser. Default is True.
includePrivateNames
Boolean. False means to ignore names beginning with _. Default is True.
Base Classes   

DocSet
  DocSetBase

Methods   
  _filterNames 
_filterNames ( self,  nameList )

Remove names which should be ignored.

Parameters
nameList
List of strings representing names of methods, classes, functions, etc.

This method returns a list based on the contents of nameList. If private names are being ignored, they are removed before the list is returned.

  registerWriter 
registerWriter (
        self,
        mimetype,
        writerName,
        )

Register a writer for the specified mimetype.

  _initializeWriters 
_initializeWriters ( self )

Hook to allow subclasses to register writers without having to override __init__ with all of its arguments.

  write 
write ( self )

Called by the application to cause the docset to be written.

  writeCB 
writeCB ( self,  packageTreeNode )

Callback used when walking the scanned package tree.

  getWriterForNode 
getWriterForNode ( self,  packageTreeNode )

Returns the writer to be used for the node.

  _skipInputFile 
_skipInputFile ( self,  packageTreeNode )

False writer method used to notify the user that a node is being skipped because the real writer is unknown.

  __init__ 
__init__ (
        self,
        scanner,
        title,
        outputDirectory,
        includeComments=1,
        includePrivateNames=1,
        sortNames=0,
        statusMessageFunc=None,
        extraParameters={},
        )

Basic Documentation Set

Parameters
scanner
A directory tree scanner.
title
the title of the documentation set
outputDirectory
The base directory for writing the output files.
includeComments
Boolean. False means to skip the comment parsing step in the parser. Default is True.
includePrivateNames
Boolean. False means to ignore names beginning with _. Default is True.
sortNames=0
Boolean. True means to sort names before generating output. Default is False.
statusMessageFunc
function which will print a status message for the user
extraParameters
Dictionary containing parameters specified on the command line by the user.

This document was automatically generated Tue Dec 5 08:30:58 2006 by HappyDoc version 3.1