mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-13 17:02:12 -05:00
C++, initial enum support (see #772)
This commit is contained in:
1 parent
90c7adba6d
commit
c010b47589
4 files changed
+256
-21
No files matched your search
+31
-2
@@ -520,8 +520,8 @@ The C++ Domain
|
||||
|
||||
The C++ domain (name **cpp**) supports documenting C++ projects.
|
||||
|
||||
The following directives are available. All declarations can start with a visibility statement
|
||||
(``public``, ``private`` or ``protected``).
|
||||
The following directives are available. All declarations except for enumerators
|
||||
can start with a visibility statement (``public``, ``private`` or ``protected``).
|
||||
|
||||
.. rst:directive:: .. cpp:class:: class speicifer
|
||||
|
||||
@@ -578,6 +578,35 @@ The following directives are available. All declarations can start with a visibi
|
||||
|
||||
Declaration of a type alias with unspecified type.
|
||||
|
||||
.. rst:directive:: .. cpp:enum:: enum declaration
|
||||
|
||||
Describe a (scoped) enum, possibly with the underlying type specified. Note that for scoped
|
||||
enums the ``struct``/``class`` keyword must come before the optional visibility specifier.
|
||||
Any enumerators declared inside an unscoped enum will be declared both in the enum scope
|
||||
and in the parent scope.
|
||||
Examples:
|
||||
|
||||
.. cpp:enum:: MyEnum
|
||||
|
||||
An unscoped enum.
|
||||
|
||||
.. cpp:enum:: MySpecificEnum : long
|
||||
|
||||
An unscoped enum with specified underlying type.
|
||||
|
||||
.. cpp:enum:: class MyScopedEnum
|
||||
|
||||
A scoped enum.
|
||||
|
||||
.. cpp:enum:: struct protected MyScopedVisibilityEnum : std::underlying_type<MySpecificEnum>::type
|
||||
|
||||
A scoped enum with non-default visibility, and with a specified underlying type.
|
||||
|
||||
.. rst:directive:: .. cpp:enumerator:: name
|
||||
.. cpp:enumerator:: name = constant
|
||||
|
||||
Describe an enumerator, optionally with its value defined.
|
||||
|
||||
.. rst:directive:: .. cpp:namespace:: namespace
|
||||
|
||||
Select the current namespace for the following objects. Note that the namespace
|
||||
|
||||
Reference in new issue
Block a user