]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add missing '@ingroup functions' annotations. 7919/head
authorDavid Wells <drwells@email.unc.edu>
Sat, 13 Apr 2019 02:42:36 +0000 (22:42 -0400)
committerDavid Wells <drwells@email.unc.edu>
Sat, 13 Apr 2019 02:42:36 +0000 (22:42 -0400)
include/deal.II/base/function.h
include/deal.II/base/function_bessel.h
include/deal.II/base/function_cspline.h
include/deal.II/base/function_lib.h
include/deal.II/base/function_spherical.h

index cb57894409595e67beeb9a341c81aeb869f0c168..49c42d623b8ab30f8f690e187718f42178f2bbf8 100644 (file)
@@ -704,6 +704,7 @@ protected:
  * @endcode
  * The savings in work to write this are apparent.
  *
+ * @ingroup functions
  * @author Wolfgang Bangerth, 2011
  */
 template <int dim, typename RangeNumberType = double>
@@ -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 <int dim, typename RangeNumberType = double>
@@ -858,6 +860,7 @@ private:
  * where the <code>dim</code> components of the tensor function are placed
  * into the first <code>dim</code> components of the function object.
  *
+ * @ingroup functions
  * @author Spencer Patty, 2013
  */
 template <int dim, typename RangeNumberType = double>
index eb8824b6816db64b36ba34289c4ab59aabaf5a94..6597f0a69fae51b90fc6f0b04c0848d7fd6bf5a8 100644 (file)
@@ -29,6 +29,7 @@ namespace Functions
   /**
    * The Bessel functions of first kind or positive integer order.
    *
+   * @ingroup functions
    * @author Guido Kanschat
    * @date 2010
    */
index 2442827db7fda33085f43595d8c0867a69d1913d..9d6d99ce0d058c4f239e6ba905d8f818c90d06d0 100644 (file)
@@ -68,6 +68,7 @@ namespace Functions
    *
    * @note This function is only implemented for dim==1 .
    *
+   * @ingroup functions
    * @author Denis Davydov
    * @date 2016
    */
index 30a49f3d048110efe3a28b9b231881165c63b920..665cef4b3c8db4e4d3987e54aba66b77df78449e 100644 (file)
@@ -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 <int dim>
@@ -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 <int dim>
@@ -1320,6 +1322,7 @@ namespace Functions
    *
    * @note The use of this class is discussed in step-53.
    *
+   * @ingroup functions
    * @author Wolfgang Bangerth, 2013
    */
   template <int dim>
@@ -1386,6 +1389,7 @@ namespace Functions
    * takes a Table<2,double> to describe the set of exponents and a
    * Vector<double> to describe the set of coefficients.
    *
+   * @ingroup functions
    * @author Ángel Rodríguez, 2015
    */
   template <int dim>
index 9c1b9ee7d21a9a47aa69cb86c3c3dbf82cf23f3c..9a78f60f044418bc711137393944f540d3324c37 100644 (file)
@@ -38,6 +38,7 @@ namespace Functions
    *
    * @note This function is currently only implemented for dim==3 .
    *
+   * @ingroup functions
    * @author Denis Davydov, 2017
    */
   template <int dim>

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.