pydoctor.epydoc2stan.FieldDesc

class documentation

class FieldDesc:

Known subclasses: pydoctor.epydoc2stan.RaisesDesc

View In Hierarchy

Combines informations from multiple Field objects into one.

Example:

   :param foo: description of parameter foo
   :type foo:  SomeClass
Method format
Instance Variable body Undocumented
Instance Variable name Field name, i.e. :param <name>:
Instance Variable type Formatted type
Constant ​_UNDOCUMENTED Undocumented
def format(self):
overridden in pydoctor.epydoc2stan.RaisesDesc
Returns
Generator[Tag, None, None]Iterator that yields one or two tags.td.
body: Optional[Tag] =

Undocumented

name: Optional[str] =
Field name, i.e. :param <name>:
type: Optional[Tag] =
Formatted type
_UNDOCUMENTED: ClassVar[Tag] =

Undocumented

Value
tags.span(class_='undocumented')('Undocumented')