epydoc.objdoc.Raise

Package epydoc :: Module objdoc :: Class Raise

[show private | hide private]

Class Raise

The documentation for the raising of an exception. This consists of the exception's name and its description. Exceptions are used by FuncDoc.

Method Summary
	`__init__(self, name, descr)` Construct the documentation for the raising of an exception.
	`__repr__(self)`
`markup.ParsedDocstring`	`descr(self)` Return a description of the circumstances under which this exception is raised.
`string`	`name(self)` Return the name of the exception.

Method Details

Construct the documentation for the raising of an exception.

Parameters:: name - The name of the exception.
(type=string); descr - A description of the circumstances under which this exception is raised.
(type=markup.ParsedDocstring)

Returns:: A description of the circumstances under which this exception is raised.
(type=markup.ParsedDocstring)

Generated by Epydoc 2.1 on Sat Mar 20 17:46:12 2004