From 398bd90c3a60761f12f972c0244f0ee088f6e0b8 Mon Sep 17 00:00:00 2001
From: Christoph Grueninger <christoph.grueninger@iws.uni-stuttgart.de>
Date: Fri, 15 May 2015 15:33:09 +0000
Subject: [PATCH] [Doxygen] Fix doxygen generation Doxygen 1.8.8+.
- Rename mainpage, modules and parameterlist to *.txt
to work around new behavior in Doxygen 1.8.8 or newer.
- Fix missing closing brackets in brine_co2.hh.
- Add missing ! in plotoverline (by fetzer)
(reviewed by fetzer)
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@14763 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/doxygen/Doxylocal | 6 +--
doc/doxygen/extradoc/parameterlist | 11 ----
doc/doxygen/extradoc/parameterlist.txt | 11 ++++
doc/doxygen/{mainpage => mainpage.txt} | 0
doc/doxygen/{modules => modules.txt} | 52 +++++++++----------
dumux/io/plotoverline2d.hh | 2 +-
.../material/binarycoefficients/brine_co2.hh | 2 +-
7 files changed, 42 insertions(+), 42 deletions(-)
delete mode 100644 doc/doxygen/extradoc/parameterlist
create mode 100644 doc/doxygen/extradoc/parameterlist.txt
rename doc/doxygen/{mainpage => mainpage.txt} (100%)
rename doc/doxygen/{modules => modules.txt} (95%)
diff --git a/doc/doxygen/Doxylocal b/doc/doxygen/Doxylocal
index fdf93dba23..3c967ad923 100644
--- a/doc/doxygen/Doxylocal
+++ b/doc/doxygen/Doxylocal
@@ -6,12 +6,12 @@ EXCLUDE_PATTERNS = */.svn/*
PREDEFINED += "NEW_PROP_TAG(name)=Property tag name" \
"NEW_TYPE_TAG(name)=Type tag name"
-INPUT += @srcdir@/mainpage \
- @srcdir@/modules \
+INPUT += @srcdir@/mainpage.txt \
+ @srcdir@/modules.txt \
@top_srcdir@/dumux \
@top_srcdir@/test \
@top_srcdir@/tutorial \
- @srcdir@/extradoc/parameterlist
+ @srcdir@/extradoc/parameterlist.txt
EXAMPLE_PATH += @srcdir@/extradoc
diff --git a/doc/doxygen/extradoc/parameterlist b/doc/doxygen/extradoc/parameterlist
deleted file mode 100644
index 6fbf8fc844..0000000000
--- a/doc/doxygen/extradoc/parameterlist
+++ /dev/null
@@ -1,11 +0,0 @@
-/*!
- *\file
- *\ingroup Parameter
- *
- *\brief List of currently useable run-time parameters
- *
- * The listed run-time parameters are in general available,
- * but we point out that a certain model might not be able
- * to use every parameter!
- * \htmlinclude parameters.html
-*/
diff --git a/doc/doxygen/extradoc/parameterlist.txt b/doc/doxygen/extradoc/parameterlist.txt
new file mode 100644
index 0000000000..caa8e286b6
--- /dev/null
+++ b/doc/doxygen/extradoc/parameterlist.txt
@@ -0,0 +1,11 @@
+/*!
+ *\file
+ *\ingroup Parameter
+ *
+ *\brief List of currently useable run-time parameters
+ *
+ * The listed run-time parameters are in general available,
+ * but we point out that a certain model might not be able
+ * to use every parameter!
+ * \htmlinclude parameters.html
+ */
diff --git a/doc/doxygen/mainpage b/doc/doxygen/mainpage.txt
similarity index 100%
rename from doc/doxygen/mainpage
rename to doc/doxygen/mainpage.txt
diff --git a/doc/doxygen/modules b/doc/doxygen/modules.txt
similarity index 95%
rename from doc/doxygen/modules
rename to doc/doxygen/modules.txt
index d023f2353e..2414dbe809 100644
--- a/doc/doxygen/modules
+++ b/doc/doxygen/modules.txt
@@ -4,27 +4,27 @@
* \brief This file contains all module definitions for the doxygen documentation.
*/
-/****************** Common ******************/
+/* ***************** Common ******************/
/*!
* \defgroup Common Common Infrastucture
*/
- /*!
+ /*!
* \ingroup Common
* \defgroup BC Boundary Conditions
*/
- /*!
+ /*!
* \ingroup Common
* \defgroup Math Elementary Math Functions
*/
- /*!
+ /*!
* \ingroup Common
* \defgroup Exception Exceptions
*/
- /*!
+ /*!
* \ingroup Common
* \defgroup Linear Linear Solver Backends
*/
- /*!
+ /*!
* \ingroup Common
* \defgroup Newton Newton Solver
*/
@@ -37,7 +37,7 @@
* \ingroup Common
* \defgroup Properties Property System
*/
- /*!
+ /*!
* \ingroup Common
* \defgroup Spline Splines
*/
@@ -45,16 +45,16 @@
* \ingroup Common
* \defgroup Start Starting the Simulation
*/
- /*!
+ /*!
* \ingroup Common
* \defgroup SimControl Time Manager
*/
- /*!
+ /*!
* \ingroup Common
* \defgroup Valgrind Valgrind
*/
-/****************** Material ******************/
+/* ***************** Material ******************/
/*!
* \defgroup Material Material Properties and Laws
*/
@@ -91,7 +91,7 @@
* \defgroup SpatialParameters Spatial Parameters
*/
-/****************** Fully Implicit ******************/
+/* ***************** Fully Implicit ******************/
/*!
* \defgroup ImplicitModel Fully Implicit Scheme
*/
@@ -292,25 +292,25 @@
* \defgroup ImplicitVolumeVariables Volume Variables
*/
-/****************** Sequential ******************/
+/* ***************** Sequential ******************/
/*!
* \defgroup Sequential Sequential Scheme: IMPET (Implicit Pressure Explicit Transport)
*/
-
+
/*!
* \ingroup Sequential
* \defgroup IMPET Models
- */
-
- /*!
- * \ingroup IMPET
- * \defgroup mpfa MPFA framework
- */
-
+ */
+
+ /*!
+ * \ingroup IMPET
+ * \defgroup mpfa MPFA framework
+ */
+
/*!
* \ingroup IMPET
* \defgroup OnePhase Single Phase (FV)
- */
+ */
/*!
* \ingroup OnePhase
* \defgroup Pressure1p Pressure Equation
@@ -318,11 +318,11 @@
/*!
* \ingroup Pressure1p
* \defgroup FV1p Finite Volume
- */
+ */
/*!
* \ingroup IMPET
* \defgroup IMPES Immiscible IMPES
- */
+ */
/*!
* \ingroup IMPES
* \defgroup Pressure2p Immiscible Pressure Equation
@@ -330,11 +330,11 @@
/*!
* \ingroup Pressure2p
* \defgroup FVPressure2p Finite Volume
- */
+ */
/*!
* \ingroup Pressure2p
* \defgroup MimeticPressure2p Mimetic Finite Differences
- */
+ */
/*!
* \ingroup IMPES
* \defgroup Saturation2p Immiscible Saturation Transport
@@ -342,7 +342,7 @@
/*!
* \ingroup Saturation2p
* \defgroup FVSaturation2p Finite Volume
- */
+ */
/*!
* \ingroup IMPET
* \defgroup IMPEC Miscible (Compositional) IMPEC
diff --git a/dumux/io/plotoverline2d.hh b/dumux/io/plotoverline2d.hh
index 4d3bfcc9d3..2f7dbcc428 100644
--- a/dumux/io/plotoverline2d.hh
+++ b/dumux/io/plotoverline2d.hh
@@ -89,7 +89,7 @@ class PlotOverLine2D
typedef Dune::FieldVector<Scalar, dimWorld> GlobalPosition;
public:
- /*
+ /*!
* \brief A function that writes results over a line (like paraview's plotOverline into a text file.)
*
* The writer needs to be called in postTimeStep().
diff --git a/dumux/material/binarycoefficients/brine_co2.hh b/dumux/material/binarycoefficients/brine_co2.hh
index 7df1432031..375b2da2f8 100644
--- a/dumux/material/binarycoefficients/brine_co2.hh
+++ b/dumux/material/binarycoefficients/brine_co2.hh
@@ -528,7 +528,7 @@ private:
*
* \param temperature the temperature \f$\mathrm{[K]}\f$
* \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
- * \param rhoCO2 the density of CO2 for the critical volume \f$\mathrm{[kg/m^3]\f$
+ * \param rhoCO2 the density of CO2 for the critical volume \f$\mathrm{[kg/m^3]}\f$
*/
static Scalar fugacityCoeffCO2_(Scalar temperature,
--
GitLab