5.3. sphinx.domains.cpp

The C++ language domain.

copyright:Copyright 2007-2016 by the Sphinx team, see AUTHORS.
license:BSD, see LICENSE for details.

5.3.1. Functions

deepcopy(x[, memo, _nil]) Deep copy operation on arbitrary Python objects.
iteritems(d, **kw) Return an iterator over the (key, value) pairs of a dictionary.
l_(string) A lazy version of gettext.
make_refnode(builder, fromdocname, ...[, title]) Shortcut to create a reference node.

5.3.2. Classes

ASTArray(size)
ASTBase
ASTBaseClass(name, visibility)
ASTClass(name, visibility, bases)
ASTDeclSpecs(outer, visibility, leftSpecs, ...)
ASTDeclSpecsSimple(storage, inline, virtual, ...)
ASTDeclaratorParamPack(next)
ASTDeclaratorParen(inner, next)
ASTDeclaratorPtr(next, volatile, const)
ASTDeclaratorRef(next)
ASTDecleratorNameParamQual(declId, arrayOps, ...)
ASTEnum(name, visibility, scoped, underlyingType)
ASTEnumerator(name, init)
ASTFunctinoParameter(arg[, ellipsis])
ASTInitializer(value)
ASTNestedName(names)
ASTNestedNameElement(identifier, templateArgs)
ASTNestedNameElementEmpty Used if a nested name starts with
ASTOperatorBuildIn(op)
ASTOperatorType(type)
ASTParametersQualifiers(args, volatile, ...)
ASTTemplateArgConstant(value)
ASTTrailingTypeSpecFundamental(name)
ASTTrailingTypeSpecName(prefix, nestedName)
ASTType(declSpecs, decl)
ASTTypeWithInit(type, init)
CPPClassObject(name, arguments, options, ...)
CPPDomain(env) C++ language domain.
CPPEnumObject(name, arguments, options, ...)
CPPEnumeratorObject(name, arguments, ...)
CPPFunctionObject(name, arguments, options, ...)
CPPMemberObject(name, arguments, options, ...)
CPPNamespaceObject(name, arguments, options, ...) This directive is just to tell Sphinx that we’re documenting stuff in namespace foo.
CPPObject(name, arguments, options, content, ...) Description of a C++ language object.
CPPTypeObject(name, arguments, options, ...)
CPPXRefRole([fix_parens, lowercase, ...])
DefinitionParser(definition)
Directive(name, arguments, options, content, ...) Base class for reStructuredText directives.
Domain(env) A Domain is meant to be a group of “object” description directives for objects of a similar nature, and corresponding roles to create references to them.
Field(name[, names, label, has_arg, ...]) A doc field that is never grouped.
GroupedField(name[, names, label, rolename, ...]) A doc field that is grouped; i.e., all fields of that type will be transformed into one field with its body being a bulleted list.
ObjType(lname, *roles, **attrs) An ObjType is the description for a type of object that a domain can document.
ObjectDescription(name, arguments, options, ...) Directive to describe a class, function or similar object.
UnicodeMixin Mixin class to handle defining the proper __str__/__unicode__ methods in Python 2 or 3.
XRefRole([fix_parens, lowercase, nodeclass, ...]) A generic cross-referencing role.
text_type alias of unicode

5.3.3. Exceptions

DefinitionError(description)
NoOldIdError([description])