From 660261f5af67a25e9e4fc8c119df896be80e112f Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Sun, 23 Jul 2017 10:45:04 +0200
Subject: [PATCH] [NL] fixed Doxygen warnings
---
.../ExtrapolatableElementCollection.h | 5 +++++
.../LocalLinearLeastSquaresExtrapolator.h | 18 ++++++++----------
2 files changed, 13 insertions(+), 10 deletions(-)
diff --git a/NumLib/Extrapolation/ExtrapolatableElementCollection.h b/NumLib/Extrapolation/ExtrapolatableElementCollection.h
index ab47613cad5..e2d861360e9 100644
--- a/NumLib/Extrapolation/ExtrapolatableElementCollection.h
+++ b/NumLib/Extrapolation/ExtrapolatableElementCollection.h
@@ -37,6 +37,11 @@ public:
/*! Returns integration point values of some property of a specific element.
*
* \param id ID of the element of which the property is queried.
+ * \param t The time used in the evaluation if time dependent quantities.
+ * \param current_solution The current solution of a ProcessLib::Process;
+ * more generally any nodal GlobalVector.
+ * \param dof_table The processes d.o.f. table used to get each element's
+ * local d.o.f. from \c current_solution.
* \param cache Can be used to compute a property on-the-fly.
*
* \remark
diff --git a/NumLib/Extrapolation/LocalLinearLeastSquaresExtrapolator.h b/NumLib/Extrapolation/LocalLinearLeastSquaresExtrapolator.h
index f1cbb79f266..11727b25e1d 100644
--- a/NumLib/Extrapolation/LocalLinearLeastSquaresExtrapolator.h
+++ b/NumLib/Extrapolation/LocalLinearLeastSquaresExtrapolator.h
@@ -28,12 +28,10 @@ namespace NumLib
* the residuals are computed from the actual interpolation result that is being
* returned by this class.
*
- * Currently this class only supports interpolating single component variables.
- *
- * Furthermore, the number of integration points in each element must be greater
- * than or equal to the number of nodes of that element. This restriction is due to
- * the use of the least squares which requires an exact or overdetermined equation
- * system.
+ * The number of integration points in each element must be greater than or
+ * equal to the number of nodes of that element. This restriction is due
+ * to the use of the least squares which requires an exact or overdetermined
+ * equation system.
* \endparblock
*/
class LocalLinearLeastSquaresExtrapolator : public Extrapolator
@@ -114,12 +112,12 @@ private:
Eigen::MatrixXd A_pinv;
};
- /*! Maps (#nodes, #int_pts) to (N_0, QR decomposition),
+ /*! Maps (\#nodes, \#int_pts) to (N_0, QR decomposition),
* where N_0 is the shape matrix of the first integration point.
*
- * \note It is assumed that the pair (#nodes, #int_pts) uniquely identifies
- * the set of all shape matrices N for a mesh element (i.e., only N, not
- * dN/dx etc.).
+ * \note It is assumed that the pair (\#nodes, \#int_pts) uniquely
+ * identifies the set of all shape matrices N for a mesh element (i.e., only
+ * N, not dN/dx etc.).
*
* \todo Add the element dimension as identifying criterion, or change to
* typeid.
--
GitLab