From: Martin Kronbichler <kronbichler@lnm.mw.tum.de>
Date: Tue, 24 Apr 2018 13:24:46 +0000 (+0200)
Subject: Link main matrix-free objects and data structures to module.
X-Git-Tag: v9.0.0-rc1~112^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7e33c634426b1d1c866630b055f1d8e0b783df3b;p=dealii.git

Link main matrix-free objects and data structures to module.
---

diff --git a/include/deal.II/matrix_free/dof_info.h b/include/deal.II/matrix_free/dof_info.h
index 15a40be997..0850de5911 100644
--- a/include/deal.II/matrix_free/dof_info.h
+++ b/include/deal.II/matrix_free/dof_info.h
@@ -54,6 +54,8 @@ namespace internal
      * hanging nodes are the same and need to be stored only once. The
      * combination will be handled in the MatrixFree class.
      *
+     * @ingroup matrixfree
+     *
      * @author Katharina Kormann and Martin Kronbichler, 2010, 2011
      */
     struct DoFInfo
diff --git a/include/deal.II/matrix_free/fe_evaluation.h b/include/deal.II/matrix_free/fe_evaluation.h
index 6057a82aaf..b1b37793b9 100644
--- a/include/deal.II/matrix_free/fe_evaluation.h
+++ b/include/deal.II/matrix_free/fe_evaluation.h
@@ -67,14 +67,16 @@ template <int dim, int fe_degree, int n_q_points_1d = fe_degree+1,
  *
  * This class has three template arguments:
  *
- * @param dim Dimension in which this class is to be used
+ * @tparam dim Dimension in which this class is to be used
  *
- * @param n_components Number of vector components when solving a system of
+ * @tparam n_components Number of vector components when solving a system of
  * PDEs. If the same operation is applied to several components of a PDE (e.g.
  * a vector Laplace equation), they can be applied simultaneously with one
  * call (and often more efficiently)
  *
- * @param Number Number format, usually @p double or @p float
+ * @tparam Number Number format, usually @p double or @p float
+ *
+ * @ingroup matrixfree
  *
  * @author Katharina Kormann and Martin Kronbichler, 2010, 2011
  */
@@ -944,6 +946,8 @@ private:
  * Generic access is achieved through the base class, and specializations for
  * scalar and vector-valued elements are defined separately.
  *
+ * @ingroup matrixfree
+ *
  * @author Katharina Kormann and Martin Kronbichler, 2010, 2011
  */
 template <int dim, int n_components_, typename Number>
@@ -1003,6 +1007,8 @@ protected:
  * data fields, i.e., scalars for the values and Tensor<1,dim> for the
  * gradients.
  *
+ * @ingroup matrixfree
+ *
  * @author Katharina Kormann and Martin Kronbichler, 2010, 2011
  */
 template <int dim, typename Number>
@@ -1105,6 +1111,8 @@ protected:
  * type Tensor<2,dim>. Provides some additional functions for access, like the
  * symmetric gradient and divergence.
  *
+ * @ingroup matrixfree
+ *
  * @author Katharina Kormann and Martin Kronbichler, 2010, 2011
  */
 template <int dim, typename Number>
@@ -1242,6 +1250,8 @@ protected:
  * simple data fields, i.e., scalars for the values and Tensor<1,1> for the
  * gradients.
  *
+ * @ingroup matrixfree
+ *
  * @author Katharina Kormann and Martin Kronbichler, 2010, 2011, Shiva
  * Rudraraju, 2014
  */
@@ -1878,6 +1888,8 @@ protected:
  * @tparam Number Number format, usually @p double or @p float. Defaults to @p
  * double
  *
+ * @ingroup matrixfree
+ *
  * @author Katharina Kormann and Martin Kronbichler, 2010, 2011
  */
 template <int dim, int fe_degree, int n_q_points_1d, int n_components_,
diff --git a/include/deal.II/matrix_free/mapping_info.h b/include/deal.II/matrix_free/mapping_info.h
index 37bc22c860..5435b18daf 100644
--- a/include/deal.II/matrix_free/mapping_info.h
+++ b/include/deal.II/matrix_free/mapping_info.h
@@ -41,6 +41,8 @@ namespace internal
      * An enum to identify various types of cells and faces. The most general
      * type is what we typically compute in the FEValues context but for many
      * geometries we can save significant storage.
+     *
+     * @ingroup matrixfree
      */
     enum GeometryType : unsigned char
     {
@@ -96,6 +98,8 @@ namespace internal
      * data. The latter comes in a vector for the support of hp adaptivity,
      * with several data fields for the individual quadrature formulas.
      *
+     * @ingroup matrixfree
+     *
      * @author Katharina Kormann, Martin Kronbichler, 2018
      */
     template <int structdim, int spacedim, typename Number>
@@ -270,6 +274,8 @@ namespace internal
      * The class that stores all geometry-dependent data related with cell
      * interiors for use in the matrix-free class.
      *
+     * @ingroup matrixfree
+     *
      * @author Katharina Kormann and Martin Kronbichler, 2010, 2011, 2017
      */
     template <int dim, typename Number>
diff --git a/include/deal.II/matrix_free/matrix_free.h b/include/deal.II/matrix_free/matrix_free.h
index 9d3abe222a..9169f7b749 100644
--- a/include/deal.II/matrix_free/matrix_free.h
+++ b/include/deal.II/matrix_free/matrix_free.h
@@ -95,6 +95,8 @@ DEAL_II_NAMESPACE_OPEN
  *
  * For details on usage of this class, see the description of FEEvaluation.
  *
+ * @ingroup matrixfree
+ *
  * @author Katharina Kormann, Martin Kronbichler, 2010, 2011
  */
 
diff --git a/include/deal.II/matrix_free/shape_info.h b/include/deal.II/matrix_free/shape_info.h
index 582617a8ac..a6e591211a 100644
--- a/include/deal.II/matrix_free/shape_info.h
+++ b/include/deal.II/matrix_free/shape_info.h
@@ -81,6 +81,8 @@ namespace internal
      * quadrature formula on the unit cell. Because of this structure, only
      * one-dimensional data is stored.
      *
+     * @ingroup matrixfree
+     *
      * @author Katharina Kormann and Martin Kronbichler, 2010, 2011
      */
     template <typename Number>