pydoctor.epydoc2stan.Field

class documentation

class Field: (source)

View In Hierarchy

Like pydoctor.epydoc.markup.Field, but without the gross accessor methods and with a formatted body.

Example:

    @note: some other information
Class Method from_epydoc Undocumented
Method format Present this field's body as HTML.
Method report Undocumented
Instance Variable arg Field argument, i.e. :param <argument>:
Instance Variable body Undocumented
Instance Variable lineno Undocumented
Instance Variable source Undocumented
Instance Variable tag Field tag, i.e. :<tag>:
@classmethod
def from_epydoc(cls, field, source): (source)

Undocumented

Parameters
field:EpydocFieldUndocumented
source:model.DocumentableUndocumented
Returns
FieldUndocumented
def format(self): (source)

Present this field's body as HTML.

Returns
TagUndocumented
def report(self, message): (source)

Undocumented

Parameters
message:strUndocumented
arg: Optional[str] = (source)

Field argument, i.e. :param <argument>:

body: ParsedDocstring = (source)

Undocumented

lineno: int = (source)

Undocumented

source: model.Documentable = (source)

Undocumented

tag: str = (source)

Field tag, i.e. :<tag>: