Merge branch 'CleanupDoxygenHeaders' into 'master'

Cleanup of the Doxygen's documentation. See merge request ogs/ogs!4671
ufz · Jul 13, 2023 · 1630a2b · 1630a2b
2 parents 6b55afa + 20a2395
commit 1630a2b
Show file tree

Hide file tree

Showing 385 changed files with 792 additions and 1,033 deletions.
diff --git a/Applications/ApplicationsLib/LinearSolverLibrarySetup.h b/Applications/ApplicationsLib/LinearSolverLibrarySetup.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/ApplicationsLib/ProjectData.cpp b/Applications/ApplicationsLib/ProjectData.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \author Karsten Rink
  * \date 2010-08-25
  * \brief Implementation of the project data class.

diff --git a/Applications/ApplicationsLib/ProjectData.h b/Applications/ApplicationsLib/ProjectData.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \author Karsten Rink
  * \date 2010-08-25
  *

diff --git a/Applications/ApplicationsLib/Simulation.cpp b/Applications/ApplicationsLib/Simulation.cpp
@@ -1,6 +1,6 @@
 /**
- * \brief Implementation of class Simulation
  * \file
+ * \brief Implementation of class Simulation
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/ApplicationsLib/Simulation.h b/Applications/ApplicationsLib/Simulation.h
@@ -1,6 +1,6 @@
 /**
- * \brief Declaration of class Simulation
  * \file
+ * \brief Declaration of class Simulation
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/CLI/CommandLineArgumentParser.cpp b/Applications/CLI/CommandLineArgumentParser.cpp
@@ -1,6 +1,6 @@
 /**
- * \brief Implementation of CommandLineArgumentParser.
  * \file
+ * \brief Implementation of CommandLineArgumentParser.
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/CLI/CommandLineArgumentParser.h b/Applications/CLI/CommandLineArgumentParser.h
@@ -1,6 +1,6 @@
 /**
- * \brief Declaration of CommandLineArgumentParser.
  * \file
+ * \brief Declaration of CommandLineArgumentParser.
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/CLI/ogs.cpp b/Applications/CLI/ogs.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \date 2014-08-04
  * \brief Implementation of OpenGeoSys simulation application
  *

diff --git a/Applications/CLI/ogs_embedded_python.cpp b/Applications/CLI/ogs_embedded_python.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/CLI/ogs_embedded_python.h b/Applications/CLI/ogs_embedded_python.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/DataView/MeshMapping2DDialog.cpp b/Applications/DataExplorer/DataView/MeshMapping2DDialog.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/DataView/MeshMapping2DDialog.h b/Applications/DataExplorer/DataView/MeshMapping2DDialog.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.cpp b/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (https://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.h b/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (https://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/VtkVis/VtkAppendArrayFilter.h b/Applications/DataExplorer/VtkVis/VtkAppendArrayFilter.h
@@ -22,7 +22,6 @@
 #include <vector>
 
 /**
- * \brief
  */
 class VtkAppendArrayFilter : public vtkUnstructuredGridAlgorithm, public VtkAlgorithmProperties
 {

diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeFilter.h b/Applications/DataExplorer/VtkVis/VtkCompositeFilter.h
@@ -19,7 +19,7 @@
 class vtkAlgorithm;
 
 /**
- * @brief Is used to combine several filter in one VtkVisPipelineItem. You can
+ * \brief Is used to combine several filter in one VtkVisPipelineItem. You can
  * use vtk filter and custom filter. To subclass this you have to implement the
  * init() function. There you combine the filters. Make sure to set the members
  * _inputDataObjectType, _outputDataObjectType and _outputAlgorithm. Make also
@@ -33,10 +33,10 @@ class vtkAlgorithm;
  * ...(do something here)
  * _outputAlgorithm = lastFilter;
  *
- * Create user properties with `ogsUserPropertyMacro` or `ogsUserVecxPropertyMacro`
- * and initialize these properties inside the constructor with
- * `this->Set[Property Name](value)`.
- * See VtkCompositeThresholdFilter for an example.
+ * Create user properties with `ogsUserPropertyMacro` or
+ * `ogsUserVecxPropertyMacro` and initialize these properties inside the
+ * constructor with `this->Set[Property Name](value)`. See
+ * VtkCompositeThresholdFilter for an example.
  */
 class VtkCompositeFilter : public VtkAlgorithmProperties
 {

diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.cpp b/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.h b/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.cpp b/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.h b/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.cpp b/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.h b/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \brief VtkWin32ConsoleOutputWindow is used to suppress message boxes on
  * Windows.
  *

diff --git a/Applications/DataHolderLib/ColorLookupTable.cpp b/Applications/DataHolderLib/ColorLookupTable.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/DataHolderLib/ColorLookupTable.h b/Applications/DataHolderLib/ColorLookupTable.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/FileIO/CsvInterface.cpp b/Applications/FileIO/CsvInterface.cpp
@@ -1,10 +1,10 @@
 /**
- * @file CsvInterface.cpp
- * @author Karsten Rink
- * @date 2015-03-25
- * @brief Implementation of the CsvInterface class.
+ * \file
+ * \author Karsten Rink
+ * \date 2015-03-25
+ * \brief Implementation of the CsvInterface class.
  *
- * @copyright
+ * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.
  * See accompanying file LICENSE.txt or

diff --git a/Applications/FileIO/CsvInterface.h b/Applications/FileIO/CsvInterface.h
@@ -1,10 +1,10 @@
 /**
- * @file CsvInterface.h
- * @author Karsten Rink
- * @date 2015-03-25
- * @brief Definition of the CsvInterface class.
+ * \file
+ * \author Karsten Rink
+ * \date 2015-03-25
+ * \brief Definition of the CsvInterface class.
  *
- * @copyright
+ * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.
  * See accompanying file LICENSE.txt or

diff --git a/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.cpp b/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.h b/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.cpp b/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.h b/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.

diff --git a/Applications/FileIO/GMSInterface.cpp b/Applications/FileIO/GMSInterface.cpp
@@ -9,10 +9,6 @@
  * Distributed under a Modified BSD License.
  * See accompanying file LICENSE.txt or
  * http://www.opengeosys.org/project/license
- *
- * @file GMSInterface.cpp
- * @date 2010-06-08
- * @author Karsten Rink
  */
 
 #include "GMSInterface.h"

diff --git a/Applications/FileIO/GMSInterface.h b/Applications/FileIO/GMSInterface.h
@@ -1,6 +1,7 @@
 /**
  * \file
  * \author Karsten Rink
+ * \author Lars Bilke
  * \date 2010-06-08
  * \brief Definition of the GMSInterface class.
  *
@@ -9,10 +10,6 @@
  * Distributed under a Modified BSD License.
  * See accompanying file LICENSE.txt or
  * http://www.opengeosys.org/project/license
- *
- * @file GMSInterface.h
- * @date 2010-06-08
- * @author Lars Bilke
  */
 
 #pragma once

diff --git a/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.cpp b/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.cpp
@@ -1,14 +1,14 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.
  * See accompanying file LICENSE.txt or
  * http://www.opengeosys.org/project/license
  *
- * @file GMSHAdaptiveMeshDensity.cpp
- * @date 2012-03-05
- * @author Thomas Fischer
+ * \date 2012-03-05
+ * \author Thomas Fischer
  */
 
 #include "GMSHAdaptiveMeshDensity.h"

diff --git a/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.h b/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.cpp b/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.h b/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHInterface.cpp b/Applications/FileIO/Gmsh/GMSHInterface.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHInterface.h b/Applications/FileIO/Gmsh/GMSHInterface.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHLine.cpp b/Applications/FileIO/Gmsh/GMSHLine.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHLine.h b/Applications/FileIO/Gmsh/GMSHLine.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHLineLoop.cpp b/Applications/FileIO/Gmsh/GMSHLineLoop.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHLineLoop.h b/Applications/FileIO/Gmsh/GMSHLineLoop.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHMeshDensityStrategy.h b/Applications/FileIO/Gmsh/GMSHMeshDensityStrategy.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHPoint.cpp b/Applications/FileIO/Gmsh/GMSHPoint.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHPoint.h b/Applications/FileIO/Gmsh/GMSHPoint.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHPolygonTree.cpp b/Applications/FileIO/Gmsh/GMSHPolygonTree.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GMSHPolygonTree.h b/Applications/FileIO/Gmsh/GMSHPolygonTree.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GmshReader.cpp b/Applications/FileIO/Gmsh/GmshReader.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)

diff --git a/Applications/FileIO/Gmsh/GmshReader.h b/Applications/FileIO/Gmsh/GmshReader.h
@@ -1,4 +1,5 @@
 /**
+ * \file
  *
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
@@ -21,16 +22,16 @@ namespace GMSH
 
 /**
  * checks if there is a GMSH mesh file header
- * @param fname the file name of the mesh (including the path)
- * @return true, if the file seems to be a valid GMSH file, else false
+ * \param fname the file name of the mesh (including the path)
+ * \return true, if the file seems to be a valid GMSH file, else false
  */
 bool isGMSHMeshFile(const std::string& fname);
 
 /**
  * reads a mesh created by GMSH - this implementation is based on the former
  * function GMSH2MSH
- * @param fname the file name of the mesh (including the path)
- * @return
+ * \param fname the file name of the mesh (including the path)
+ * \return
  */
 MeshLib::Mesh* readGMSHMesh(std::string const& fname);
 

diff --git a/Applications/FileIO/GocadIO/GocadEnums.cpp b/Applications/FileIO/GocadIO/GocadEnums.cpp
@@ -1,4 +1,5 @@
 /**
+ * \file
  * \copyright
  * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
  * Distributed under a Modified BSD License.