Commit e229abc2 authored by GILLES Sebastien's avatar GILLES Sebastien

#1483 Fix new Doxygen warnings that appeared with new version.

parent e9d63a03
......@@ -31,8 +31,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup CoreGroup
/// @} // addtogroup CoreGroup
#endif // MOREFEM_x_CORE_x_SPATIAL_LUA_FUNCTION_HPP_
......@@ -139,10 +139,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup FormulationSolverGroup
/// @} // addtogroup ParametersGroup
/// @} // addtogroup FormulationSolverGroup
# include "FormulationSolver/Internal/InitialCondition/Policy/Constant.hxx"
......
......@@ -91,7 +91,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup FormulationSolverGroup
/// @} // addtogroup FormulationSolverGroup
/// @} // addtogroup ParametersGroup
......
......@@ -175,10 +175,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup FormulationSolverGroup
/// @} // addtogroup ParametersGroup
/// @} // addtogroup FormulationSolverGroup
# include "FormulationSolver/Internal/InitialCondition/Policy/LuaFunction.hxx"
......
......@@ -99,7 +99,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup FormulationSolverGroup
/// @} // addtogroup FormulationSolverGroup
/// @} // addtogroup ParametersGroup
......
......@@ -468,6 +468,8 @@ namespace MoReFEM
unsigned int Ncoord_in_mesh,
int& reference_index) = 0;
//@}
protected:
......@@ -616,10 +618,6 @@ namespace MoReFEM
} // namespace MoReFEM
/// @} // addtogroup GeometryGroup
namespace std
{
......@@ -644,7 +642,7 @@ namespace std
} // namespace std
// @} // addtogroup GeometryGroup
/// @} // addtogroup GeometryGroup
# include "Geometry/GeometricElt/GeometricElt.hxx"
......
......@@ -24,4 +24,4 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup ModelGroup
/// @} // addtogroup ModelGroup
......@@ -217,7 +217,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup OperatorInstancesGroup
/// @} // addtogroup OperatorInstancesGroup
# include "OperatorInstances/VariationalOperator/NonlinearForm/QuasiIncompressibleSecondPiolaKirchhoffStressTensor.hxx"
......
......@@ -280,7 +280,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup OperatorInstancesGroup
/// @} // addtogroup OperatorInstancesGroup
#endif // MOREFEM_x_OPERATOR_INSTANCES_x_VARIATIONAL_OPERATOR_x_NONLINEAR_FORM_x_QUASI_INCOMPRESSIBLE_SECOND_PIOLA_KIRCHHOFF_STRESS_TENSOR_HXX_
......@@ -66,5 +66,5 @@ namespace // anonymous
} // namespace anonymous
// @} // addtogroup ParameterInstancesGroup
/// @} // addtogroup ParameterInstancesGroup
......@@ -67,7 +67,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup ParameterInstancesGroup
/// @} // addtogroup ParameterInstancesGroup
# include "ParameterInstances/Compound/Solid/Exceptions/Solid.hxx"
......
......@@ -31,7 +31,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup ParameterInstancesGroup
/// @} // addtogroup ParameterInstancesGroup
#endif // MOREFEM_x_PARAMETER_INSTANCES_x_COMPOUND_x_SOLID_x_EXCEPTIONS_x_SOLID_HXX_
......@@ -237,9 +237,6 @@ namespace MoReFEM
/// @} // addtogroup ParameterInstancesGroup
/// @} // addtogroup ParametersGroup
# include "ParameterInstances/ScalarParameterFromFile/ScalarParameterFromFile.hxx"
......
......@@ -155,17 +155,6 @@ namespace MoReFEM
/*!
* \brief Update the value for the new time iteration.
*
* \copydetails AtQuadraturePoint::UpdateAndGetValue()
*/
template<class UpdateFunctorT>
void UpdateValue(const QuadraturePoint& quad_pt,
const GeometricElt& geom_elt,
const UpdateFunctorT& update_functor);
/*!
* \brief Update the value for the new time iteration and returns it.
*
* \internal <b><tt>[internal]</tt></b> This method is not an override: it can only be used when the
* Parameter object is STATICALLY a child of AtQuadraturePointPolicy.
*
......@@ -182,6 +171,17 @@ namespace MoReFEM
* \endcode
* For instance, argument type \a storage_value_type is \a double& for TypeT = \a scalar, \a LocalVector&
* for TypeT = \a vector and \a LocalMatrix& for TypeT = \a matrix.
*/
template<class UpdateFunctorT>
void UpdateValue(const QuadraturePoint& quad_pt,
const GeometricElt& geom_elt,
const UpdateFunctorT& update_functor);
/*!
* \brief Update the value for the new time iteration and returns it.
*
* \copydetails AtQuadraturePoint::UpdateValue()
*
* \return Updated value.
*/
......@@ -191,7 +191,6 @@ namespace MoReFEM
const UpdateFunctorT& update_functor);
//! Copy the content of another \a AtQuadraturePoint.
//! \param[in] parameter_at_quad_point \a Parameter which data are copied.
void Copy(const AtQuadraturePoint& parameter_at_quad_point);
......
......@@ -218,7 +218,6 @@ namespace MoReFEM
//! Material parameters of the solid.
Solid::const_unique_ptr solid_ = nullptr;
///@}
private:
......
......@@ -104,10 +104,10 @@ namespace MoReFEM
Viewer(const Viewer& rhs) = delete;
//! \copydoc doxygen_hide_move_constructor
Viewer& operator=(const Viewer& rhs) = delete;
Viewer(Viewer&& rhs) = delete;
//! \copydoc doxygen_hide_copy_affectation
Viewer(Viewer&& rhs) = delete;
Viewer& operator=(const Viewer& rhs) = delete;
//! \copydoc doxygen_hide_move_affectation
Viewer& operator=(Viewer&& rhs) = delete;
......
......@@ -117,7 +117,4 @@ namespace Seldon
PRAGMA_DIAGNOSTIC(pop)
/// @} // addtogroup ThirdPartyGroup
#endif // MOREFEM_x_THIRD_PARTY_x_WRAPPERS_x_SELDON_x_SUB_VECTOR_HPP_
......@@ -62,4 +62,4 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup ThirdPartyGroup
/// @} // addtogroup ThirdPartyGroup
......@@ -126,7 +126,7 @@ namespace TCLAP
} // namespace TCLAP
// @} // addtogroup ThirdPartyGroup
/// @} // addtogroup ThirdPartyGroup
# include "ThirdParty/Wrappers/Tclap/StringPair.hxx"
......
......@@ -43,7 +43,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup ThirdPartyGroup
/// @} // addtogroup ThirdPartyGroup
#endif // MOREFEM_x_THIRD_PARTY_x_WRAPPERS_x_TCLAP_x_STRING_PAIR_HXX_
......@@ -28,18 +28,24 @@ namespace MoReFEM::FilesystemNS
/*!
* \class doxygen_hide_directory_behaviour_desc
*
* - overwrite: Remove the pre-existing one and recreate it.
* - ask: Ask the end user if he wants to override or not. If he chooses not to do so, the program ends.
* <ul>
* <li> overwrite: Remove the pre-existing one and recreate it.</li>
* <li> quit: Quit the program if the directory exists.</li>
* <li> ignore: Do not create the directory and use the existing one (including possible previous content).</li>
* <li> read: this mode expects the directory to exist and throws an exception otherwise.</li>
* <li> create: create a new directory - it is expected here it doesn't exist yet (and an exception is thrown if it
* does). </li>
* <li> ask: Ask the end user if he wants to override or not. If he chooses not to do so, the program ends.
* Mpi is properly handled (the interface is properly rerouted to root processor which is the sole able to
* communicate with stdin).
* - quit: Quit the program if the directory exists.
* - ignore: Do not create the directory and use the existing one (including possible previous content).
* - read: this mode expects the directory to exist and throws an exception otherwise.
* - create: create a new directory - it is expected here it doesn't exist yet (and an exception is thrown if it
* does).
* communicate with stdin).</li>
* </ul>
*/
/*
*/
/*!
* \brief Enum class to determine how to handle the case
*
......
......@@ -548,4 +548,4 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup UtilitiesGroup
/// @} // addtogroup UtilitiesGroup
......@@ -244,7 +244,6 @@ namespace MoReFEM
* \copydoc doxygen_hide_lua_option_file_constraint
* \copydoc doxygen_hide_invoking_file_and_line
*
* \return True if the constraint is satisfied, false otherwise.
*/
template<class StringT>
void CheckConstraint(StringT&& entry_name, const std::string& constraint,
......@@ -318,7 +317,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup UtilitiesGroup
/// @} // addtogroup UtilitiesGroup
# include "Utilities/LuaOptionFile/LuaOptionFile.hxx"
......
......@@ -332,7 +332,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup UtilitiesGroup
/// @} // addtogroup UtilitiesGroup
#endif // MOREFEM_x_UTILITIES_x_LUA_OPTION_FILE_x_LUA_OPTION_FILE_HXX_
......@@ -38,7 +38,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup UtilitiesGroup
/// @} // addtogroup UtilitiesGroup
# include "Utilities/Type/PrintTypeName.hxx"
......
......@@ -38,7 +38,7 @@ namespace MoReFEM
} // namespace MoReFEM
// @} // addtogroup UtilitiesGroup
/// @} // addtogroup UtilitiesGroup
#endif // MOREFEM_x_UTILITIES_x_TYPE_x_PRINT_TYPE_NAME_HXX_
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