class documentation

class DecoratorDocumenter(FunctionDocumenter):

View In Hierarchy

Specialized Documenter subclass for decorator functions.
Method format​_args Format the argument signature of self.object.
Class Variable objtype Undocumented
Class Variable priority Undocumented

Inherited from FunctionDocumenter:

Class Method can​_document​_member Called to see if a member can be documented by this Documenter.
Method add​_directive​_header Add the directive header and options to the generated content.
Method annotate​_to​_first​_argument Annotate type hint to the first argument of function if needed.
Method document​_members Generate reST for member documentation.
Method format​_signature Format the signature (arguments and return annotation) of the object.
Method merge​_default​_value Merge default values of actual implementation to the overload variants.
Class Variable member​_order Undocumented

Inherited from DocstringSignatureMixin (via FunctionDocumenter):

Method ​_find​_signature Undocumented
Method get​_doc Undocumented
Instance Variable ​_new​_docstrings Undocumented
Instance Variable ​_signatures Undocumented
Instance Variable args Undocumented
Instance Variable retann Undocumented

Inherited from ModuleLevelDocumenter (via FunctionDocumenter):

Method resolve​_name Resolve the module and name of the object to document given by the arguments and the current module/class.

Inherited from Documenter (via FunctionDocumenter, ModuleLevelDocumenter):

Method __init__ Undocumented
Method ​_call​_format​_args Undocumented
Method add​_content Add content from docstrings, attribute documentation and user.
Method add​_line Append one line of generated reST to the output.
Method check​_module Check if self.object is really defined in the module given by self.modname.
Method filter​_members Filter the given member list.
Method format​_name Format the name of self.object.
Method generate Generate reST for the object given by self.name, and possibly for its members.
Method get​_attr getattr() override for types such as Zope interfaces.
Method get​_doc Decode and return lines of the docstring(s) for the object.
Method get​_object​_members Return (members_check_module, members) where members is a list of (membername, member) pairs of the members of self.object.
Method get​_real​_modname Get the real module name of an object to document.
Method get​_sourcename Undocumented
Method import​_object Import the object given by self.modname and self.objpath and set it as self.object.
Method parse​_name Determine what module to import and what attribute to document.
Method process​_doc Let the user process the docstrings before adding them.
Method sort​_members Sort the given member list.
Class Variable content​_indent Undocumented
Class Variable option​_spec Undocumented
Class Variable titles​_allowed Undocumented
Instance Variable analyzer Undocumented
Instance Variable args Undocumented
Instance Variable config Undocumented
Instance Variable directive Undocumented
Instance Variable env Undocumented
Instance Variable fullname Undocumented
Instance Variable indent Undocumented
Instance Variable modname Undocumented
Instance Variable module Undocumented
Instance Variable name Undocumented
Instance Variable object Undocumented
Instance Variable object​_name Undocumented
Instance Variable objpath Undocumented
Instance Variable options Undocumented
Instance Variable parent Undocumented
Instance Variable real​_modname Undocumented
Instance Variable retann Undocumented
Property documenters Returns registered Documenter classes
def format_args(self, **kwargs):

Format the argument signature of self.object.

Should return None if the object does not have a signature.

Parameters
**kwargs:AnyUndocumented
Returns
AnyUndocumented
objtype: str =
priority: int =