diff --git a/BaseLib/FileTools.h b/BaseLib/FileTools.h
index 246c0a81c937f6d413db8e3ffc473ee92767831b..acdb194d5d87520beaaa5b0c5ed77755bc1d78bb 100644
--- a/BaseLib/FileTools.h
+++ b/BaseLib/FileTools.h
@@ -30,7 +30,7 @@ bool IsFileExisting(const std::string &strFilename);
/**
* \brief write value as binary into the given output stream
*
- * \param T data type of the value
+ * \tparam T data type of the value
* \param out output stream, have to be opened in binary mode
* \param val value
*/
diff --git a/BaseLib/StringTools.h b/BaseLib/StringTools.h
index 312e4a5ceb1bca558236dfa1172f926897acb7b9..cd1e2fdd6164d97adbdbc8160ed6585f74071d55 100644
--- a/BaseLib/StringTools.h
+++ b/BaseLib/StringTools.h
@@ -28,7 +28,7 @@ namespace BaseLib {
* Splits a string into a list of strings.
* \param str String to be splitted
* \param delim Character indicating that the string should be splitted
- * \return
+ * \return List of strings
*/
std::list<std::string> splitString(const std::string &str, char delim);
diff --git a/BaseLib/quicksort.h b/BaseLib/quicksort.h
index bccebb1fb645ed7e3057c4c1b9c520e2a510010d..e22793523edab1b4ca0f588a520f4dca256e0f8a 100644
--- a/BaseLib/quicksort.h
+++ b/BaseLib/quicksort.h
@@ -59,7 +59,6 @@ void quickSort(T* array, unsigned beg, unsigned end)
* @param beg beginning index in array for sorting
* @param end end-1 is the last index in array for sorting
* @param second_array the second array is permuted according to the sort process of array
- * @return
*/
template <typename T1, typename T2>
std::size_t partition_(T1 *array, std::size_t beg, std::size_t end, T2 *second_array)
diff --git a/GeoLib/AnalyticalGeometry.h b/GeoLib/AnalyticalGeometry.h
index c3c704f5c4ea0707fda65d055dab432d0211498f..97d00a3a48b73eac207ce4da3ccbc42a74690bbf 100644
--- a/GeoLib/AnalyticalGeometry.h
+++ b/GeoLib/AnalyticalGeometry.h
@@ -75,15 +75,13 @@ void rotatePointsToXY(MathLib::Vector3 &plane_normal, std::vector<GeoLib::Point*
* by the points within the vector pnts. See function getNewellPlane() to get the
* "plane normal" of a point set. The method rotates both the plane normal and
* the points. The plane normal is rotated such that it is parallel to the \f$y\f$ axis.
- * @param plane_normal
- * @param pnts
* @sa getNewellPlane()
*/
void rotatePointsToXZ(MathLib::Vector3 &plane_normal, std::vector<GeoLib::Point*> &pnts);
/**
* Method computes the rotation matrix that rotates the given vector parallel to the \f$z\f$ axis.
- * @param vec the (3d) vector that is rotated parallel to the \f$z\f$ axis
+ * @param plane_normal the (3d) vector that is rotated parallel to the \f$z\f$ axis
* @param rot_mat 3x3 rotation matrix
*/
void computeRotationMatrixToXY(MathLib::Vector3 const& plane_normal,
diff --git a/GeoLib/GEOObjects.h b/GeoLib/GEOObjects.h
index 7013ceffae3a1aa0f666965535bb9e9f9eabe23c..c53034667c6e8ca5f4404677bb714e37fae98fad 100644
--- a/GeoLib/GEOObjects.h
+++ b/GeoLib/GEOObjects.h
@@ -280,7 +280,7 @@ private:
* Method merges points from different geometries into one geometry. This
* is a helper method for GEOObjects::mergeGeometries().
* @param geo_names The vector of names of the geometries to merge.
- * @param merged_geo_names The (new) name of the geometry resulting from
+ * @param merged_geo_name The (new) name of the geometry resulting from
* merging.
* @param pnt_offsets offsets in the merged vector storing the points
* @return true, if merging the points succeeded, else false
diff --git a/GeoLib/PointVec.h b/GeoLib/PointVec.h
index a68e4b0a80098ed7889b60ce5d50fc3104de5ab3..ab0176fd9baf44bc17aa04267a2a3496864dcbca 100644
--- a/GeoLib/PointVec.h
+++ b/GeoLib/PointVec.h
@@ -68,7 +68,6 @@ public:
* The size of the axis aligned bounding box multiplied with the value of rel_eps gives the
* real tolerance \f$tol\f$. Two points \f$p_0, p_1 \f$ are identical iff
* \f$|p_1 - p_0| \le tol.\f$
- * @return an object of type PointVec
*/
PointVec (const std::string& name, std::vector<Point*>* points,
std::map<std::string, std::size_t>* name_id_map = NULL,
diff --git a/GeoLib/Polygon.h b/GeoLib/Polygon.h
index 8247e88bd7042ba85fb7f52a5a40be67c4103a2c..7150a714bc2894d036a2942aad226cf314a4a06e 100644
--- a/GeoLib/Polygon.h
+++ b/GeoLib/Polygon.h
@@ -52,16 +52,11 @@ public:
* and assures that the orientation is clock wise.
* @param ply closed Polyline
* @param init if true, check if polyline is closed, calculate bounding box
- * @return
*/
Polygon(const Polyline &ply, bool init = true);
virtual ~Polygon();
- /**
- *
- * @return
- */
bool initialise ();
/**
@@ -82,7 +77,6 @@ public:
/**
* Method checks if all points of the polyline ply are inside of the polygon.
* @param ply the polyline that should be checked
- * @return
*/
bool isPolylineInPolygon (const Polyline& ply) const;
/**
diff --git a/GeoLib/Polyline.h b/GeoLib/Polyline.h
index 07a65e0a3584565cad96b081f68de65845985a79..8b87950eec0427c64214a51ef58bc86a227c763a 100644
--- a/GeoLib/Polyline.h
+++ b/GeoLib/Polyline.h
@@ -69,7 +69,6 @@ public:
/**
* Adds an id of a point at the end of the polyline. The id have to be inside
* the (internal) _ply_pnts vector the polyline is based on.
- * @param pnt_id
*/
virtual void addPoint(std::size_t pnt_id);
diff --git a/GeoLib/PolylineWithSegmentMarker.h b/GeoLib/PolylineWithSegmentMarker.h
index e6ab8a185cf58aa266e4d00d0ff91a4fc6d130ba..0e7cc7a905d800bf5bc9affe882cce5e7eee243d 100644
--- a/GeoLib/PolylineWithSegmentMarker.h
+++ b/GeoLib/PolylineWithSegmentMarker.h
@@ -39,15 +39,14 @@ public:
/**
* Method calls @see Polyline::addPoint() and initializes the mark of the
* corresponding line segment.
- * @param pnt_id @see Polyline::addPoint()
+ * @see Polyline::addPoint()
*/
virtual void addPoint(std::size_t pnt_id);
/**
* Method calls the @see Polyline::insertPoint() and initializes the inserted line segment with the same
* value the previous line segment had.
- * @param pos @see Polyline::insertPoint()
- * @param pnt_id @see Polyline::insertPoint()
+ * @see Polyline::insertPoint()
*/
virtual void insertPoint(std::size_t pos, std::size_t pnt_id);
diff --git a/GeoLib/Raster.h b/GeoLib/Raster.h
index 7c8f19bb7bff05bd75bf26f82c415097380d3527..ff201534db62911fd0ab1b0ea975b7340d8b4a23 100644
--- a/GeoLib/Raster.h
+++ b/GeoLib/Raster.h
@@ -38,8 +38,8 @@ public:
* container.
* @param n_cols number of columns
* @param n_rows number of rows
- * @param xllcorner \f$x\f$ coordinate of lower left point
- * @param yllcorner \f$y\f$ coordinate of lower left point
+ * @param xllcorner the \f$x\f$ coordinate of lower left point
+ * @param yllcorner the \f$y\f$ coordinate of lower left point
* @param cell_size the size of a raster pixel
* @param begin input iterator pointing to the first element of the data
* @param end input iterator pointing to the last element of the data, end have to be reachable from begin
@@ -60,18 +60,15 @@ public:
/**
* get the number of columns for the raster
- * @return
*/
std::size_t getNCols() const { return _n_cols; }
/**
* get the number of rows for the raster
- * @return
*/
std::size_t getNRows() const { return _n_rows; }
/**
* get the distance between raster pixels
- * @return
*/
double getRasterPixelDistance() const { return _cell_size; }
@@ -83,7 +80,6 @@ public:
/**
* Refine the raster using scaling as a refinement parameter.
- * @param scaling
*/
void refineRaster(std::size_t scaling);
@@ -100,10 +96,6 @@ public:
*/
const_iterator end() const { return _raster_data + _n_rows*_n_cols; }
- /**
- * destructor
- * @return
- */
~Raster();
/**
diff --git a/GeoLib/SimplePolygonTree.h b/GeoLib/SimplePolygonTree.h
index 2ff051b17e13e7df4d155c10f0378949db0f429d..f7052683d17790f1134f9e43eca9ebfe2e13b2fe 100644
--- a/GeoLib/SimplePolygonTree.h
+++ b/GeoLib/SimplePolygonTree.h
@@ -66,7 +66,6 @@ private:
/**
* creates from a list of simple polygons a list of trees (SimplePolygonTrees)
- * @param list_of_simple_polygon_trees
*/
template <typename POLYGONTREETYPE>
void createPolygonTrees (std::list<POLYGONTREETYPE*>& list_of_simple_polygon_hierarchies)
diff --git a/GeoLib/Station.h b/GeoLib/Station.h
index 827804542471841ac50c4d2f88d54e29a677dbee..513100ec075344bcd0f681531b10e94b9910cb62 100644
--- a/GeoLib/Station.h
+++ b/GeoLib/Station.h
@@ -98,7 +98,6 @@ public:
/**
* Constructor copies the source object
* @param src the Station object that should be copied
- * @return
*/
Station(Station const& src);
@@ -120,7 +119,6 @@ public:
* \param pname The name of the property.
* \param get A function pointer to a static read function for the variable referred to by pname
* \param set A function pointer to a static write function for the variable referred to by pname
- * \return
*/
void addProperty(std::string pname, double (* get)(void*), void (* set)(void*, double));
diff --git a/GeoLib/TemplateVec.h b/GeoLib/TemplateVec.h
index e79766dd344a0af07703e4fe8faf4e9e1eb9f06a..c7f1afffb62fdde2f979bb89a7e216af822d7edb 100644
--- a/GeoLib/TemplateVec.h
+++ b/GeoLib/TemplateVec.h
@@ -47,7 +47,6 @@ public:
* std::map<std::string, std::size_t>. Here the std::string is the name
* of the element and the value for std::size_t stands for an index in
* the data_vec.
-
*/
TemplateVec (const std::string &name, std::vector<T*>* data_vec,
NameIdMap* elem_name_map = nullptr) :
@@ -95,7 +94,6 @@ public:
* search the vector of names for the ID of the geometric element with the given name
* @param name the name of the geometric element
* @param id the id of the geometric element
- * @return
*/
bool getElementIDByName (const std::string& name, std::size_t &id) const
{
diff --git a/GeoLib/Triangle.h b/GeoLib/Triangle.h
index ec9a25339a4f3f608f6b1e2d2e0dde83f9e50ca6..3ab948182668ae88f621e182332f9a6592db6604 100644
--- a/GeoLib/Triangle.h
+++ b/GeoLib/Triangle.h
@@ -72,7 +72,7 @@ public:
/**
* checks if point is in triangle
- * @param pnt
+ * @param pnt The input point
* @return true, if point is in triangle, else false
*/
bool containsPoint (const double *pnt) const;
diff --git a/MathLib/LinAlg/Dense/DenseMatrix.h b/MathLib/LinAlg/Dense/DenseMatrix.h
index 67f012dfd9e541f2eb70591a0e07ba889d165cd9..8f21abf4a7183c13e79f4745a68ca64385349931 100644
--- a/MathLib/LinAlg/Dense/DenseMatrix.h
+++ b/MathLib/LinAlg/Dense/DenseMatrix.h
@@ -51,7 +51,6 @@ public:
/**
* Assignment operator, makes a copy of the internal data of the object.
* @param rhs The DenseMatrix object to the right side of the assignment symbol.
- * @return
*/
DenseMatrix& operator=(DenseMatrix const& rhs) throw (std::range_error);
@@ -59,7 +58,6 @@ public:
* This is the move assignment operator.
* @param rhs This is the right hand side of a assignment operation.
* After applying this operation the object src has no rows and columns anymore.
- * @return
*/
DenseMatrix& operator=(DenseMatrix && rhs);
@@ -70,8 +68,6 @@ public:
/**
* DenseMatrix vector multiplication
- * @param x
- * @return
*/
FP_TYPE* operator* (FP_TYPE* const& x) const;
FP_TYPE* operator* (FP_TYPE const* const& x) const;
@@ -79,14 +75,10 @@ public:
/**
* DenseMatrix matrix addition.
- * @param mat
- * @return
*/
DenseMatrix* operator+ (const DenseMatrix& mat) const throw (std::range_error);
/**
* DenseMatrix matrix subtraction
- * @param mat
- * @return
*/
DenseMatrix* operator- (const DenseMatrix& mat) const throw (std::range_error);
diff --git a/MathLib/LinAlg/Dense/DenseMatrix.tpp b/MathLib/LinAlg/Dense/DenseMatrix.tpp
index cc654782646b8b3228016be7998a66cfb5dc14bf..a3b58ef1b01ac4f51f402332ae39e1726e57bd77 100644
--- a/MathLib/LinAlg/Dense/DenseMatrix.tpp
+++ b/MathLib/LinAlg/Dense/DenseMatrix.tpp
@@ -2,7 +2,6 @@
* @file DenseMatrix.tpp
* @author Thomas Fischer and Haibing Shao
* @date Jun 10, 2013
- * @brief
*
* @copyright
* Copyright (c) 2013, OpenGeoSys Community (http://www.opengeosys.org)
diff --git a/MathLib/LinAlg/Dense/DenseVector.h b/MathLib/LinAlg/Dense/DenseVector.h
index 31a6ff7c8e7f15a9a71062bbfedb7553ea882657..1d297b2bc5e6c45b9a02169cbbbaf88c549cea6d 100644
--- a/MathLib/LinAlg/Dense/DenseVector.h
+++ b/MathLib/LinAlg/Dense/DenseVector.h
@@ -39,7 +39,6 @@ public:
/**
* Constructor for initialization of the number of rows
* @param nrows number of rows
- * @return
*/
explicit DenseVector(std::size_t nrows=0)
: std::valarray<T>(nrows)
@@ -75,7 +74,7 @@ public:
/**
* writes the matrix entries into a file
- * @param output file name
+ * @param filename output file name
*/
void write (const std::string &filename) const
{
@@ -88,7 +87,7 @@ public:
/**
* writes a vector content into the output stream
- * @param out the output stream
+ * @param os the output stream
*/
template <typename T>
std::ostream& operator<<(std::ostream& os, DenseVector<T> const & v)
diff --git a/MathLib/LinAlg/Sparse/CRSMatrix.h b/MathLib/LinAlg/Sparse/CRSMatrix.h
index b55592c1d1d64c455e8aa854e1d45dd7e5c294e8..49ca01fba8b425007d7bf48bfd346d408a8fdb67 100644
--- a/MathLib/LinAlg/Sparse/CRSMatrix.h
+++ b/MathLib/LinAlg/Sparse/CRSMatrix.h
@@ -222,7 +222,6 @@ public:
/**
* get the matrix entries within an array of CRS matrix
- * @return
*/
FP_TYPE const* getEntryArray() const { return _data; }
diff --git a/MathLib/LinAlg/Sparse/CRSMatrixDiagPrecond.h b/MathLib/LinAlg/Sparse/CRSMatrixDiagPrecond.h
index 83da6ea682a0f50212568fc36155a0e2fd2f5544..45942c486d607e55463641537e2485030ecd0e95 100644
--- a/MathLib/LinAlg/Sparse/CRSMatrixDiagPrecond.h
+++ b/MathLib/LinAlg/Sparse/CRSMatrixDiagPrecond.h
@@ -31,7 +31,6 @@ public:
*
* @param fname the name of the file that contains the matrix in
* binary compressed row storage format
- * @return object of class CRSMatrixDiagPrecond
*/
CRSMatrixDiagPrecond(std::string const &fname) :
CRSMatrix<double, unsigned> (fname), _inv_diag(NULL)
@@ -45,7 +44,6 @@ public:
* @param iA row pointer of matrix in compressed row storage format
* @param jA column index of matrix in compressed row storage format
* @param A data entries of matrix in compressed row storage format
- * @return
*/
CRSMatrixDiagPrecond(unsigned n, unsigned *iA, unsigned *jA, double* A) :
CRSMatrix<double, unsigned> (n, iA, jA, A), _inv_diag(NULL)
diff --git a/MathLib/LinAlg/Sparse/MatrixSparsityPattern.h b/MathLib/LinAlg/Sparse/MatrixSparsityPattern.h
index d31a2d9ea7f437850388c099bdf21f22649d287b..2770f2ee922370973d7a26115a159e97db04fc5f 100644
--- a/MathLib/LinAlg/Sparse/MatrixSparsityPattern.h
+++ b/MathLib/LinAlg/Sparse/MatrixSparsityPattern.h
@@ -24,7 +24,7 @@ namespace MathLib
/// \brief Class for representation of matrix sparsity pattern, required for
/// creation of sparse matrices.
///
-/// \detail Current implementation requires only number of matrix's rows,
+/// \details Current implementation requires only number of matrix's rows,
/// allowing thus non-rectangular sparsity patterns. The class is based on
/// std::set container which automatically check for multiple insertions.
class MatrixSparsityPattern
diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.h b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.h
index c1c87280b67f3ceb13b8aa86f0be07d98cc9cfad..84d66ce30e2c0ff3a222929144231daf466bd874 100644
--- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.h
+++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/Cluster.h
@@ -31,7 +31,6 @@ public:
* @param n
* @param jA
* @param iA
- * @return
*/
Cluster(unsigned n, unsigned* iA, unsigned* jA);
diff --git a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.h b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.h
index 66abfd09430cee011ed7d6f565e352702c32c60e..07cf19c26ceb7a1259b2043033cafd669719e3e8 100644
--- a/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.h
+++ b/MathLib/LinAlg/Sparse/NestedDissectionPermutation/ClusterBase.h
@@ -30,7 +30,6 @@ public:
* @param n number of rows/columns
* @param iA row pointer array
* @param jA column index array
- * @return
*/
ClusterBase(unsigned n, unsigned const*const iA, unsigned const*const jA);
/*!
diff --git a/MathLib/TemplatePoint.h b/MathLib/TemplatePoint.h
index d854e739b1bfbc39f89f2a7ac2b6ca91491e1be7..e5c9dd1cbf5de4283601d7fca84b4cec2ac9fc69 100644
--- a/MathLib/TemplatePoint.h
+++ b/MathLib/TemplatePoint.h
@@ -25,7 +25,7 @@ namespace MathLib
* \ingroup GeoLib
*
* \brief class-template for points can be instantiated by a numeric type.
- * \param T the coordinate type
+ * \tparam T the coordinate type
*/
template <class T> class TemplatePoint
{