From 9ed59421e6d380ae12dbcfe257dbb7eb2cdd3fc8 Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Thu, 21 Jan 2016 12:53:41 +0100
Subject: [PATCH] remove various doxygen warnings
---
.../DataExplorer/DataView/MeshAnalysisDialog.cpp | 2 +-
.../Utils/GeoTools/TriangulatePolyline.cpp | 2 +-
Applications/Utils/MeshEdit/NodeReordering.cpp | 2 +-
AssemblerLib/SerialExecutor.h | 2 ++
BaseLib/ConfigTreeNew.h | 3 ++-
GeoLib/AnalyticalGeometry.h | 2 +-
GeoLib/MinimalBoundingSphere.cpp | 4 ++--
GeoLib/MinimalBoundingSphere.h | 4 ++--
MathLib/LinAlg/Dense/DenseMatrix-impl.h | 2 +-
MathLib/LinAlg/Dense/GlobalDenseMatrix-impl.h | 2 +-
MathLib/LinAlg/PETSc/PETScMatrix.h | 2 +-
MathLib/LinAlg/PETSc/PETScVector.h | 2 +-
MeshLib/Elements/PrismRule6.h | 2 +-
MeshLib/Elements/PyramidRule5.h | 2 +-
MeshLib/Elements/QuadRule8.h | 2 +-
MeshLib/Elements/QuadRule9.h | 2 +-
MeshLib/Elements/TetRule4.h | 2 +-
MeshLib/Elements/TriRule6.h | 2 +-
MeshLib/MeshEditing/projectMeshOntoPlane.h | 2 +-
MeshLib/MeshInformation.h | 14 +++++++-------
MeshLib/MeshQuality/MeshValidation.h | 2 +-
MeshLib/PropertyVector.h | 6 +++---
22 files changed, 34 insertions(+), 31 deletions(-)
diff --git a/Applications/DataExplorer/DataView/MeshAnalysisDialog.cpp b/Applications/DataExplorer/DataView/MeshAnalysisDialog.cpp
index 106524efa9b..e42c81cf49f 100644
--- a/Applications/DataExplorer/DataView/MeshAnalysisDialog.cpp
+++ b/Applications/DataExplorer/DataView/MeshAnalysisDialog.cpp
@@ -1,5 +1,5 @@
/**
- * \file MeshAnalysisDialog
+ * \file MeshAnalysisDialog.cpp
* \author Karsten Rink
* \date 2014-02-24
* \brief Implementation of the MeshAnalysisDialog class.
diff --git a/Applications/Utils/GeoTools/TriangulatePolyline.cpp b/Applications/Utils/GeoTools/TriangulatePolyline.cpp
index 45cddb8d44e..61be7b52613 100644
--- a/Applications/Utils/GeoTools/TriangulatePolyline.cpp
+++ b/Applications/Utils/GeoTools/TriangulatePolyline.cpp
@@ -1,5 +1,5 @@
/**
- * \file TriangulatePolyline.h
+ * \file TriangulatePolyline.cpp
* \author Karsten Rink
* \date 2015-02-02
* \brief Utility for triangulating polylines.
diff --git a/Applications/Utils/MeshEdit/NodeReordering.cpp b/Applications/Utils/MeshEdit/NodeReordering.cpp
index 8e3a0647b5b..2d152f061aa 100644
--- a/Applications/Utils/MeshEdit/NodeReordering.cpp
+++ b/Applications/Utils/MeshEdit/NodeReordering.cpp
@@ -1,5 +1,5 @@
/**
- * \file DataExplorer5NodeReordering.cpp
+ * \file NodeReordering.cpp
* 2013/13/06 KR Initial implementation
*
* @copyright
diff --git a/AssemblerLib/SerialExecutor.h b/AssemblerLib/SerialExecutor.h
index 3d9c20bea79..22a613d4acb 100644
--- a/AssemblerLib/SerialExecutor.h
+++ b/AssemblerLib/SerialExecutor.h
@@ -27,6 +27,7 @@ struct SerialExecutor
/// \param f a function that accepts a pointer to container's elements and
/// an index as arguments.
/// \param c a container supporting access over operator[].
+ /// \param args additional arguments passed to \c f
template <typename F, typename C, typename ...Args_>
static
void
@@ -52,6 +53,7 @@ struct SerialExecutor
/// is modified.
/// \param c a container supporting const access over operator[] and size().
/// \param data a container supporting non-const access over operator[] and size().
+ /// \param args additional arguments passed to \c f
template <typename F, typename C, typename Data, typename ...Args_>
static
void
diff --git a/BaseLib/ConfigTreeNew.h b/BaseLib/ConfigTreeNew.h
index 6129c55539c..0d7a29a4d3d 100644
--- a/BaseLib/ConfigTreeNew.h
+++ b/BaseLib/ConfigTreeNew.h
@@ -167,7 +167,8 @@ public:
using Callback = std::function<void(const std::string& path,
const std::string& message)>;
- /*! Creates a new instance wrapping the given Boost Property Tree.
+ /*!
+ * Creates a new instance wrapping the given Boost Property Tree.
*
* \param tree the Boost Property Tree to be wrapped
* \param error_cb callback function to be called on error.
diff --git a/GeoLib/AnalyticalGeometry.h b/GeoLib/AnalyticalGeometry.h
index 488f3dc5e3c..c713888810e 100644
--- a/GeoLib/AnalyticalGeometry.h
+++ b/GeoLib/AnalyticalGeometry.h
@@ -173,7 +173,7 @@ void rotatePointsToXY(
void rotatePointsToXZ(std::vector<GeoLib::Point*> &pnts);
/**
- * Calculates the area of the triangle defined by its edge nodes a, b and c..
+ * Calculates the area of the triangle defined by its edge nodes a, b and c.
* The formula is \f$A= \frac{1}{2} \cdot |u \times v|\f$, i.e. half of the area of the
* parallelogram specified by the vectors\f$u=b-a\f$ and \f$v=c-a\f$.
*/
diff --git a/GeoLib/MinimalBoundingSphere.cpp b/GeoLib/MinimalBoundingSphere.cpp
index 5ece4e6f6c3..03725f270e7 100644
--- a/GeoLib/MinimalBoundingSphere.cpp
+++ b/GeoLib/MinimalBoundingSphere.cpp
@@ -1,8 +1,8 @@
/**
- * \file Calculation of a minimum bounding sphere for a vector of points
+ * \file MinimalBoundingSphere.cpp
* \author Karsten Rink
* \date 2014-07-11
- * \brief Implementation of the MinimalBoundingSphere class.
+ * \brief Calculation of a minimum bounding sphere for a vector of points.
*
* \copyright
* Copyright (c) 2012-2016, OpenGeoSys Community (http://www.opengeosys.org)
diff --git a/GeoLib/MinimalBoundingSphere.h b/GeoLib/MinimalBoundingSphere.h
index 575ce04b16a..fbbc893d2ef 100644
--- a/GeoLib/MinimalBoundingSphere.h
+++ b/GeoLib/MinimalBoundingSphere.h
@@ -1,8 +1,8 @@
/**
- * \file Calculation of a minimum bounding sphere for a vector of points
+ * \file MinimalBoundingSphere.h
* \author Karsten Rink
* \date 2014-07-11
- * \brief Definition of the MinimalBoundingSphere class.
+ * \brief Calculation of a minimum bounding sphere for a vector of points
*
* \copyright
* Copyright (c) 2012-2016, OpenGeoSys Community (http://www.opengeosys.org)
diff --git a/MathLib/LinAlg/Dense/DenseMatrix-impl.h b/MathLib/LinAlg/Dense/DenseMatrix-impl.h
index b3aff5df65d..0a91b3053a8 100644
--- a/MathLib/LinAlg/Dense/DenseMatrix-impl.h
+++ b/MathLib/LinAlg/Dense/DenseMatrix-impl.h
@@ -1,5 +1,5 @@
/**
- * @file DenseMatrix-imp.h
+ * @file DenseMatrix-impl.h
* @author Thomas Fischer and Haibing Shao
* @date Jun 10, 2013
*
diff --git a/MathLib/LinAlg/Dense/GlobalDenseMatrix-impl.h b/MathLib/LinAlg/Dense/GlobalDenseMatrix-impl.h
index 298fb2ac9b6..937377d974f 100644
--- a/MathLib/LinAlg/Dense/GlobalDenseMatrix-impl.h
+++ b/MathLib/LinAlg/Dense/GlobalDenseMatrix-impl.h
@@ -1,5 +1,5 @@
/**
- * @file GlobalDenseMatrix.tpp
+ * @file GlobalDenseMatrix-impl.h
* @author Thomas Fischer
* @date Jun 10, 2013
* @brief
diff --git a/MathLib/LinAlg/PETSc/PETScMatrix.h b/MathLib/LinAlg/PETSc/PETScMatrix.h
index 3023b092b9f..51b40a16a46 100644
--- a/MathLib/LinAlg/PETSc/PETScMatrix.h
+++ b/MathLib/LinAlg/PETSc/PETScMatrix.h
@@ -188,7 +188,7 @@ class PETScMatrix
/*! View the global vector for test purpose. Do not use it for output a big vector.
\param file_name File name for output
- \vw_format File format listed as:
+ \param vw_format File format listed as:
PETSC_VIEWER_DEFAULT Default format
PETSC_VIEWER_ASCII_MATLAB MATLAB format
PETSC_VIEWER_ASCII_DENSE Print matrix as dense
diff --git a/MathLib/LinAlg/PETSc/PETScVector.h b/MathLib/LinAlg/PETSc/PETScVector.h
index 7707c5b8dff..e2797dfcfec 100644
--- a/MathLib/LinAlg/PETSc/PETScVector.h
+++ b/MathLib/LinAlg/PETSc/PETScVector.h
@@ -212,7 +212,7 @@ class PETScVector
/*! View the global vector for test purpose. Do not use it for output a big vector.
\param file_name File name for output
- \vw_format File format listed as:
+ \param vw_format File format listed as:
PETSC_VIEWER_DEFAULT Default format
PETSC_VIEWER_ASCII_MATLAB MATLAB format
PETSC_VIEWER_ASCII_DENSE Print matrix as dense
diff --git a/MeshLib/Elements/PrismRule6.h b/MeshLib/Elements/PrismRule6.h
index 306f9e8ad32..c86a5b7454d 100644
--- a/MeshLib/Elements/PrismRule6.h
+++ b/MeshLib/Elements/PrismRule6.h
@@ -20,7 +20,7 @@ namespace MeshLib
/**
* This class represents a 3d prism element. The following sketch shows the node and edge numbering.
- * @anchor PrismNodeAndEdgeNumbering
+ * @anchor Prism6NodeAndEdgeNumbering
* @code
* 5
* / \
diff --git a/MeshLib/Elements/PyramidRule5.h b/MeshLib/Elements/PyramidRule5.h
index edf632af6a7..8f333f3f18e 100644
--- a/MeshLib/Elements/PyramidRule5.h
+++ b/MeshLib/Elements/PyramidRule5.h
@@ -20,7 +20,7 @@ namespace MeshLib
/**
* This class represents a 3d pyramid element. The following sketch shows the node and edge numbering.
- * @anchor PyramidNodeAndEdgeNumbering
+ * @anchor Pyramid5NodeAndEdgeNumbering
* @code
*
* 4
diff --git a/MeshLib/Elements/QuadRule8.h b/MeshLib/Elements/QuadRule8.h
index 81748497f77..115da65e946 100644
--- a/MeshLib/Elements/QuadRule8.h
+++ b/MeshLib/Elements/QuadRule8.h
@@ -20,7 +20,7 @@ namespace MeshLib
/**
* This class represents a 2d quadrilateral element with 8 nodes.
* The following sketch shows the node and edge numbering.
- * @anchor QuadNodeAndEdgeNumbering
+ * @anchor Quad8NodeAndEdgeNumbering
* @code
* 2
* 3-----6-----2
diff --git a/MeshLib/Elements/QuadRule9.h b/MeshLib/Elements/QuadRule9.h
index c5bdf3e3e92..3359c0d5e04 100644
--- a/MeshLib/Elements/QuadRule9.h
+++ b/MeshLib/Elements/QuadRule9.h
@@ -19,7 +19,7 @@ namespace MeshLib
/**
* This class represents a 2d quadrilateral element with 9 nodes.
* The following sketch shows the node and edge numbering.
- * @anchor QuadNodeAndEdgeNumbering
+ * @anchor Quad9NodeAndEdgeNumbering
* @code
* 2
* 3-----6-----2
diff --git a/MeshLib/Elements/TetRule4.h b/MeshLib/Elements/TetRule4.h
index c89e34d0925..7ec3c764439 100644
--- a/MeshLib/Elements/TetRule4.h
+++ b/MeshLib/Elements/TetRule4.h
@@ -20,7 +20,7 @@ namespace MeshLib
/**
* This class represents a 3d tetrahedron element. The following sketch shows the node and edge numbering.
- * @anchor TetrahedronNodeAndEdgeNumbering
+ * @anchor Tetrahedron4NodeAndEdgeNumbering
* @code
* 3
* /|\
diff --git a/MeshLib/Elements/TriRule6.h b/MeshLib/Elements/TriRule6.h
index 0dd5d207a81..8d878f4872f 100644
--- a/MeshLib/Elements/TriRule6.h
+++ b/MeshLib/Elements/TriRule6.h
@@ -21,7 +21,7 @@ namespace MeshLib
* This class represents a 2d triangle element with 6 nodes.
*
* The following sketch shows the node and edge numbering.
- * @anchor TriNodeAndEdgeNumbering
+ * @anchor Tri6NodeAndEdgeNumbering
* @code
*
* 2
diff --git a/MeshLib/MeshEditing/projectMeshOntoPlane.h b/MeshLib/MeshEditing/projectMeshOntoPlane.h
index e9c1eef5c7d..5a1a91d8774 100644
--- a/MeshLib/MeshEditing/projectMeshOntoPlane.h
+++ b/MeshLib/MeshEditing/projectMeshOntoPlane.h
@@ -1,5 +1,5 @@
/**
- * \file projectMeshOntoPlane
+ * \file projectMeshOntoPlane.h
* \author Karsten Rink
* \date 2015-04-10
* \brief Definition of the projectMeshOntoPlane
diff --git a/MeshLib/MeshInformation.h b/MeshLib/MeshInformation.h
index edfcd48dbe7..699f540da3e 100644
--- a/MeshLib/MeshInformation.h
+++ b/MeshLib/MeshInformation.h
@@ -39,13 +39,13 @@ public:
* Returns an array with the number of elements of each type in the given mesh.
* On completion, n_element_types array contains the number of elements of each of the seven
* supported types. The index to element type conversion is this:
- * 0: #lines
- * 1: #triangles
- * 2: #quads
- * 3: #tetrahedra
- * 4: #hexahedra
- * 5: #pyramids
- * 6: #prisms
+ * 0: \#lines
+ * 1: \#triangles
+ * 2: \#quads
+ * 3: \#tetrahedra
+ * 4: \#hexahedra
+ * 5: \#pyramids
+ * 6: \#prisms
*/
static const std::array<unsigned, 7> getNumberOfElementTypes(const MeshLib::Mesh &mesh);
diff --git a/MeshLib/MeshQuality/MeshValidation.h b/MeshLib/MeshQuality/MeshValidation.h
index 7e1512c7388..c392a8aa1e0 100644
--- a/MeshLib/MeshQuality/MeshValidation.h
+++ b/MeshLib/MeshQuality/MeshValidation.h
@@ -1,5 +1,5 @@
/**
- * \file MeshQualityController.h
+ * \file MeshValidation.h
* \author Karsten Rink
* \date 2013-04-04
* \brief Definition of the MeshValidation class
diff --git a/MeshLib/PropertyVector.h b/MeshLib/PropertyVector.h
index 6f812b93968..17945dcd4cb 100644
--- a/MeshLib/PropertyVector.h
+++ b/MeshLib/PropertyVector.h
@@ -70,7 +70,7 @@ protected:
/// @brief The constructor taking meta information for the data.
/// @param property_name a string describing the property
/// @param mesh_item_type the values of the property are either assigned to
- /// nodes or cells (see enumeration @MeshItemType) (default:
+ /// nodes or cells (see enumeration MeshItemType) (default:
/// MeshItemType::Cell)
/// @param tuple_size the number of elements of a tuple (default: 1)
explicit PropertyVector(std::string const& property_name,
@@ -85,7 +85,7 @@ protected:
/// with several entries)
/// @param property_name a string describing the property
/// @param mesh_item_type the values of the property are either assigned to
- /// nodes or cells (see enumeration @MeshItemType) (default:
+ /// nodes or cells (see enumeration MeshItemType) (default:
/// MeshItemType::Cell)
/// @param tuple_size the number of elements of a tuple (default: 1)
PropertyVector(std::size_t n_property_values,
@@ -195,7 +195,7 @@ protected:
/// \f$[0, \text{n_prop_groups})\f$.
/// @param property_name a string describing the property
/// @param mesh_item_type the values of the property are either assigned to
- /// nodes or cells (see enumeration @MeshItemType) (default:
+ /// nodes or cells (see enumeration MeshItemType) (default:
/// MeshItemType::Cell)
/// @param tuple_size the number of elements of a tuple (default: 1)
PropertyVector(std::size_t n_prop_groups,
--
GitLab