Commit cce7fed9 authored by Melanie Lipp's avatar Melanie Lipp Committed by Timo Koch
Browse files

[doc] Remove doxygen errors.

parent 35c9377c
...@@ -74,7 +74,7 @@ public: ...@@ -74,7 +74,7 @@ public:
* \param b upper limit of integration * \param b upper limit of integration
* \param targetAbsoluteError desired bound on error * \param targetAbsoluteError desired bound on error
* \param numFunctionEvaluations number of function evaluations used * \param numFunctionEvaluations number of function evaluations used
* \param f errorEstimate estimate for error in integration * \param errorEstimate estimate for error in integration
* \return The value of the integral * \return The value of the integral
*/ */
template<class Function, template<class Function,
......
...@@ -1293,7 +1293,7 @@ public: ...@@ -1293,7 +1293,7 @@ public:
/*! /*!
* \brief Colliding two segments in 3D * \brief Colliding two segments in 3D
* \param geo1/geo2 The geometries to intersect * \param geo1/geo2 The geometries to intersect
* \param is If the geometries collide, is holds the corner points of * \param intersection If the geometries collide, is holds the corner points of
* the intersection object in global coordinates. * the intersection object in global coordinates.
* \note This overload is used when segment-like intersections are seeked * \note This overload is used when segment-like intersections are seeked
*/ */
......
...@@ -256,8 +256,8 @@ auto integrateL2Error(const GridView& gv, ...@@ -256,8 +256,8 @@ auto integrateL2Error(const GridView& gv,
/*! /*!
* \brief Integrate a scalar function * \brief Integrate a scalar function
* \param f the integrand (invocable with a single scalar) * \param f the integrand (invocable with a single scalar)
* \param a lower integral bound * \param lowerBound lower integral bound
* \param b upper integral bound * \param upperBound upper integral bound
* \param targetAbsoluteError desired absolute error in the result * \param targetAbsoluteError desired absolute error in the result
* \return The value of the integral * \return The value of the integral
*/ */
......
...@@ -759,7 +759,7 @@ public: ...@@ -759,7 +759,7 @@ public:
/*! /*!
* \brief communicates values for the sparsity pattern of the new matrix. * \brief communicates values for the sparsity pattern of the new matrix.
* \param A Matrix to operate on. * \param A Matrix to operate on.
* \param helper ParallelelISTLHelper. * \param isGhost Function returning if is ghost.
*/ */
template<class IsGhostFunc> template<class IsGhostFunc>
void extendMatrix(Matrix& A, const IsGhostFunc& isGhost) void extendMatrix(Matrix& A, const IsGhostFunc& isGhost)
......
...@@ -389,9 +389,7 @@ public: ...@@ -389,9 +389,7 @@ public:
* \brief Calculate the binary molecular diffusion coefficient for * \brief Calculate the binary molecular diffusion coefficient for
* a component in a fluid phase \f$\mathrm{[mol^2 * s / (kg*m^3)]}\f$ * a component in a fluid phase \f$\mathrm{[mol^2 * s / (kg*m^3)]}\f$
* \param fluidState The fluid state * \param fluidState The fluid state
* \param paramCache mutable parameters
* \param phaseIdx Index of the fluid phase * \param phaseIdx Index of the fluid phase
* \param compIdx Index of the component
* Molecular diffusion of a component \f$\mathrm{\kappa}\f$ is caused by a * Molecular diffusion of a component \f$\mathrm{\kappa}\f$ is caused by a
* gradient of the chemical potential and follows the law * gradient of the chemical potential and follows the law
* *
......
...@@ -284,6 +284,7 @@ public: ...@@ -284,6 +284,7 @@ public:
* \param element * \param element
* \param fvGeometry * \param fvGeometry
* \param elemVolVars * \param elemVolVars
* \param elemFluxVarsCache
* \param scvf * \param scvf
*/ */
NeumannFluxes neumann(const Element& element, NeumannFluxes neumann(const Element& element,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment