epydoc.objdoc.Raise

Package	Module	Class	Trees	Index	Help

epydoc

[show private | hide private]

epydoc.objdoc
Class epydoc.objdoc.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.
`xml.dom.minidom.Element`	`descr(self)` Return the DOM representation of an epytext description of when the exception is raised (as produced by `epytext.parse`).
`string`	`name(self)` Return the name of the exception.

Method Details

__init__(self, name, descr)

Construct the documentation for the raising of an exception.

Parameters:: name - The name of the exception.
(type=string); descr - The DOM representation of an epytext description of when the exception is raised (as produced by epytext.parse).
(type=xml.dom.minidom.Element)

descr(self)

Returns:: The DOM representation of an epytext description of when the exception is raised (as produced by epytext.parse).
(type=xml.dom.minidom.Element)

name(self)

Package	Module	Class	Trees	Index	Help

epydoc

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