epydoc.objdoc.DocField

Package epydoc :: Module objdoc :: Class DocField

[show private | hide private]

Class DocField

A generic docstring field. Docstring field are used to describe specific information about an object, such as its author or its version. Generic docstring fields are fields that take no arguments, and are displayed as simple sections.

Method Summary
	`__init__(self, tags, label, plural, short, multivalue)`
	`__cmp__(self, other)`
	`__hash__(self)`
	`__repr__(self)`

Instance Variable Summary
	`multivalue`: If true, then multiple values may be given for this field; if false, then this field can only take a single value, and a warning should be issued if it is redefined.
	`plural`: The label that should be used to identify this field in the output, if the field contains multiple values.
	`short`: If true, then multiple values should be combined into a single comma-delimited list.
	`singular`: The label that should be used to identify this field in the output, if the field contains one value.
	`tags`: The set of tags that can be used to identify this field.

Instance Variable Details

multivalue

If true, then multiple values may be given for this field; if false, then this field can only take a single value, and a warning should be issued if it is redefined.

plural

The label that should be used to identify this field in the output, if the field contains multiple values.

short

If true, then multiple values should be combined into a single comma-delimited list. If false, then multiple values should be listed separately in a bulleted list.

singular

The label that should be used to identify this field in the output, if the field contains one value.

Class DocField

multivalue

plural

short

singular

tags