Package gavo :: Package user :: Module docgen :: Class MacroDoc

Class MacroDoc

object --+
         |
        MacroDoc

documentation for a macro, including the objects that know about it.

Instance Methods

__init__(self, name, macFunc, foundIn)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

addObject(self, macFunc, obj)
declares that macFunc is also available on the python object obj.

source code

makeDoc(self, content)
adds documentation of macFunc to the RSTFragment content.

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, name, macFunc, foundIn)
(Constructor)

source code

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

Overrides: object.__init__: (inherited documentation)

addObject(self, macFunc, obj)

source code

declares that macFunc is also available on the python object obj.

If also checks implements the "see <whatever>" mechanism described in KnownMacros.

Class MacroDoc

__init__(self, name, macFunc, foundIn) (Constructor)

addObject(self, macFunc, obj)

init(self, name, macFunc, foundIn)
(Constructor)