summaryrefslogtreecommitdiffstats
path: root/testing/070/070__ref__variadic__template_8cpp.xml
blob: 0f581e5550c758f2adbbc44efdf04f30eeebf15f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="">
  <compounddef id="070__ref__variadic__template_8cpp" kind="file" language="C++">
    <compoundname>070_ref_variadic_template.cpp</compoundname>
    <innerclass refid="class_test" prot="public">Test</innerclass>
    <sectiondef kind="func">
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1affb6da6cff1b57cdf8efc0123dceac9b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A function </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="40" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1aa7e4936a17759246bce60256cf224e16" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, Args &amp;... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>Args &amp;...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="45" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1ad6fc2d2a6cb8980f3e0eaacbd2ae41fe" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, Args &amp;&amp;... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>Args &amp;&amp;...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="50" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1a708a5bf22646ed7233fe61b83182811a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, const Args &amp;... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>const Args &amp;...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="55" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1aed64c596fea5f4f5e719006539922f7c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, const Args &amp;&amp;... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>const Args &amp;&amp;...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="60" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1a0ad18d95a1dc2dbacee657c43f719187" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, Args *... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>Args *...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="65" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1a2331eedd0a1db9da5de0ad0faef78a4e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, Args **... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>Args **...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="70" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1a72bd94e61df947347f98a2a6214e9342" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, const Args *... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>const Args *...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="75" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1a0bd03c39aa36ae51d2b8d87e04cf7eab" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, const Args **... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>const Args **...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="80" column="1"/>
      </memberdef>
      <memberdef kind="function" id="070__ref__variadic__template_8cpp_1abb1e0338f72ae46a1240ada65d6a397c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <templateparamlist>
          <param>
            <type>typename...</type>
            <declname>Args</declname>
            <defname>Args</defname>
          </param>
        </templateparamlist>
        <type>void</type>
        <definition>void func</definition>
        <argsstring>(int p, Args... args)</argsstring>
        <name>func</name>
        <param>
          <type>int</type>
          <declname>p</declname>
        </param>
        <param>
          <type>Args...</type>
          <declname>args</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
          <para>A variadic template function overload </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="070_ref_variadic_template.cpp" line="85" column="1"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
      <para>
        <simplesect kind="attention">
          <para>
            <parblock>
              <para>At the time of writing, the part between &lt;&gt; is totally ignored: func&lt;Args...&gt;(Args... args) is interpreted as func(Args... args).</para>
              <para>Beware that a function parameter with either a &amp; or * operator, e.g. 'const Args&amp;... args', requires \link and \ref to specify such parameter as verbatim, i.e. 'const Args&amp;... args'. At the time of writing, the form func(const Args&amp;...) will fail, unless the function parameter was declared just as 'const Args&amp;...'. </para>
            </parblock>
          </para>
        </simplesect>
      </para>
      <para>
        <ref refid="class_test_1a64d85df31d518e39726467315a9b05e3" kindref="member">variadic template method</ref>
      </para>
      <para>References to the variadic template function overloads: <itemizedlist><listitem><para><ref refid="070__ref__variadic__template_8cpp_1aa7e4936a17759246bce60256cf224e16" kindref="member">First overload</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1ad6fc2d2a6cb8980f3e0eaacbd2ae41fe" kindref="member">Second overload</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1a708a5bf22646ed7233fe61b83182811a" kindref="member">Third overload</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1aed64c596fea5f4f5e719006539922f7c" kindref="member">Fourth overload</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1a0ad18d95a1dc2dbacee657c43f719187" kindref="member">Fifth overload</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1a2331eedd0a1db9da5de0ad0faef78a4e" kindref="member">Sixth overload</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1a72bd94e61df947347f98a2a6214e9342" kindref="member">Seventh overload</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1a0bd03c39aa36ae51d2b8d87e04cf7eab" kindref="member">Eighth overload</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1abb1e0338f72ae46a1240ada65d6a397c" kindref="member">Ninth overload</ref></para></listitem></itemizedlist>
The followings are interpreted the same: <itemizedlist><listitem><para><ref refid="070__ref__variadic__template_8cpp_1a708a5bf22646ed7233fe61b83182811a" kindref="member">without template argument</ref></para></listitem><listitem><para><ref refid="070__ref__variadic__template_8cpp_1a708a5bf22646ed7233fe61b83182811a" kindref="member">with template argument</ref></para></listitem></itemizedlist>
See the <ref refid="class_test" kindref="compound">test</ref> class. </para>
    </detaileddescription>
    <location file="070_ref_variadic_template.cpp"/>
  </compounddef>
</doxygen>