Table of Contents

Module: docset_mstruct ../HappyDoc-r2_1/happydoclib/docset/docset_mstruct.py

Documentation set which writes output to multiple structured files.

This docset creates file for every module and defined class.

Documentation structure is rendered with formatter's process methods (processClass, processModule, processImport, etc.). There is special method -- processRoot. It is invoked when new output is opened or closed.

These all methods can be called in four different stages (element
i.e. class or module): 1. PRE -- before any of elements processing 2. START -- before an element processing 3. END -- after an element processing 4. POST -- after all element processing

Formatters can produce index of created by this docset files with packageIndex, moduleIndex and classIndex methods.

Imported modules   
from happydoclib.docset.mstruct_const import *
import happydoclib.happydocset
Functions   
entryPoint
  entryPoint 
entryPoint ()

Return info about this module to the HappyDoc dynamic loader.

Classes   

MStructDocSet

Documentation set written to multiple structured files.


Table of Contents

This document was automatically generated on Sat Aug 24 16:57:23 2002 by HappyDoc version 2.1