testing/070/070__ref__variadic__template_8cpp.xml

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