Package gavo :: Package user :: Module docgen :: Class DocumentStructure

Class DocumentStructure

object --+    
         |    
      dict --+
             |
            DocumentStructure

a dict keeping track of what elements have been processed and which children they had.

From this information, it can later fill out the ParentPlaceholders left in the proto reference doc.

This also keeps track of what macros can be used where.

Instance Methods

new empty dictionary

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

source code

fillOut(self, protoDoc)

source code

Inherited from dict: __cmp__, __contains__, __delitem__, __eq__, __ge__, __getattribute__, __getitem__, __gt__, __iter__, __le__, __len__, __lt__, __ne__, __new__, __repr__, __setitem__, __sizeof__, clear, copy, fromkeys, get, has_key, items, iteritems, iterkeys, itervalues, keys, pop, popitem, setdefault, update, values, viewitems, viewkeys, viewvalues

Inherited from object: __delattr__, __format__, __reduce__, __reduce_ex__, __setattr__, __str__, __subclasshook__

Class Variables
Inherited from `dict`: `__hash__`

Properties
Inherited from `object`: `__class__`

Method Details

init(self)
(Constructor)

source code

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

Returns: new empty dictionary
Overrides: object.__init__: (inherited documentation)

Class DocumentStructure

__init__(self) (Constructor)

init(self)
(Constructor)