Commit c7f05f30 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Fix Doxygen comments related to instances of ParameterOperator.

parent b5ba7137
......@@ -22,6 +22,9 @@ namespace HappyHeart
{
/*!
* \brief Implementation of local \a UpdateCauchyGreenTensor operator.
*/
class UpdateCauchyGreenTensor final
: public Advanced::LocalParameterOperator<ParameterNS::Type::vector>
{
......
......@@ -25,6 +25,9 @@ namespace HappyHeart
{
/*!
* \brief Local operator in charge of updating fiber deformation.
*/
class UpdateFiberDeformation final
: public Advanced::LocalParameterOperator<ParameterNS::Type::scalar>
{
......
......@@ -25,8 +25,7 @@ namespace HappyHeart
/*!
* \brief Implementation of global UpdateCauchyGreenTensor operator.
*
* \brief Implementation of global \a UpdateCauchyGreenTensor operator.
*/
class UpdateCauchyGreenTensor final
: public GlobalParameterOperator
......@@ -66,7 +65,6 @@ namespace HappyHeart
*
* \param[in] felt_space Finite element space upon which the operator is defined.
* \param[in] unknown Unknown considered for this operator (might be vector or vectorial).
* \param[in] geom_mesh_region_dimension Dimension of the geometric mesh region considered.
* \param[in,out] cauchy_green_tensor Cauchy Green tensor which is to be updated by present operator.
* Size of a local vector inside must be 3 for a 2D mesh and 6 for a 3D one.
* \copydoc doxygen_hide_quadrature_rule_per_topology_nullptr_arg
......
......@@ -76,7 +76,9 @@ namespace HappyHeart
*
* \param[in] felt_space Finite element space upon which the operator is defined.
* \param[in] unknown Unknown considered for this operator (might be scalar or vectorial).
* \param[in] geom_mesh_region_dimension Dimension of the geometric mesh region considered.
* \param[in,out] fiber_deformation Fiber deformation parameter, which is updated by present class.
* \param[in] contraction_rheology_residual Contraction rheology residual.
* \param[in] schur_complement Schur complement.
* \copydoc doxygen_hide_quadrature_rule_per_topology_nullptr_arg
*/
explicit UpdateFiberDeformation(const FEltSpace& felt_space,
......
......@@ -22,7 +22,7 @@ namespace HappyHeart
{
/// \addtogroup Parameters
/// \addtogroup Parameter
///@{
......
Markdown is supported
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