yagdoc.docblock.DocScanner

Package yagdoc :: Module docblock :: Class DocScanner

[show private | hide private]

Type DocScanner

object --+
         |
        DocScanner

Documentation comment block scanner.

Attributes are only available after scan.

Method Summary
	`__init__(self)`
	`scan(self, source)` Gather documentation from source code.
	`_add_overrides(self, docblock, match, name, style)`
	`_check_quotes(self, line)`
	`_fail(self, exception, detail)`
	`_handle_compat_fields(self, name, style)`
Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Instance Variable Summary
`dict` of `DocBlock`	`documentation`: Dictionary with all documentation, indexed by symbol names.
`list` of `DocBlockError`	`errors`: Errors encountered.
`str`	`source`: Documentation source (set from `source` passed to `scan`).

Method Details

Gather documentation from source code.

Parameters:: source - Source code, its name attribute determines names shown in error messages.
(type=an iterable returning lines of code, typically a file instance)

Instance Variable Details

Dictionary with all documentation, indexed by symbol names.

Errors encountered.

Documentation source (set from source passed to scan).

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