From 8cf6bb0e095132f5244630c7d803461e28c2860f Mon Sep 17 00:00:00 2001 From: David Wells Date: Fri, 12 Apr 2019 22:42:36 -0400 Subject: [PATCH] Add missing '@ingroup functions' annotations. --- include/deal.II/base/function.h | 3 +++ include/deal.II/base/function_bessel.h | 1 + include/deal.II/base/function_cspline.h | 1 + include/deal.II/base/function_lib.h | 4 ++++ include/deal.II/base/function_spherical.h | 1 + 5 files changed, 10 insertions(+) diff --git a/include/deal.II/base/function.h b/include/deal.II/base/function.h index cb57894409..49c42d623b 100644 --- a/include/deal.II/base/function.h +++ b/include/deal.II/base/function.h @@ -704,6 +704,7 @@ protected: * @endcode * The savings in work to write this are apparent. * + * @ingroup functions * @author Wolfgang Bangerth, 2011 */ template @@ -770,6 +771,7 @@ private: * obviously easily extended to functions that are non-constant in their one * component. * + * @ingroup functions * @author Wolfgang Bangerth, 2011 */ template @@ -858,6 +860,7 @@ private: * where the dim components of the tensor function are placed * into the first dim components of the function object. * + * @ingroup functions * @author Spencer Patty, 2013 */ template diff --git a/include/deal.II/base/function_bessel.h b/include/deal.II/base/function_bessel.h index eb8824b681..6597f0a69f 100644 --- a/include/deal.II/base/function_bessel.h +++ b/include/deal.II/base/function_bessel.h @@ -29,6 +29,7 @@ namespace Functions /** * The Bessel functions of first kind or positive integer order. * + * @ingroup functions * @author Guido Kanschat * @date 2010 */ diff --git a/include/deal.II/base/function_cspline.h b/include/deal.II/base/function_cspline.h index 2442827db7..9d6d99ce0d 100644 --- a/include/deal.II/base/function_cspline.h +++ b/include/deal.II/base/function_cspline.h @@ -68,6 +68,7 @@ namespace Functions * * @note This function is only implemented for dim==1 . * + * @ingroup functions * @author Denis Davydov * @date 2016 */ diff --git a/include/deal.II/base/function_lib.h b/include/deal.II/base/function_lib.h index 30a49f3d04..665cef4b3c 100644 --- a/include/deal.II/base/function_lib.h +++ b/include/deal.II/base/function_lib.h @@ -1133,6 +1133,7 @@ namespace Functions * exponents are of course equally valid. Exponents can't be real when the * bases are negative numbers. * + * @ingroup functions * @author Wolfgang Bangerth, 2006 */ template @@ -1217,6 +1218,7 @@ namespace Functions * @note The use of the related class InterpolatedUniformGridData is * discussed in step-53. * + * @ingroup functions * @author Wolfgang Bangerth, 2013 */ template @@ -1320,6 +1322,7 @@ namespace Functions * * @note The use of this class is discussed in step-53. * + * @ingroup functions * @author Wolfgang Bangerth, 2013 */ template @@ -1386,6 +1389,7 @@ namespace Functions * takes a Table<2,double> to describe the set of exponents and a * Vector to describe the set of coefficients. * + * @ingroup functions * @author Ángel Rodríguez, 2015 */ template diff --git a/include/deal.II/base/function_spherical.h b/include/deal.II/base/function_spherical.h index 9c1b9ee7d2..9a78f60f04 100644 --- a/include/deal.II/base/function_spherical.h +++ b/include/deal.II/base/function_spherical.h @@ -38,6 +38,7 @@ namespace Functions * * @note This function is currently only implemented for dim==3 . * + * @ingroup functions * @author Denis Davydov, 2017 */ template -- 2.39.5