ParsedDef¶

class emlib.doctools.ParsedDef(name='', kind=ObjectKind.Unknown, params=<factory>, returns=None, shortDescr='', longDescr='', embeddedSignature='')[source]¶

Bases: object

A ParsedDef is the result of parsing a function/method definition

name¶: the name of the object

params¶: any input parameters (a list of Param)

returns¶: the return param (a Param)

shortDescr¶: a short description (the first line of the doc)

longDescr¶: the rest of the description (without the first line)

kind¶: the kind of the object (Function, Method, Property)

Attributes Summary

`embeddedSignature`
`kind`
`longDescr`
`name`
`returns`
`shortDescr`

Methods Summary

generateSignature([includeName, includePrefix])

Generated the signature of this func/method based on its paremeters

prefix()

rtype:: str

Attributes Documentation

embeddedSignature: str = ''¶

kind: ObjectKind = 'Unknown'¶

longDescr: str = ''¶

name: str = ''¶

returns: Param | None = None¶

shortDescr: str = ''¶

Methods Documentation

generateSignature(includeName=True, includePrefix=False)[source]¶

Generated the signature of this func/method based on its paremeters

Return type:: str

prefix()[source]¶

Return type:: str