diff --git a/BaseLib/TCLAPCustomOutput.h b/BaseLib/TCLAPCustomOutput.h index 0154040ef28511cdd71d8b0bdd9e70aab817ce63..346d66024d3de604dd36577ea42939c17f74a0b8 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 5691c02b34e5cd8986e21606b0ccb99812139ae2..5e01ab5206501269e0b0fa9ddb0badbc3f6da7be 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 fa166cfcdc880bdb9e9d8672b7cd624f13fff579..92191db2e2ad0b1c42fda36dbd2af9d147407f4b 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 1fc4f8abe69255368b7de16a9eedf601714fbc89..d36d9dc51e3228d675a0f8f30abd356b7f137136 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 fd392232aed793f51969a8706884e960c4c30a5e..4f4582730abf90a7d40807b0d4581b4d27cdb002 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 8c7446fd7a740a0158fcb0ba3d3a54ac52287b1a..b6775ccc54c2101e3b3fe0ca203cc88e0aa34fcc 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 50d56e71161b8b3fc9c876f34e7afeb7a893ba2c..1a35c9792415e92b4f338ae0b917bc62459ed061 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>