Home       Trees       Index       Help   

Yagdoc

Package yagdoc :: Module docblock :: Class DocBlock
[show private | hide private]
[frames | no frames]

Type 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(self)
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.
Returns:
True if there is any documentation at all left, False if the docblock is empty (equivalent to a missing docblock).
           (type=bool)

Instance Variable Details

description

Symbol description body.
Type:
list of str

lineno

Line number of the comment start.
Type:
int

name

Symbol name.
Type:
str

overrides

Overrides for symbols. At present they are couples (index, overrides) where index is the position of the symbol in the documentation and overrides is a list of (key, value) pairs extracted from override list (it can be an empty list).
Type:
dict of stuff

source

Source file.
Type:
str

symbols

Dictionary of field documentation.
Type:
dict of list of str

traits

Dictionary of traits (Since, Deprecated, ...).
Type:
dict of list of str

   Home       Trees       Index       Help   

Yagdoc

Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007 http://epydoc.sf.net