From f38429d6c840d3c35596f959b7338b0187ebd577 Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <dmitri.naumov@ufz.de>
Date: Fri, 23 Aug 2019 13:34:03 +0200
Subject: [PATCH] Fix parameter documentation errors from #2623.
---
BaseLib/TCLAPCustomOutput.h | 9 ++++-----
GeoLib/Grid.h | 16 +++++++++-------
MathLib/LinAlg/PETSc/PETScMatrix.h | 15 +++++----------
NumLib/Fem/ShapeFunction/ShapePrism15.h | 4 ++--
NumLib/Fem/ShapeFunction/ShapePrism6.h | 4 ++--
NumLib/Fem/ShapeFunction/ShapePyra13.h | 4 ++--
NumLib/Fem/ShapeFunction/ShapePyra5.h | 4 ++--
7 files changed, 26 insertions(+), 30 deletions(-)
diff --git a/BaseLib/TCLAPCustomOutput.h b/BaseLib/TCLAPCustomOutput.h
index 0154040ef28..346d66024d3 100644
--- a/BaseLib/TCLAPCustomOutput.h
+++ b/BaseLib/TCLAPCustomOutput.h
@@ -33,23 +33,22 @@ public:
/**
* Prints the usage to stdout. Can be overridden to
* produce alternative behavior.
- * \param c - The CmdLine object the output is generated for.
+ * \param _cmd - The CmdLine object the output is generated for.
*/
virtual void usage(TCLAP::CmdLineInterface& _cmd);
/**
* Prints (to stderr) an error message, short usage
* Can be overridden to produce alternative behavior.
- * \param c - The CmdLine object the output is generated for.
+ * \param _cmd - The CmdLine object the output is generated for.
* \param e - The ArgException that caused the failure.
*/
virtual void failure(TCLAP::CmdLineInterface& _cmd, TCLAP::ArgException& e);
protected:
-
/**
* Writes a brief usage message with short args.
- * \param c - The CmdLine object the output is generated for.
+ * \param _cmd - The CmdLine object the output is generated for.
* \param os - The stream to write the message to.
*/
void _shortUsage(TCLAP::CmdLineInterface& _cmd, std::ostream& os) const;
@@ -57,7 +56,7 @@ protected:
/**
* Writes a longer usage message with long and short args,
* provides descriptions and prints message.
- * \param c - The CmdLine object the output is generated for.
+ * \param _cmd - The CmdLine object the output is generated for.
* \param os - The stream to write the message to.
*/
void _longUsage(TCLAP::CmdLineInterface& _cmd, std::ostream& os) const;
diff --git a/GeoLib/Grid.h b/GeoLib/Grid.h
index 5691c02b34e..5e01ab52065 100644
--- a/GeoLib/Grid.h
+++ b/GeoLib/Grid.h
@@ -34,18 +34,20 @@ class Grid : public GeoLib::AABB
{
public:
/**
- * @brief The constructor of the grid object takes a vector of points or nodes. Furthermore the
- * user can specify the *average* maximum number of points per grid cell.
+ * @brief The constructor of the grid object takes a vector of points or
+ * nodes. Furthermore the user can specify the *average* maximum number of
+ * points per grid cell.
*
* The number of grid cells are computed with the following formula
* \f$\frac{n_{points}}{n_{cells}} \le n_{max\_per\_cell}\f$
*
- * In order to limit the memory wasting the maximum number of points per grid cell
- * (in the average) should be a power of two (since std::vector objects resize itself
- * with this step size).
+ * In order to limit the memory wasting the maximum number of points per
+ * grid cell (in the average) should be a power of two (since std::vector
+ * objects resize itself with this step size).
*
* @param first, last the range of elements to examine
- * @param items_per_cell (input) max number per grid cell in the average (default 512)
+ * @param max_num_per_grid_cell (input) max number per grid cell in the
+ * average
*
*/
template <typename InputIterator>
@@ -160,7 +162,7 @@ private:
* 4 3,0,4,7 left
* 5 4,5,6,7 top
* @param pnt (input) coordinates of the point
- * @param coordinates of the grid cell
+ * @param coords of the grid cell
* @return squared distances of the point to the faces of the grid cell
* ordered in the same sequence as above described
*/
diff --git a/MathLib/LinAlg/PETSc/PETScMatrix.h b/MathLib/LinAlg/PETSc/PETScMatrix.h
index fa166cfcdc8..92191db2e2a 100644
--- a/MathLib/LinAlg/PETSc/PETScMatrix.h
+++ b/MathLib/LinAlg/PETSc/PETScMatrix.h
@@ -166,10 +166,11 @@ public:
}
/*!
- \brief Add a submatrix to this.
- \param row_pos The row indices of the entries of the submatrix.
- \param col_pos The column indices of the entries of the submatrix.
- \param sub_mat A dense matrix to be added on.
+ \brief Add a dense sub-matrix to a PETSc matrix.
+ \param row_pos The global indices of the rows of the dense sub-matrix.
+ \param col_pos The global indices of the colums of the dense
+ sub-matrix.
+ \param sub_mat A dense sub-matrix to be added.
*/
template <class T_DENSE_MATRIX>
void add(std::vector<PetscInt> const& row_pos,
@@ -251,12 +252,6 @@ private:
const MatAssemblyType asm_type);
};
-/*!
- \brief Add a dense sub-matrix to a PETSc matrix.
- \param row_pos The global indices of the rows of the dense sub-matrix.
- \param col_pos The global indices of the colums of the dense sub-matrix.
- \param sub_mat A dense sub-matrix to be added.
-*/
template <class T_DENSE_MATRIX>
void PETScMatrix::add(std::vector<PetscInt> const& row_pos,
std::vector<PetscInt> const& col_pos,
diff --git a/NumLib/Fem/ShapeFunction/ShapePrism15.h b/NumLib/Fem/ShapeFunction/ShapePrism15.h
index 1fc4f8abe69..d36d9dc51e3 100644
--- a/NumLib/Fem/ShapeFunction/ShapePrism15.h
+++ b/NumLib/Fem/ShapeFunction/ShapePrism15.h
@@ -24,7 +24,7 @@ public:
/**
* Evaluate the shape function at the given point
*
- * @param [in] r natural coordinates (r,s,t)
+ * @param [in] x natural coordinates (r,s,t)
* @param [out] N a vector of calculated shape functions
*/
template <class T_X, class T_N>
@@ -33,7 +33,7 @@ public:
/**
* Evaluate derivatives of the shape function at the given point
*
- * @param [in] r natural coordinates (r,s,t)
+ * @param [in] x natural coordinates (r,s,t)
* @param [out] dN a matrix of the derivatives
*/
template <class T_X, class T_N>
diff --git a/NumLib/Fem/ShapeFunction/ShapePrism6.h b/NumLib/Fem/ShapeFunction/ShapePrism6.h
index fd392232aed..4f4582730ab 100644
--- a/NumLib/Fem/ShapeFunction/ShapePrism6.h
+++ b/NumLib/Fem/ShapeFunction/ShapePrism6.h
@@ -24,7 +24,7 @@ public:
/**
* Evaluate the shape function at the given point
*
- * @param [in] r natural coordinates (r,s,t)
+ * @param [in] x natural coordinates (r,s,t)
* @param [out] N a vector of calculated shape functions
*/
template <class T_X, class T_N>
@@ -33,7 +33,7 @@ public:
/**
* Evaluate derivatives of the shape function at the given point
*
- * @param [in] r natural coordinates (r,s,t)
+ * @param [in] x natural coordinates (r,s,t)
* @param [out] dN a matrix of the derivatives
*/
template <class T_X, class T_N>
diff --git a/NumLib/Fem/ShapeFunction/ShapePyra13.h b/NumLib/Fem/ShapeFunction/ShapePyra13.h
index 8c7446fd7a7..b6775ccc54c 100644
--- a/NumLib/Fem/ShapeFunction/ShapePyra13.h
+++ b/NumLib/Fem/ShapeFunction/ShapePyra13.h
@@ -24,7 +24,7 @@ public:
/**
* Evaluate the shape function at the given point
*
- * @param [in] r natural coordinates (r,s,t)
+ * @param [in] x natural coordinates (r,s,t)
* @param [out] N a vector of calculated shape functions
*/
template <class T_X, class T_N>
@@ -33,7 +33,7 @@ public:
/**
* Evaluate derivatives of the shape function at the given point
*
- * @param [in] r natural coordinates (r,s,t)
+ * @param [in] x natural coordinates (r,s,t)
* @param [out] dN a matrix of the derivatives
*/
template <class T_X, class T_N>
diff --git a/NumLib/Fem/ShapeFunction/ShapePyra5.h b/NumLib/Fem/ShapeFunction/ShapePyra5.h
index 50d56e71161..1a35c979241 100644
--- a/NumLib/Fem/ShapeFunction/ShapePyra5.h
+++ b/NumLib/Fem/ShapeFunction/ShapePyra5.h
@@ -24,7 +24,7 @@ public:
/**
* Evaluate the shape function at the given point
*
- * @param [in] r natural coordinates (r,s,t)
+ * @param [in] x natural coordinates (r,s,t)
* @param [out] N a vector of calculated shape functions
*/
template <class T_X, class T_N>
@@ -33,7 +33,7 @@ public:
/**
* Evaluate derivatives of the shape function at the given point
*
- * @param [in] r natural coordinates (r,s,t)
+ * @param [in] x natural coordinates (r,s,t)
* @param [out] dN a matrix of the derivatives
*/
template <class T_X, class T_N>
--
GitLab