From 714ad52b199932548d34eb80ab8f788d91490ea4 Mon Sep 17 00:00:00 2001 From: Benjamin Faigle Date: Thu, 21 Oct 2010 09:40:30 +0000 Subject: [PATCH] improved Doxygen documentation --- dumux/material/binarycoefficients/fullermethod.hh | 8 +++++++- dumux/material/binarycoefficients/h2_n2.hh | 5 ++++- dumux/material/binarycoefficients/h2o_n2.hh | 8 ++------ dumux/material/binarycoefficients/henryiapws.hh | 10 +++++++--- 4 files changed, 20 insertions(+), 11 deletions(-) diff --git a/dumux/material/binarycoefficients/fullermethod.hh b/dumux/material/binarycoefficients/fullermethod.hh index decea899c..fc9f75e0b 100644 --- a/dumux/material/binarycoefficients/fullermethod.hh +++ b/dumux/material/binarycoefficients/fullermethod.hh @@ -16,6 +16,7 @@ /*! * \file * + * \ingroup Binarycoefficients * \brief Various relations for molecular diffusion coefficients. */ #ifndef DUMUX_FULLERMETHOD_HH @@ -29,6 +30,11 @@ namespace BinaryCoeff * \brief Estimate binary diffusion coefficents [m^2/s] in gases according to * the method by Fuller. * + * \param M molar masses [g/mol] + * \param SigmaNu atomic diffusion volume + * \param temperature The temperature [K] + * \param pressure phase pressure [Pa] + * * This function estimates the diffusion coefficents in binary gases * using to the method proposed by Fuller. This method and is only * valid at "low" pressures. @@ -51,6 +57,6 @@ inline Scalar fullerMethod(const Scalar *M, // molar masses [g/mol] } } // end namepace BinaryCoeff -} // end namepace Dune +} // end namepace Dumux #endif diff --git a/dumux/material/binarycoefficients/h2_n2.hh b/dumux/material/binarycoefficients/h2_n2.hh index 7226e1fdb..460ac66be 100644 --- a/dumux/material/binarycoefficients/h2_n2.hh +++ b/dumux/material/binarycoefficients/h2_n2.hh @@ -15,6 +15,7 @@ /*! * \file * + * \ingroup Binarycoefficients * \brief Binary coefficients for hydrogen and nitrogen. */ #ifndef DUMUX_BINARY_COEFF_H2_N2_HH @@ -39,6 +40,8 @@ class H2_N2 public: /*! * \brief Henry coefficent \f$[N/m^2]\f$ for molecular nitrogen in liquid hydrogen. + * + * \param temperature the temperature [K] */ template static Scalar henry(Scalar temperature) @@ -49,7 +52,7 @@ public: /*! * \brief Binary diffusion coefficent [m^2/s] for molecular hydrogen and nitrogen. * - * \copybody fullerMethod() + * \copydetails Dumux::fullerMethod */ template static Scalar gasDiffCoeff(Scalar temperature, Scalar pressure) diff --git a/dumux/material/binarycoefficients/h2o_n2.hh b/dumux/material/binarycoefficients/h2o_n2.hh index 682abd2a9..a526c53e0 100644 --- a/dumux/material/binarycoefficients/h2o_n2.hh +++ b/dumux/material/binarycoefficients/h2o_n2.hh @@ -16,6 +16,7 @@ /*! * \file * + * \ingroup Binarycoefficients * \brief Binary coefficients for water and nitrogen. */ #ifndef DUMUX_BINARY_COEFF_H2O_N2_HH @@ -41,12 +42,7 @@ public: /*! * \brief Henry coefficent \f$[N/m^2]\f$ for molecular nitrogen in liquid water. * - * See: - * - * IAPWS: "Guideline on the Henry's Constant and Vapor-Liquid - * Distribution Constant for Gases in H2O and D2O at High - * Temperatures" - * http://www.iapws.org/relguide/HenGuide.pdf + * \copydetails Dumux::henryIAPWS */ template static Scalar henry(Scalar temperature) diff --git a/dumux/material/binarycoefficients/henryiapws.hh b/dumux/material/binarycoefficients/henryiapws.hh index 3698f2864..c8c30a59f 100644 --- a/dumux/material/binarycoefficients/henryiapws.hh +++ b/dumux/material/binarycoefficients/henryiapws.hh @@ -13,9 +13,15 @@ * * * This program is distributed WITHOUT ANY WARRANTY. * *****************************************************************************/ +/*! + * \ingroup Material + * \defgroup Binarycoefficients + */ + /*! * \file * + * \ingroup Binarycoefficients * \brief The IAPWS formulation of Henry coefficients in water. */ #ifndef DUMUX_HENRY_IAPWS_HH @@ -29,9 +35,7 @@ namespace Dumux * \brief The Henry constants in liquid water using the IAPWS 2004 * formulation. * - * This calculated \f$K_D\f$ from the reference. - * - * See: + * This function calculates \f$K_D\f$, see: * * IAPWS: "Guideline on the Henry's Constant and Vapor-Liquid * Distribution Constant for Gases in H2O and D2O at High