Package gavo :: Package user :: Module docgen :: Class StructDocMaker

Class StructDocMaker

object --+
         |
        StructDocMaker

A class encapsulating generation of documentation from structs.

Instance Methods

__init__(self, docStructure)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

addDocsFrom(self, klass, docStructure)

source code

getDocs(self)

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(self, docStructure)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

Class StructDocMaker

__init__(self, docStructure) (Constructor)

init(self, docStructure)
(Constructor)