Skip to content

Commit 7d71449

Browse files
committed
update class api template to not improperly reference view
1 parent d876be0 commit 7d71449

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

docs/source/templates/class_api.rst

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,20 @@ Interface
4949
Template parameters (if applicable)
5050
Omit template parameters that are just used for specialization/are deduced/ and/or should not be exposed to the user.
5151
52-
.. rubric:: Template Parameters
53-
5452
:tparam Foo: Description of the Foo template parameter
5553

5654
..
5755
Parameters (if applicable)
5856
59-
.. rubric:: Parameters
60-
6157
:param bar: Description of the bar parameter
6258

63-
.. rubric:: Public Types
59+
.. rubric:: Public Types:
6460

6561
.. cpp:type:: data_type
6662

6763
Some interesting description of the type and how to use it.
6864

69-
.. rubric:: Static Public Member Variables
65+
.. rubric:: Static Public Member Variables:
7066

7167
.. cpp:member:: int some_var = 5;
7268

@@ -82,7 +78,7 @@ Interface
8278
8379
The :cpp:func:`frobrnicator` free function.
8480

85-
.. rubric:: Constructors
81+
.. rubric:: Constructors:
8682

8783
.. cpp:function:: CoolerView(CoolerView&& rhs)
8884

@@ -92,13 +88,13 @@ Interface
9288
Only include the destructor if it does something interesting as part of the API, such as RAII classes that release a resource on their destructor. Classes that merely
9389
clean up or destroy their members don't need this member documented.
9490
95-
.. rubric:: Destructor
91+
.. rubric:: Destructor:
9692

9793
.. cpp:function:: ~CoolerView()
9894

9995
Performs some special operation when destroyed.
10096

101-
.. rubric:: Public Member Functions
97+
.. rubric:: Public Member Functions:
10298

10399
.. cpp:function:: template<class U> foo(U x)
104100

@@ -145,7 +141,7 @@ Non-Member Functions
145141

146142
:tparam ViewDst: the other
147143

148-
:return: true if :cpp:type:`View::value_type`, :cpp:type:`View::array_layout`, :cpp:type:`View::memory_space`, :cpp:member:`View::rank`, :cpp:func:`View::data()` and :cpp:expr:`View::extent(r)`, for :cpp:expr:`0<=r<rank`, match.
144+
:return: true if :cpp:type:`View::value_type`, :cpp:type:`View::array_layout`, :cpp:type:`View::memory_space`, :cpp:member:`View::func`, :cpp:func:`View::data()` and :cpp:expr:`View::extent(r)`, for :cpp:expr:`0<=r<rank`, match.
149145

150146
.. cpp:function:: void frobrnicator(CoolerView &v) noexcept
151147

0 commit comments

Comments
 (0)