doxygen/tests/upstream-test-suite/069_link_variadic_template.cpp

96 lines
2.8 KiB
C++

// objective: test \link command with a variadic template function
// check: 069__link__variadic__template_8cpp.xml
/** \file
*
* @attention
* @parblock
* At the time of writing, the part between \<\> is totally ignored:
* %func<Args...>(Args... args) is interpreted as %func(Args... args).
*
* Beware that a function parameter with either a \& or \* operator,
* e.g. 'const Args&... args', requires \\link and \\ref to specify
* such parameter as verbatim, i.e. 'const Args&... args'. At the
* time of writing, the form %func(const Args&...) will fail, unless
* the function parameter was declared just as 'const Args&...'.
* @endparblock
*
* \link Test::func(int,Args...)const variadic template method\endlink
*
* Links to the variadic template function overloads:
* @li \link func(int,Args&... args) First overload\endlink
* @li \link func(int,Args&&... args) Second overload\endlink
* @li \link func(int,const Args&... args) Third overload\endlink
* @li \link func(int,const Args&&... args) Fourth overload\endlink
* @li \link func(int,Args*... args) Fifth overload\endlink
* @li \link func(int,Args**... args) Sixth overload\endlink
* @li \link func(int,const Args*... args) Seventh overload\endlink
* @li \link func(int,const Args**... args) Eighth overload\endlink
* @li \link func(int,Args...) Ninth overload\endlink
*
* The followings are interpreted the same:
* @li \link func(int,const Args&... args) without template argument\endlink
* @li \link func<Args...>(int,const Args&... args) with template argument\endlink
*
* See the \link Test test\endlink class.
*/
/** A function
*/
void func(int p);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, Args&... args);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, Args&&... args);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, const Args&... args);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, const Args&&... args);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, Args*... args);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, Args**... args);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, const Args*... args);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, const Args**... args);
/** A variadic template function overload
*/
template <typename... Args>
void func(int p, Args... args);
/** A test */
class Test
{
public:
/** A variadic template method
*/
template <typename... Args>
void func(int p, Args... args) const;
};