You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/templates/class_api.rst
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,24 +49,20 @@ Interface
49
49
Template parameters (if applicable)
50
50
Omit template parameters that are just used for specialization/are deduced/ and/or should not be exposed to the user.
51
51
52
-
.. rubric:: Template Parameters
53
-
54
52
:tparam Foo: Description of the Foo template parameter
55
53
56
54
..
57
55
Parameters (if applicable)
58
56
59
-
.. rubric:: Parameters
60
-
61
57
:param bar: Description of the bar parameter
62
58
63
-
.. rubric:: Public Types
59
+
.. rubric:: Public Types:
64
60
65
61
.. cpp:type:: data_type
66
62
67
63
Some interesting description of the type and how to use it.
68
64
69
-
.. rubric:: Static Public Member Variables
65
+
.. rubric:: Static Public Member Variables:
70
66
71
67
.. cpp:member::int some_var = 5;
72
68
@@ -82,7 +78,7 @@ Interface
82
78
83
79
The :cpp:func:`frobrnicator` free function.
84
80
85
-
.. rubric:: Constructors
81
+
.. rubric:: Constructors:
86
82
87
83
.. cpp:function:: CoolerView(CoolerView&& rhs)
88
84
@@ -92,13 +88,13 @@ Interface
92
88
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
93
89
clean up or destroy their members don't need this member documented.
94
90
95
-
.. rubric:: Destructor
91
+
.. rubric:: Destructor:
96
92
97
93
.. cpp:function::~CoolerView()
98
94
99
95
Performs some special operation when destroyed.
100
96
101
-
.. rubric:: Public Member Functions
97
+
.. rubric:: Public Member Functions:
102
98
103
99
.. cpp:function::template<classU> foo(U x)
104
100
@@ -145,7 +141,7 @@ Non-Member Functions
145
141
146
142
:tparam ViewDst: the other
147
143
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.
0 commit comments