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

ClassType 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:

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

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

tag(self)

source code 
call graph 
Returns: string
This field's tag.

arg(self)

source code 
call graph 
Returns: string or None
This field's argument, or None if this field has no argument.

body(self)

source code 
call graph 
Returns: ParsedDocstring
This field's body.