Package       Module       Class       Trees       Index       Help   
epydoc
[show private | hide private]

epydoc.objdoc
Class epydoc.objdoc.Var

The documentation for an individual variable. This consists of the variable's name, its description, and its type. Vars are used by ModuleDoc (variables) and ClassDoc (ivariables and cvariables); and FuncDoc (params, vararg, kwarg, retval).
Method Summary
  __init__(self, name, descr, type, default)
Construct the documentation for a variable or parameter.
  __repr__(self)
string or None default(self)
Return the default value for parameters; or None for variables.
xml.dom.minidom.Element descr(self)
Return the DOM representation of an epytext description of this variable.
string name(self)
Return the name of this variable.
None set_default(self, default)
Set this variable's default value.
None set_descr(self, descr)
Set this variable's description.
None set_type(self, type)
Set this variable's type.
xml.dom.minidom.Element type(self)
Return the DOM representation of an epytext description of this variable's type.

Method Details

Constructor

__init__(self, name, descr=None, type=None, default=None)

Construct the documentation for a variable or parameter.
Parameters:
name - The name of the variable.
           (type=string)
descr - The DOM representation of an epytext description of the variable (as produced by epytext.parse).
           (type=xml.dom.minidom.Element)
type - The DOM representation of an epytext description of the variable's type (as produced by epytext.parse).
           (type=xml.dom.minidom.Element)
default - The default value for parameters; or None for variables.
           (type=string or None)

Representation operator

__repr__(self)

default

default(self)

Returns:
The default value for parameters; or None for variables.
           (type=string or None)

descr

descr(self)

Returns:
The DOM representation of an epytext description of this variable.
           (type=xml.dom.minidom.Element)

name

name(self)

Returns:
The name of this variable.
           (type=string)

set_default

set_default(self, default)

Set this variable's default value.
Parameters:
default - The default value for parameters; or None for variables.
           (type=string or None)
Returns:
None

set_descr

set_descr(self, descr)

Set this variable's description.
Parameters:
descr - The DOM representation of an epytext description of the variable's type (as produced by epytext.parse).
           (type=xml.dom.minidom.Element)
Returns:
None

set_type

set_type(self, type)

Set this variable's type.
Parameters:
type - The DOM representation of an epytext description of the variable's type (as produced by epytext.parse).
           (type=xml.dom.minidom.Element)
Returns:
None

type

type(self)

Returns:
The DOM representation of an epytext description of this variable's type.
           (type=xml.dom.minidom.Element)

   Package       Module       Class       Trees       Index       Help   
epydoc
Generated by Epydoc on Sun Oct 6 03:32:15 2002 http://epydoc.sf.net