Merge branch 'SmallFixes' into 'master'

Doxygen docu fixes See merge request ogs/ogs!4946
ufz · Mar 12, 2024 · 48c0bdb · 48c0bdb
2 parents 718338e + 9cad22f
commit 48c0bdb
Show file tree

Hide file tree

Showing 14 changed files with 3 additions and 39 deletions.
diff --git a/BaseLib/Algorithm.h b/BaseLib/Algorithm.h
@@ -109,8 +109,6 @@ void insertIfKeyUniqueElseError(Map& map, Key const& key, Value&& value,
 //! Returns the value of \c key from the given \c map if such an entry exists;
 //! otherwise an \c error_message is printed and the program is aborted.
 //! Cf. also the const overload below.
-//! \remark Use as: \code{.cpp} get_or_error<Value>(some_map, some_key, "error
-//! message") \endcode
 template <typename Map, typename Key>
 typename Map::mapped_type& getOrError(Map& map, Key const& key,
                                       std::string const& error_message)

diff --git a/GeoLib/GEOObjects.h b/GeoLib/GEOObjects.h
@@ -27,14 +27,10 @@
 #include "Surface.h"
 #include "SurfaceVec.h"
 
+/// This module consists of classes governing geometric objects and related
+/// algorithms.
 namespace GeoLib
 {
-///
-/**
- * \defgroup GeoLib This module consists of classes governing geometric objects
- * and related algorithms.
- */
-
 /**
  * \brief Container class for geometric objects.
  *

diff --git a/GeoLib/GeoObject.h b/GeoLib/GeoObject.h
@@ -3,7 +3,6 @@
  * \author Thomas Fischer
  * \date   2010-08-27
  * \brief  Base class for classes Point, Polyline, Surface.
- * \ingroup GeoLib
  *
  * \copyright
  * Copyright (c) 2012-2024, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/GeoLib/GeoType.h b/GeoLib/GeoType.h
@@ -19,10 +19,6 @@
 namespace GeoLib
 {
 
-/**
- * \ingroup GeoLib
- */
-
 enum class GEOTYPE
 {
     POINT,

diff --git a/GeoLib/Point.h b/GeoLib/Point.h
@@ -24,10 +24,6 @@
 
 namespace GeoLib
 {
-/**
- * \ingroup GeoLib
- */
-
 // forward declaration
 class PointVec;
 

diff --git a/GeoLib/PointVec.h b/GeoLib/PointVec.h
@@ -27,8 +27,6 @@
 namespace GeoLib
 {
 /**
- * \ingroup GeoLib
- *
  * \brief This class manages pointers to Points in a std::vector along with a
  * name. It also handles the deletion of points. Furthermore, typically,
  * PointVec objects are managed by GEOObjects using the instance name for

diff --git a/GeoLib/Polygon.h b/GeoLib/Polygon.h
@@ -23,10 +23,6 @@
 
 namespace GeoLib
 {
-/**
- * \ingroup GeoLib
- */
-
 /**
  * A polygon is a (closed) polyline. Thus class Polygon is derived from class
  * Polyline.

diff --git a/GeoLib/Polyline.h b/GeoLib/Polyline.h
@@ -30,8 +30,6 @@ namespace GeoLib
 class PointVec;
 
 /**
- * \ingroup GeoLib
- *
  * \brief Class Polyline consists mainly of a reference to a point vector and
  * a vector that stores the indices in the point vector.
  * A polyline consists of at least one line segment. The polyline is specified

diff --git a/GeoLib/PolylineVec.h b/GeoLib/PolylineVec.h
@@ -21,12 +21,9 @@ namespace GeoLib
 {
 
 /**
- * \ingroup GeoLib
- *
  * \brief class PolylineVec encapsulate a std::vector of Polylines
  * additional one can give the vector of polylines a name
  * */
-
 using PolylineVec = TemplateVec<GeoLib::Polyline>;
 
 }  // namespace GeoLib
diff --git a/GeoLib/Station.h b/GeoLib/Station.h
@@ -23,8 +23,6 @@
 namespace GeoLib
 {
 /**
- * \ingroup GeoLib
- *
  * \brief A Station (observation site) is basically a Point with some additional
  * information.
  *

diff --git a/GeoLib/Surface.h b/GeoLib/Surface.h
@@ -25,8 +25,6 @@ class Triangle;
 class SurfaceGrid;
 
 /**
- * \ingroup GeoLib
- *
  * \brief A Surface is represented by Triangles. It consists of a reference
  * to a vector of (pointers to) points (_sfc_pnts) and a vector that stores
  * the Triangles consisting of points from _sfc_pnts.

diff --git a/GeoLib/TemplateVec.h b/GeoLib/TemplateVec.h
@@ -28,8 +28,6 @@
 namespace GeoLib
 {
 /**
- * \ingroup GeoLib
- *
  * \brief The class TemplateVec takes a unique name and manages
  * a std::vector of pointers to data elements of type T.
  *

diff --git a/MathLib/Point3d.h b/MathLib/Point3d.h
@@ -19,10 +19,6 @@
 
 namespace MathLib
 {
-/**
- * \ingroup MathLib
- *
- */
 class Point3d
 {
 public:

diff --git a/MathLib/VectorizedTensor.cpp b/MathLib/VectorizedTensor.cpp
@@ -9,7 +9,7 @@
 
 #include "VectorizedTensor.h"
 
-namespace MathLib ::VectorizedTensor
+namespace MathLib::VectorizedTensor
 {
 
 bool isTensorConvertibleTo1d(Eigen::Matrix3d const& tensor)