Skip to content
Snippets Groups Projects
Commit 347a250c authored by Kilian Weishaupt's avatar Kilian Weishaupt
Browse files

[fix] Fix some more doxygen parameter descriptions

parent 0af2977f
No related branches found
No related tags found
1 merge request!72Cleanup/doxygen
...@@ -297,6 +297,7 @@ public: ...@@ -297,6 +297,7 @@ public:
/*! /*!
* \brief Return concentration \f$\mathrm{[mol/m^3]}\f$ of a component in the phase. * \brief Return concentration \f$\mathrm{[mol/m^3]}\f$ of a component in the phase.
* *
* \param phaseIdx The phase index
* \param compIdx The index of the component * \param compIdx The index of the component
*/ */
Scalar molarity(const int phaseIdx, int compIdx) const Scalar molarity(const int phaseIdx, int compIdx) const
...@@ -304,6 +305,8 @@ public: ...@@ -304,6 +305,8 @@ public:
/*! /*!
* \brief Return molar density \f$\mathrm{[mol/m^3]}\f$ the of the fluid phase. * \brief Return molar density \f$\mathrm{[mol/m^3]}\f$ the of the fluid phase.
*
* \param phaseIdx The phase index
*/ */
Scalar molarDensity(const int phaseIdx) const Scalar molarDensity(const int phaseIdx) const
{ return fluidState_.molarDensity(phaseIdx);} { return fluidState_.molarDensity(phaseIdx);}
...@@ -311,12 +314,16 @@ public: ...@@ -311,12 +314,16 @@ public:
/*! /*!
* \brief Return the effective pressure \f$\mathrm{[Pa]}\f$ of a given phase within * \brief Return the effective pressure \f$\mathrm{[Pa]}\f$ of a given phase within
* the control volume. * the control volume.
*
* \param phaseIdx The phase index
*/ */
Scalar pressure(const int phaseIdx) const Scalar pressure(const int phaseIdx) const
{ return fluidState_.pressure(phaseIdx); } { return fluidState_.pressure(phaseIdx); }
/*! /*!
* \brief Return density \f$\mathrm{[kg/m^3]}\f$ the of the fluid phase. * \brief Return density \f$\mathrm{[kg/m^3]}\f$ the of the fluid phase.
*
* \param phaseIdx The phase index
*/ */
Scalar density(const int phaseIdx) const Scalar density(const int phaseIdx) const
{ return fluidState_.density(phaseIdx); } { return fluidState_.density(phaseIdx); }
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment