pydoctor.epydoc2stan.Field

class documentation

class Field:

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

Undocumented

def format(self):

Present this field's body as HTML.

Returns
`Tag`	Undocumented

def report(self, message):

Undocumented

Parameters
message:`str`	Undocumented

arg: Optional[str] =

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

body: ParsedDocstring =

Undocumented

lineno: int =

Undocumented

source: model.Documentable =

Undocumented

tag: str =

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