From 11bfdbc16c4ba394d7f7194ae159862c954b5cca Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <dmitri.naumov@ufz.de>
Date: Fri, 4 Mar 2016 12:34:20 +0100
Subject: [PATCH] Fix some of doxygen warnings.
Mainly correct variable names in the documentation.
Remove some documentation for non-existing parameters.
---
MathLib/LinAlg/VectorNorms.h | 12 ++++++------
NumLib/Fem/Integration/IntegrationGaussPrism.h | 2 +-
NumLib/Fem/Integration/IntegrationGaussPyramid.h | 2 +-
NumLib/Fem/Integration/IntegrationGaussTet.h | 2 +-
NumLib/Fem/Integration/IntegrationGaussTri.h | 2 +-
NumLib/Fem/Integration/IntegrationPoint.h | 2 +-
NumLib/ODESolver/MatrixTranslator.h | 3 ---
7 files changed, 11 insertions(+), 14 deletions(-)
diff --git a/MathLib/LinAlg/VectorNorms.h b/MathLib/LinAlg/VectorNorms.h
index 1911c3553c8..eabf61e1bce 100644
--- a/MathLib/LinAlg/VectorNorms.h
+++ b/MathLib/LinAlg/VectorNorms.h
@@ -73,19 +73,19 @@ inline T norm_max(T const * const v, std::size_t n)
// ----------------------------------------------------------------------------
/// return L1 norm \f$ \|x\|_1 = \sum_{i=1}^n |x_i| \f$
-/// \tparam T Vector type
+/// \tparam T_VEC Vector type
/// \param v a vector object
template<class T_VEC>
inline double norm_1(const T_VEC &v) { return MathLib::norm_1(&v[0], v.size()); }
/// return L2 norm (Euclidean norm) \f$ \|x\|_2 = \sqrt{\sum_{i=1}^n x_i^2} \f$
-/// \tparam T Vector type
+/// \tparam T_VEC Vector type
/// \param v a vector object
template<class T_VEC>
inline double norm_2(const T_VEC &v) { return MathLib::norm_2(&v[0], v.size()); }
/// return maximum norm \f$ \|x\|_\infty = \max(|x_1|, ..., |x_n|) \f$
-/// \tparam T Vector type
+/// \tparam T_VEC Vector type
/// \param v a vector object
template<class T_VEC>
inline double norm_max(const T_VEC &v) { return MathLib::norm_max(&v[0], v.size()); }
@@ -108,9 +108,9 @@ inline double norm_max(const double &v) { return norm_1(v); }
/**
* return norm
*
- * \tparam T vector type
- * \tparam v a vector object
- * \tparam normType norm type (default 2-norm)
+ * \tparam T_VEC vector type
+ * \param v a vector object
+ * \param normType norm type (default 2-norm)
* \return calculated norm. If the give norm type is invalid, a negative value is returned.
*/
template<class T_VEC>
diff --git a/NumLib/Fem/Integration/IntegrationGaussPrism.h b/NumLib/Fem/Integration/IntegrationGaussPrism.h
index abdae734f25..23dbcb4d221 100644
--- a/NumLib/Fem/Integration/IntegrationGaussPrism.h
+++ b/NumLib/Fem/Integration/IntegrationGaussPrism.h
@@ -63,7 +63,7 @@ public:
* get coordinates of a integration point
*
* @param order the number of integration points
- * @param pt_id the sampling point id
+ * @param ipg the sampling point id
* @return weight
*/
static WeightedPoint
diff --git a/NumLib/Fem/Integration/IntegrationGaussPyramid.h b/NumLib/Fem/Integration/IntegrationGaussPyramid.h
index 083e379e78f..7005b0d68ad 100644
--- a/NumLib/Fem/Integration/IntegrationGaussPyramid.h
+++ b/NumLib/Fem/Integration/IntegrationGaussPyramid.h
@@ -62,7 +62,7 @@ public:
* get coordinates of a integration point
*
* @param order the number of integration points
- * @param pt_id the sampling point id
+ * @param igp the sampling point id
* @return weight
*/
static WeightedPoint
diff --git a/NumLib/Fem/Integration/IntegrationGaussTet.h b/NumLib/Fem/Integration/IntegrationGaussTet.h
index de5acabace5..cb959ba70ae 100644
--- a/NumLib/Fem/Integration/IntegrationGaussTet.h
+++ b/NumLib/Fem/Integration/IntegrationGaussTet.h
@@ -62,7 +62,7 @@ public:
* get coordinates of a integration point
*
* @param order the number of integration points
- * @param pt_id the sampling point id
+ * @param igp the sampling point id
* @return weight
*/
static WeightedPoint
diff --git a/NumLib/Fem/Integration/IntegrationGaussTri.h b/NumLib/Fem/Integration/IntegrationGaussTri.h
index 74b756635ec..9f6b587227f 100644
--- a/NumLib/Fem/Integration/IntegrationGaussTri.h
+++ b/NumLib/Fem/Integration/IntegrationGaussTri.h
@@ -78,7 +78,7 @@ public:
* get coordinates of a integration point
*
* @param order the number of integration points
- * @param pt_id the sampling point id
+ * @param igp the sampling point id
* @return weight
*/
static WeightedPoint
diff --git a/NumLib/Fem/Integration/IntegrationPoint.h b/NumLib/Fem/Integration/IntegrationPoint.h
index 8523e7d003c..99c54c81f3d 100644
--- a/NumLib/Fem/Integration/IntegrationPoint.h
+++ b/NumLib/Fem/Integration/IntegrationPoint.h
@@ -55,7 +55,7 @@ public:
/// Get coordinates of a integration point.
///
/// \param order the number of integration points.
- /// \param pt_id the sampling point id.
+ /// \param igp the sampling point id.
/// \return weight
static WeightedPoint getWeightedPoint(std::size_t /* order */,
std::size_t /*igp*/)
diff --git a/NumLib/ODESolver/MatrixTranslator.h b/NumLib/ODESolver/MatrixTranslator.h
index 76970880311..6fa7669d887 100644
--- a/NumLib/ODESolver/MatrixTranslator.h
+++ b/NumLib/ODESolver/MatrixTranslator.h
@@ -95,7 +95,6 @@ class MatrixTranslatorGeneral;
*
* \tparam Matrix the type of matrices occuring in the linearization of the equation.
* \tparam Vector the type of the solution vector of the equation
- * \tparam ODETag a tag indicating the type of equation.
*
* \see ODESystemTag::FirstOrderImplicitQuasilinear
* \remark
@@ -188,7 +187,6 @@ class MatrixTranslatorForwardEuler;
*
* \tparam Matrix the type of matrices occuring in the linearization of the equation.
* \tparam Vector the type of the solution vector of the equation
- * \tparam ODETag a tag indicating the type of equation.
*
* \see ODESystemTag::FirstOrderImplicitQuasilinear
* \remark
@@ -284,7 +282,6 @@ class MatrixTranslatorCrankNicolson;
*
* \tparam Matrix the type of matrices occuring in the linearization of the equation.
* \tparam Vector the type of the solution vector of the equation
- * \tparam ODETag a tag indicating the type of equation.
*
* \see ODESystemTag::FirstOrderImplicitQuasilinear
* \remark
--
GitLab