pydoctor.epydoc2stan.Field

class documentation

class Field: (source)

Constructors: Field.from_epydoc(field, source), Field(tag, arg, source, lineno, body)

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 __init__ attrs generated method
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>:
def from_epydoc(cls, field: EpydocField, source: model.Documentable) -> Field: (source)

Undocumented

def __init__(self, tag: str, arg: str | None, source: model.Documentable, lineno: int, body: ParsedDocstring): (source)

attrs generated method

Parameters
tag:strField tag, i.e. :<tag>:
arg:str | NoneField argument, i.e. :param <argument>:
source:model.DocumentableUndocumented
lineno:intUndocumented
body:ParsedDocstringUndocumented
def format(self) -> Tag: (source)

Present this field's body as HTML.

def report(self, message: str): (source)

Undocumented

arg: str | None = (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>: