Home | Trees | Index | Help |
|
---|
Package yagdoc :: Module docblock :: Class DocBlock |
|
object
--+
|
DocBlock
Documentation of one symbol.
Each documentation part (description
and values in symbols
and traits
) is a list of stripped lines.
Method Summary | |
---|---|
__init__(self,
name)
| |
bool
|
Clean up documentation. |
Inherited from object :
__delattr__ ,
__getattribute__ ,
__hash__ ,
__new__ ,
__reduce__ ,
__reduce_ex__ ,
__repr__ ,
__setattr__ ,
__str__
|
Instance Variable Summary | |
---|---|
list of str |
description : Symbol description body. |
int |
lineno : Line number of the comment start. |
str |
name : Symbol name. |
dict of stuff |
overrides : Overrides for symbols. |
str |
source : Source file. |
dict of list of
str |
symbols : Dictionary of field documentation. |
dict of list of
str |
traits : Dictionary of traits (Since, Deprecated, ...). |
Method Details |
---|
clean_up(self)Clean up documentation. At present the clean-up consists of removal of trailing empty lines and complete removal of subsymbols with empty documentation.
|
Instance Variable Details |
---|
descriptionSymbol description body.
|
linenoLine number of the comment start.
|
nameSymbol name.
|
sourceSource file.
|
symbolsDictionary of field documentation.
|
traitsDictionary of traits (Since, Deprecated, ...).
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007 | http://epydoc.sf.net |