docspec.HasLocation
- Base class for objects that have a #Location.docspec.ApiObject
- The base class for representing "API Objects". Any API object is any addressable entity in code, be that a variable/constant, function, class or module.docspec.Function
- Represents a function definition. This can be in a #Module for plain functions or in a #Class for methods. The #decorations need to be introspected to understand if the function has a special purpose (e...docspec.HasMembers
- Base class for API objects that can have members, e.g. #Class and #Module.docspec.Class
- Represents a class definition.docspec.Module
- Represents a module, basically a named container for code/API objects. Modules may be nested in other modules. Be aware that for historical reasons, some loaders lile #docspec_python by default do not return nested modules, even if nesting would be appropriate (and instead the #Module...docspec.Indirection
- Represents an imported name. It can be used to properly find the full name target of a link written with a local name.docspec.Variable
- Represents a variable assignment (e.g. for global variables (often used as constants) or class members).docspec.Argument
- Represents a #Function argument.docspec.Decoration
- Represents a decorator on a #Class or #Function.docspec.Docstring
- Represents a docstring for an #APIObject, i.e. it's content and location. This class is a subclass of `str` for backwards compatibility reasons. Use the #content property to access the docstring content over the #Docstring value directory.docspec.Location
- Represents the location of an #ApiObject by a filename and line number.enum.Enum
docspec.Argument.Type
- The type of the argument. This is currently very Python-centric, however most other languages should be able to represent the various argument types with a subset of these types without additions (e.g. ...docspec.ClassSemantic
- A list of well-known properties and behaviour that can be attributed to a class.docspec.FunctionSemantic
- A list of well-known properties and behaviour that can be attributed to a function.docspec.VariableSemantic
- A list of well-known properties and behaviour that can be attributed to a variable/constant.