yagdoc.docblock

Package yagdoc :: Module docblock

[show private | hide private]

[frames | no frames]

Module yagdoc.docblock

Process source code docstrings.

Classes
`DocBlock`	Documentation of one symbol.
`DocScanner`	Documentation comment block scanner.

Exceptions
`DocBlockError`	Base class for docblock exceptions
`DuplicateFieldError`	Duplicate field
`DuplicateSymbolError`	Duplicate documentation block
`DuplicateTraitError`	Duplicate trait
`EndInCommentError`	File ended in a documentation block
`EndInQuoteError`	Documentation block ended inside a quoted block
`InvalidOverrideError`	Invalid override
`MalformedLineError`	Malformed documentation block line
`MismatchedQuoteError`	Closing quote does not match opening
`MisplacedOverrideError`	Override is not allowed here
`MissingNameError`	Documentation block lacks symbol/section name
`StrayClosingQuoteError`	Stray closing quote

Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007

http://epydoc.sf.net