Docs/Doxybook: Add examples of \param and \tparam to the Doxybook…

… rendering test.
NVIDIA · Feb 25, 2022 · 583ab49 · 583ab49
1 parent 62a4b23
commit 583ab49
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/testing/docs/doxybook_test.h b/testing/docs/doxybook_test.h
@@ -44,6 +44,9 @@ void test_predefined_friend_function();
  *
  *  It does many things.
  *
+ *  \tparam T A template parameter.
+ *  \tparam U Another template parameter.
+ *
  *  \see test_function
  */
 template <typename T, typename U>
@@ -141,6 +144,11 @@ class test_derived_class : test_class<int, double>
 
 /*! \brief \c test_function is a function intended to exercise and test Doxybook
  *  rendering.
+ *
+ *  \tparam T A template parameter.
+ *
+ *  \param a A function parameter.
+ *  \param b A function parameter.
  */
 template <typename T>
 void test_function(T const& a, test_class<T, T const>&& b);