Skip to main content

functions

ModuleSource

The documentation extraction of functions and methods.

Classes​

Member
Description
ParameterKindReplica of the inspect._ParameterKind.
FunctionTypeThe type of a callable object (function).
DocArgumentThe docstring of a function/method argument.
DocFunctionOverloadThe docstring and basic information of a function overload.
DocFunctionThe docstring and basic information of a function.

Functions​

Member
Description
parse_argument_docs(Private) Parse the docstring related to function arguments.
parse_return_docs(Private) Parse the docstring related to function returned values.
parse_func_docsParse the docstring of a function.