IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc, update C++ domain.

Browse Source
This commit is contained in:
Jakob Lykke Andersen 2014-07-27 11:42:01 +02:00
parent 23df17b404
commit c19a15ea0d
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/domains.rst
View File

@ -536,7 +536,7 @@ The following directives are available:
.. cpp:function:: bool namespaced::theclass::method(arg1, arg2)
Describes a method without types.
Describes a method with unnamed parameters.
.. cpp:function:: const T &array<T>::operator[]() const
@ -554,8 +554,14 @@ The following directives are available:
.. cpp:member:: std::string theclass::name[N][M]
.. cpp::type:: std::vector<int> MyList
A typedef-like declaration of a type.
.. cpp:type:: theclass::const_iterator
Declaration of a type alias with unspecified type.
Will be rendered like this:
.. cpp:function:: bool namespaced::theclass::method(int arg1, std::string arg2)
@ -564,7 +570,7 @@ The following directives are available:
.. cpp:function:: bool namespaced::theclass::method(arg1, arg2)
Describes a method without types.
Describes a method with unnamed parameters.
.. cpp:function:: const T &array<T>::operator[]() const
@ -582,12 +588,19 @@ The following directives are available:
.. cpp:member:: std::string theclass::name[N][M]
.. cpp::type:: std::vector<int> MyList
A typedef-like declaration of a type.
.. cpp:type:: theclass::const_iterator
Declaration of a type alias with unspecified type.
.. rst:directive:: .. cpp:namespace:: namespace
Select the current C++ namespace for the following objects.
Select the current namespace for the following objects. Note that the namespace
does not need to correspond to C++ namespaces, but can end in names of classes.
(e.g., ``Namespace1::Namespace2::SomeClass::AnInnerClass``)
.. _cpp-roles: