[doxygen] Adapt documentation and ingroups in material

dumux/material/binarycoefficients/air_mesitylene.hh

@@ -27,10 +27,8 @@
 #include <dumux/material/components/air.hh>
 #include <dumux/material/components/mesitylene.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -113,7 +111,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/air_xylene.hh

@@ -27,10 +27,8 @@
 #include <dumux/material/components/air.hh>
 #include <dumux/material/components/xylene.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -111,7 +109,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/brine_co2.hh

@@ -620,7 +620,7 @@ private:
     }
 
 };
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/fullermethod.hh

@@ -20,19 +20,16 @@
  * \file
  * \ingroup Binarycoefficients
  * \brief Various relations for molecular diffusion coefficients.
- *
- * \copydetails Dumux::fullerMethod()
  */
 #ifndef DUMUX_FULLERMETHOD_HH
 #define DUMUX_FULLERMETHOD_HH
 
 #include <dumux/common/math.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 /*!
+ * \ingroup Binarycoefficients
  * \brief Estimate binary diffusion coefficients \f$\mathrm{[m^2/s]}\f$ in gases according to
  *        the method by Fuller.
  *

dumux/material/binarycoefficients/h2o_air.hh

@@ -26,11 +26,8 @@
 
 #include <cmath>
 
-
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -109,7 +106,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/h2o_ch4.hh

@@ -18,7 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
- *
+ * \ingroup Binarycoefficients
  * \brief Binary coefficients for water and methane.
  */
 #ifndef DUMUX_BINARY_COEFF_H2O_CH4_HH
@@ -30,10 +30,8 @@
 #include <dumux/material/components/ch4.hh>
 #include <dumux/material/components/h2o.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -106,7 +104,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/h2o_constant.hh

@@ -30,11 +30,8 @@
 #include <dumux/material/components/h2o.hh>
 #include <dumux/material/components/constant.hh>
 
-namespace Dumux
-{
-
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -52,6 +49,7 @@ class H2O_Component
 };
 
 /*!
+ * \ingroup Binarycoefficients
  * \brief Binary coefficients for water and a constant component
  */
 template<class Scalar, int id>
@@ -105,7 +103,6 @@ public:
 };
 
 } // end namespace BinaryCoeff
-
 } // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/h2o_heavyoil.hh

@@ -27,10 +27,8 @@
 #include <dumux/material/components/h2o.hh>
 #include <dumux/material/components/heavyoil.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -95,7 +93,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/h2o_mesitylene.hh

@@ -27,10 +27,8 @@
 #include <dumux/material/components/h2o.hh>
 #include <dumux/material/components/mesitylene.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -119,7 +117,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/h2o_n2.hh

@@ -30,10 +30,8 @@
 #include <dumux/material/components/n2.hh>
 #include <dumux/material/components/h2o.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -105,7 +103,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/h2o_o2.hh

@@ -30,10 +30,8 @@
 #include <dumux/material/components/o2.hh>
 #include <dumux/material/components/h2o.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -104,7 +102,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/h2o_xylene.hh

@@ -27,10 +27,8 @@
 #include <dumux/material/components/h2o.hh>
 #include <dumux/material/components/xylene.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -120,7 +118,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/binarycoefficients/henryiapws.hh

@@ -26,9 +26,9 @@
 
 #include <dumux/material/components/h2o.hh>
 
-namespace Dumux
-{
+namespace Dumux {
 /*!
+ * \ingroup Binarycoefficients
  * \brief The Henry constants in liquid water using the IAPWS 2004
  *        formulation.
  * \param E Correlation parameter

dumux/material/binarycoefficients/n2_o2.hh

@@ -30,10 +30,8 @@
 #include <dumux/material/components/o2.hh>
 #include <dumux/material/components/n2.hh>
 
-namespace Dumux
-{
-namespace BinaryCoeff
-{
+namespace Dumux {
+namespace BinaryCoeff {
 
 /*!
  * \ingroup Binarycoefficients
@@ -84,7 +82,7 @@ public:
     }
 };
 
-}
-} // end namespace
+} // end namespace BinaryCoeff
+} // end namespace Dumux
 
 #endif

dumux/material/chemistry/electrochemistry/electrochemistry.hh

@@ -42,6 +42,7 @@ namespace Dumux {
 enum ElectroChemistryModel { Ochs, Acosta };
 
 /*!
+ * \ingroup Chemistry
  * \brief This class calculates source terms and current densities for fuel cells
  * with the electrochemical models suggested by Ochs (2008) \cite ochs2008 or Acosta et al. (2006) \cite A3:acosta:2006
  * \todo TODO: Scalar type should be extracted from VolumeVariables!
@@ -281,6 +282,6 @@ private:
     }
 };
 
-}// end namespace
+} // end namespace Dumux
 
 #endif

dumux/material/chemistry/electrochemistry/electrochemistryni.hh

@@ -94,6 +94,6 @@ public:
     }
 };
 
-}// end namespace
+} // end namespace Dumux
 
 #endif

dumux/material/components/air.hh

@@ -346,7 +346,6 @@ public:
 };
 
 } // end namespace Components
-
 } // end namespace Dumux
 
 #endif

dumux/material/components/gas.hh

@@ -32,6 +32,10 @@
 namespace Dumux {
 namespace Components {
 
+/*!
+ * \ingroup Components
+ * \brief Interface for components that have a gas state
+ */
 template<class Scalar, class Component>
 class Gas
 {

dumux/material/components/heavyoil.hh

@@ -20,7 +20,6 @@
  * \file
  * \ingroup Components
  * \brief Properties of the component heavyoil.
- *
  */
 #ifndef DUMUX_HEAVYOIL_HH
 #define DUMUX_HEAVYOIL_HH
@@ -222,7 +221,7 @@ public:
         return refComponentCriticalPressure() * pow((1 + 2*perbutationFactorCriticalPressure())/(1 - 2*perbutationFactorCriticalPressure()),2);
     }
 
-  /*!
+    /*!
      * \brief The saturation vapor pressure in \f$\mathrm{[Pa]}\f$ of
      *
      * \param temperature temperature of component in \f$\mathrm{[K]}\f$

dumux/material/components/iapws/common.hh

@@ -35,14 +35,11 @@
 #include <cmath>
 #include <iostream>
 
-namespace Dumux
-{
-namespace IAPWS
-{
+namespace Dumux {
+namespace IAPWS {
 
 /*!
- *
- *  \ingroup IAPWS
+ * \ingroup IAPWS
  * \brief Implements relations which are common for all regions of the IAPWS '97
  *        formulation.
  *
@@ -238,6 +235,6 @@ public:
 };
 
 } // end namespace IAPWS
-} // end namespace Dune
+} // end namespace Dumux
 
 #endif