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

epydoc.objdoc
Class epydoc.objdoc.FuncDoc

ObjDoc --+
         |
        FuncDoc

The documentation for a function of method. This documentation consists of the standard documentation fields (descr, author, etc.) and the following class-specific fields: For more information on the standard documentation fields, see ObjDoc.
Method Summary
  __init__(self, obj, verbosity)
Create the documentation for the given object.
  __repr__(self)
list of Element authors(self)
Return a list of the authors of the object documented by this ObjDoc. (inherited from ObjDoc)
Element descr(self)
Return a description of the object documented by this ObjDoc. (inherited from ObjDoc)
boolean documented(self)
Return true if the object documented by this ObjDoc has a docstring. (inherited from ObjDoc)
Var or None kwarg(self)
Return the keyword parameter for the function/method documented by this FuncDoc, or None if it has no keyword parameter.
Link or None overrides(self)
Return the method overridden by the method documented by this FuncDoc; or None if the method documented by this FuncDoc does not override any method, or if this FuncDoc documents a function.
list of Var parameter_list(self)
Return a (flat) list of all parameters for the function/method documented by this FuncDoc.
list of Var parameters(self)
Return the parameters for the function/method documented by this FuncDoc.
list of Raise raises(self)
Return a list of exceptions that may be raised by the function/method documented by this FuncDoc.
Var or None returns(self)
Return the return value for the function/method documented by this FuncDoc, or None if it has no return value.
list of Element seealsos(self)
Return a list of objects related to the object documented by this ObjDoc. (inherited from ObjDoc)
list of string sortorder(self)
Return the object's __epydoc_sort__ list. (inherited from ObjDoc)
UID uid(self)
Return the UID of the object documented by this ObjDoc. (inherited from ObjDoc)
Var or None vararg(self)
Return the vararg parameter for the function/method documented by this FuncDoc, or None if it has no vararg parameter.
Element version(self)
Return the version of the object documented by this ObjDoc. (inherited from ObjDoc)

Method Details

Constructor

__init__(self, func, verbosity=0)

Overrides:
epydoc.objdoc.ObjDoc.__init__

Representation operator

__repr__(self)

kwarg

kwarg(self)

Returns:
The keyword parameter for the function/method documented by this FuncDoc, or None if it has no keyword parameter.
           (type=Var or None)

overrides

overrides(self)

Returns:
The method overridden by the method documented by this FuncDoc; or None if the method documented by this FuncDoc does not override any method, or if this FuncDoc documents a function.
           (type=Link or None)

parameter_list

parameter_list(self)

Returns:
A (flat) list of all parameters for the function/method documented by this FuncDoc. If you are interested in the signature of the function/method, you should use parameters instead.
           (type=list of Var)

parameters

parameters(self)

Returns:
The parameters for the function/method documented by this FuncDoc. This is typically a list of parameters, but it can contain sublists if the function/method's signature contains sublists. For example, for the function: 
>>> def f(a, (b, c), d): pass

parameters will return a three-element list, whose second element is a sublist containing Vars for b and c.

If you just want a list of all parameters used by the function/method, use parameter_list instead.
           (type=list of Var)

raises

raises(self)

Returns:
A list of exceptions that may be raised by the function/method documented by this FuncDoc.
           (type=list of Raise)

returns

returns(self)

Returns:
The return value for the function/method documented by this FuncDoc, or None if it has no return value.
           (type=Var or None)

vararg

vararg(self)

Returns:
The vararg parameter for the function/method documented by this FuncDoc, or None if it has no vararg parameter.
           (type=Var or None)

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