pydoctor.epydoc2stan._SignatureDesc

class documentation

class _SignatureDesc(FieldDesc): (source)

Known subclasses: pydoctor.epydoc2stan.KeywordDesc, pydoctor.epydoc2stan.ParamDesc, pydoctor.epydoc2stan.ReturnDesc

Constructor: _SignatureDesc(name, type, body, type_origin)

View In Hierarchy

Undocumented

Method __init__ attrs generated method
Method is_documented Undocumented
Instance Variable type_origin Undocumented

Inherited from FieldDesc:

Method format No summary
Instance Variable body Undocumented
Instance Variable name Field name, i.e. :param <name>:
Instance Variable type Formatted type
Constant _UNDOCUMENTED Undocumented
def __init__(self, name: str | None = None, type: Tag | None = None, body: Tag | None = None, type_origin: FieldOrigin | None = None): (source)
overrides pydoctor.epydoc2stan.FieldDesc.__init__
overridden in pydoctor.epydoc2stan.KeywordDesc, pydoctor.epydoc2stan.ParamDesc, pydoctor.epydoc2stan.ReturnDesc

attrs generated method

Parameters
name:str | NoneField name, i.e. :param <name>:
type:Tag | NoneFormatted type
body:Tag | NoneUndocumented
type_origin:FieldOrigin | NoneUndocumented
def is_documented(self) -> bool: (source)

Undocumented

type_origin: FieldOrigin | None = (source)

Undocumented