epydoc.markup.Field

Package epydoc :: Package markup :: Class Field

[show private | hide private]

Class Field

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.

Method Summary
	`__init__(self, tag, arg, body)`
	`__repr__(self)`
`string` or `None`	`arg(self)` Return this field's argument, or `None` if this field has no argument.
`ParsedDocstring`	`body(self)` Return this field's body.
`string`	`tag(self)` Return this field's tag.

Method Details

arg(self)

Returns:: This field's argument, or None if this field has no argument.
(type=string or None)

body(self)

Returns:: This field's body.
(type=ParsedDocstring)

tag(self)

Returns:: This field's tag.
(type=string)

Generated by Epydoc 2.1 on Sat Mar 20 17:46:13 2004

http://epydoc.sf.net