Home | Trees | Index | Help |
|
---|
Package lemon :: Package external :: Package epydoc :: Module objdoc :: Class FuncDoc |
|
ObjDoc
--+
|
FuncDoc
ObjDoc
), and the following
function-specific pieces of documentation:
None
.
None
.
Method Summary | |
---|---|
__init__(self,
uid,
verbosity)
| |
__repr__(self)
| |
list of Var
|
Return the keyword parameters for the function/method documented by this FuncDoc . |
Accessors | |
Var or None
|
Return the keyword parameter for the function/method documented by this FuncDoc , or None if it has no keyword
parameter. |
boolean
|
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
|
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
|
Return a (flat) list of all parameters for the function/method documented by this FuncDoc . |
list of Var
|
Return the positional parameters for the function/method documented by this FuncDoc . |
list of Raise
|
Return a list of exceptions that may be raised by the function/method documented by this FuncDoc . |
Var or None
|
Return the return value for the function/method documented by this FuncDoc , or None if it has no return value. |
Var or None
|
Return the vararg parameter for the function/method documented by this FuncDoc , or None if it has no vararg
parameter. |
Inheritance | |
Find the method that this method overrides. | |
Inherited from ObjDoc | |
list of (string, elt)
|
Divide a set of elements into groups. |
boolean
|
Return true if the object documented by this ObjDoc defines any
groups. |
markup.ParsedDocstring
|
Return a description of the object documented by this ObjDoc . |
list of markup.ParsedDocstring
|
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
|
Return a list of the fields that are given values in the docstring of the object documented by this ObjDoc . |
list of string
|
Return a list of the names of the groups that are defined for the object documented by this ObjDoc . |
boolean
|
Return true if the object documented by this ObjDoc has a
docstring. |
list of string
|
Return a list specifying the sort order that should be used for the object's children. |
markup.ParsedDocstring
|
Return a summary of the description of the object documented by this ObjDoc . |
UID
|
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)
|
kwarg(self)
|
matches_override(self)
|
overrides(self)
|
parameter_list(self)
|
parameters(self)
|
raises(self)
|
returns(self)
|
vararg(self)
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.0 on Mon Nov 10 15:08:08 2003 | http://epydoc.sf.net |