pydoctor.epydoc2stan.ReturnDesc

class documentation

class ReturnDesc(_SignatureDesc): (source)

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

View In Hierarchy

Undocumented

Method __init__ attrs generated method

Inherited from _SignatureDesc:

Method is_documented Undocumented
Instance Variable type_origin Undocumented

Inherited from FieldDesc (via _SignatureDesc):

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._SignatureDesc.__init__

attrs generated method

Parameters
name:str | NoneField name, i.e. :param <name>:
type:Tag | NoneFormatted type
body:Tag | NoneUndocumented
type_origin:FieldOrigin | NoneUndocumented