pydocspec.converter._ConverterVisitor

class documentation

class _ConverterVisitor(basebuilder.Collector, visitors._docspecApiObjectVisitor): (source)

View In Hierarchy

Visit each docspec objects of a module and create their pydocspec augmented counterparts.

Method unknown_departure Undocumented
Method visit_Class Undocumented
Method visit_Function Undocumented
Method visit_Indirection Undocumented
Method visit_Module Undocumented
Method visit_Variable Undocumented
Method _convert_Decoration Undocumented
Method _convert_Docstring Undocumented
Method _convert_Location Undocumented

Inherited from Collector:

Method __init__ Undocumented
Method add_object See TreeRoot.add_object.
Instance Variable module Undocumented
Instance Variable root The root of the tree.

Inherited from _docspecApiObjectVisitor:

Class Method get_children Undocumented
def unknown_departure(self, obj): (source)

Undocumented

Parameters
obj:docspec.ApiObjectUndocumented
def visit_Class(self, klass): (source)

Undocumented

Parameters
klass:docspec.ClassUndocumented
def visit_Function(self, function): (source)

Undocumented

Parameters
function:docspec.FunctionUndocumented
def visit_Indirection(self, indirection): (source)

Undocumented

Parameters
indirection:docspec.IndirectionUndocumented
def visit_Module(self, module): (source)

Undocumented

Parameters
module:docspec.ModuleUndocumented
def visit_Variable(self, data): (source)

Undocumented

Parameters
data:docspec.VariableUndocumented
def _convert_Decoration(self, decoration): (source)

Undocumented

Parameters
decoration:docspec.DecorationUndocumented
Returns
pydocspec.DecorationUndocumented
def _convert_Docstring(self, docstring): (source)

Undocumented

Parameters
docstring:Optional[docspec.Docstring]Undocumented
Returns
Optional[pydocspec.Docstring]Undocumented
def _convert_Location(self, location): (source)

Undocumented

Parameters
location:docspec.LocationUndocumented
Returns
pydocspec.LocationUndocumented