Home       Trees       Index       Help   

epydoc 3.0alpha2

Package epydoc :: Module docstringparser :: Class DocstringField
[hide private]
[frames] | no frames]

Class DocstringField
source code

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

Instance Methods [hide private]
  __init__(self, tags, label, plural=None, short=0, multivalue=1, takes_arg=0)
  __cmp__(self, other)
  __hash__(self)
  __repr__(self)

Instance Variables [hide private]
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.
takes_arg If true, then this field expects an argument; and a separate field section will be constructed for each argument value.

Method Details [hide private]

__init__(self, tags, label, plural=None, short=0, multivalue=1, takes_arg=0)
(Constructor)

source code 
call graph 

__cmp__(self, other)
(Comparison operator)

source code 

__hash__(self)
(Hashing function)

source code 

__repr__(self)
(Representation operator)

source code 
call graph 

Instance Variable Details [hide private]

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.

tags

The set of tags that can be used to identify this field.

takes_arg

If true, then this field expects an argument; and a separate field section will be constructed for each argument value. The label (and plural label) should include a '%s' to mark where the argument's string rep should be added.

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:34:19 2006 http://epydoc.sf.net