improve the doxygen documentation

the module hierarchy should now even be mildly useful.
This commit is contained in:
Andreas Lauser 2015-06-18 14:18:42 +02:00
parent b974549f05
commit c67169ebd3

View File

@ -49,7 +49,7 @@ template <class TypeTag>
class EclTransBaseProblem; class EclTransBaseProblem;
/*! /*!
* \ingroup EclTransmissibility * \ingroup EclBlackOilSimulator
* \brief Specifies a flux module which uses ECL transmissibilities. * \brief Specifies a flux module which uses ECL transmissibilities.
*/ */
template <class TypeTag> template <class TypeTag>
@ -67,7 +67,7 @@ struct EclTransFluxModule
}; };
/*! /*!
* \ingroup EclTransmissibility * \ingroup EclBlackOilSimulator
* \brief Provides the defaults for the parameters required by the * \brief Provides the defaults for the parameters required by the
* transmissibility based volume flux calculation. * transmissibility based volume flux calculation.
*/ */
@ -76,7 +76,7 @@ class EclTransBaseProblem
{ }; { };
/*! /*!
* \ingroup EclTransmissibility * \ingroup EclBlackOilSimulator
* \brief Provides the intensive quantities for the ECL flux module * \brief Provides the intensive quantities for the ECL flux module
*/ */
template <class TypeTag> template <class TypeTag>
@ -89,7 +89,7 @@ protected:
}; };
/*! /*!
* \ingroup EclTransmissibility * \ingroup EclBlackOilSimulator
* \brief Provides the ECL flux module * \brief Provides the ECL flux module
*/ */
template <class TypeTag> template <class TypeTag>