epydoc.markup.Field

Package epydoc :: Package markup :: Class Field |
[hide private]
[frames] | no frames]

# Class Field

source code

The contents of a docstring's field. Docstring fields are used to describe specific aspects of an object, such as a parameter of a function or the author of a module. Each field consists of a tag, an optional argument, and a body:

- The tag specifies the type of information that the field encodes.
- The argument specifies the object that the field describes. The argument may be `None` or a `string`.
- The body contains the field's information.

Tags are automatically downcased and stripped; and arguments are automatically stripped.

Instance Methods | [hide private]
__init__(self, tag, arg, body) | source code call graph
Call Graph
`string` |
tag(self) Returns: This field's tag. | source code call graph
Call Graph
`string` or `None` |
arg(self) Returns: This field's argument, or `None` if this field has no argument. | source code call graph
Call Graph
ParsedDocstring |
body(self) Returns: This field's body. | source code call graph
Call Graph
__repr__(self) | source code

Method Details | [hide private]

### tag(self) | source code call graph
Call Graph
Returns: `string` This field's tag.

### arg(self) | source code call graph
Call Graph
Returns: `string` or `None` This field's argument, or `None` if this field has no argument.

### body(self) | source code call graph
Call Graph
Returns: ParsedDocstring This field's body.