epydoc.objdoc.FuncDoc

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:

- parameters: A list of the function's positional parameters.
- vararg: The function's vararg parameter, or `None`.
- kwarg: The function's keyword parameter, or `None`.
- returns: The function's return value.
- raises: A list of exceptions that may be raised by the function.
- overrides: The method that this method overrides.

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
`list` of `Var` | ``parameters`(self)` Return the positional parameters for the function/method documented by this `FuncDoc`.
`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.
`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.
`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 `Raise` | ``raises`(self)` Return a list of exceptions that may be raised by the function/method documented by this `FuncDoc`.
`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.
`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.
`list` of `Var` | ``parameter_list`(self)` Return a (flat) list of all parameters for the function/method documented by this `FuncDoc`.
Inherited from `ObjDoc`: `by_group`, `defines_groups`, `descr`, `field_values`, `fields`, `groups`, `has_docstring`, `sortorder`, `summary`, `uid`
Inheritance
| ``find_override`(self, bases)` Find the method that this method overrides.

Class Variable Summary
Docstring Parsing
Inherited from `ObjDoc`: `STANDARD_FIELDS`

Method Details

    ### 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 `Var`s 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`)

### 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`)

### 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`)

### 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`)

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

### 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`)

### 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`)

### 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`

### 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`)

Generated by Epydoc 2.1 on Sat Mar 20 17:46:16 2004 | http://epydoc.sf.net