epydoc.epytext.StructuringError

Package	Module	Class	Trees	Index	Help

epydoc

[show private | hide private]

epydoc.epytext
Class epydoc.epytext.StructuringError

Exception --+    
            |    
   ParseError --+
                |
               StructuringError

A warning or error generated while structuring a formatted documentation string.

Method Summary
	`__init__(self, descr, token)` Construct a new structuring exception.
`int`	`__cmp__(self, other)` Compare two `ParseError`s, based on their line number. (inherited from `ParseError`)
`string`	`__repr__(self)` Return the formal representation of this `ParseError`. (inherited from `ParseError`)
`string`	`__str__(self)` Return the informal string representation of this `ParseError`. (inherited from `ParseError`)
`string`	`as_error(self)` Return a string representation of this `ParseError`. (inherited from `ParseError`)
`string`	`as_warning(self)` Return a string representation of this `ParseError`. (inherited from `ParseError`)

Instance Variable Summary
`Token`	`token` - The `Token` where the `StructuringError` occured.

Method Details

__init__(self, descr, token)

Construct a new structuring exception.

Parameters:: descr - A short description of the error.
(type=string); token - The token where the error occured
(type=Token)

Instance Variable Details

The Token where the StructuringError occured.

Package	Module	Class	Trees	Index	Help

epydoc

Generated by Epydoc on Sun Oct 6 03:32:12 2002