Package lemon :: Package external :: Package epydoc :: Module objdoc :: Class FuncDoc
[show private | hide private]
[frames | no frames]

Class FuncDoc

ObjDoc --+
         |
        FuncDoc


The documentation for a function. This documentation consists of standard pieces of documentation (as defined in ObjDoc), and the following function-specific pieces of documentation:
Method Summary
  __init__(self, uid, verbosity)
  __repr__(self)
list of Var keywords(self)
Return the keyword parameters for the function/method documented by this FuncDoc.
    Accessors
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.
boolean matches_override(self)
Return true if the method documented by this FuncDoc overrides another method, and its signature matches the signature of the overridden method.
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 positional 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.
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.
    Inheritance
  find_override(self, bases)
Find the method that this method overrides.
    Inherited from ObjDoc
list of (string, elt) by_group(self, elts)
Divide a set of elements into groups.
boolean defines_groups(self)
Return true if the object documented by this ObjDoc defines any groups.
markup.ParsedDocstring descr(self)
Return a description of the object documented by this ObjDoc.
list of markup.ParsedDocstring field_values(self, field)
Return a list of the values that are specified for the given field in the docstring of the object documented by this ObjDoc.
list of DocField fields(self)
Return a list of the fields that are given values in the docstring of the object documented by this ObjDoc.
list of string groups(self)
Return a list of the names of the groups that are defined for the object documented by this ObjDoc.
boolean has_docstring(self)
Return true if the object documented by this ObjDoc has a docstring.
list of string sortorder(self)
Return a list specifying the sort order that should be used for the object's children.
markup.ParsedDocstring summary(self)
Return a summary of the description of the object documented by this ObjDoc.
UID uid(self)
Return the UID of the object documented by this ObjDoc.

Class Variable Summary
    Inherited from ObjDoc
List of DocField STANDARD_FIELDS: The list of standard docstring fields that epydoc accepts.

Method Details

find_override(self, bases)

Find the method that this method overrides.

keywords(self)

Returns:
The keyword parameters for the function/method documented by this FuncDoc.
           (type=list of Var)

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)

matches_override(self)

Returns:
True if the method documented by this FuncDoc overrides another method, and its signature matches the signature of the overridden method.
           (type=boolean)

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(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. This list includes vararg & keyword params, but does not include the return value.
           (type=list of Var)

See Also: parameters

parameters(self)

Returns:
The positional 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

For this function, 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(self)

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

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(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)

Generated by Epydoc 2.0 on Mon Nov 10 15:08:08 2003 http://epydoc.sf.net