diff --git a/doc/doxygen/Doxylocal b/doc/doxygen/Doxylocal index fdf93dba23209f93042be2ba7964fa980a9f71c7..3c967ad92346c08bb8b5eae0c5fcdc48188e5f38 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 6fbf8fc8440e005eb4b0eeee9d6d20a2823497f3..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..caa8e286b6acd44eb04d5a709129c1854c07e9a5 --- /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 d023f2353e6c55bcad0494d6719fc2ccb5c7e498..2414dbe80966720e2dfc061fd074d3d0049d9651 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 4d3bfcc9d3db28a1dcff014c3f8e0204adcb93a1..2f7dbcc428638f33306fb51308cadd9d2ae85cb0 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 7df143203174de4c1f1ae90f8e7ae14dce917a6e..375b2da2f87a53d4a9558c34a4d79e04951b3f37 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,