Attention une mise à jour du service Gitlab va être effectuée le mardi 30 novembre entre 17h30 et 18h00. Cette mise à jour va générer une interruption du service dont nous ne maîtrisons pas complètement la durée mais qui ne devrait pas excéder quelques minutes. Cette mise à jour intermédiaire en version 14.0.12 nous permettra de rapidement pouvoir mettre à votre disposition une version plus récente.

Commit 6a9cb82d authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Doxygen: add some comments.

parent 9deb37f9
......@@ -64,6 +64,7 @@ namespace HappyHeart
* yields an exception or not. Should be 'yes' most of the time; I have introduced the 'no' option for
* cases in which we need only a handful of parameters shared by all models for post-processing
* purposes (namely mesh-related ones).
* \copydoc doxygen_hide_mpi_param
*/
explicit InputParameterList(const std::string& filename,
const Wrappers::Mpi& mpi,
......
//! \file
//
//
#ifndef HAPPY_HEART_x_MODEL_x_MODEL_HPP_
# define HAPPY_HEART_x_MODEL_x_MODEL_HPP_
......@@ -175,6 +179,8 @@ namespace HappyHeart
* model.Finalize();
*
* \endcode
*
* \copydoc doxygen_hide_input_parameter_data_arg
*/
template<class InputParameterDataT>
void Run(const InputParameterDataT& input_parameter_data);
......
//! \file
//
////
// InitializeHelper.hpp
// HappyHeart
//
......@@ -24,15 +26,16 @@ namespace HappyHeart
namespace Private
{
/*!
* \brief Create the finite element spaces and init the god of dofs with them.
*
* \copydoc doxygen_hide_input_parameter_data_arg
* \copydetails doxygen_hide_do_consider_processor_wise_local_2_global
*/
template<class InputParameterDataT>
void InitGodOfDof(const InputParameterDataT& input_parameter_data,
DoConsiderProcessorWiseLocal2Global do_consider_proc_wise_local_2_global);
DoConsiderProcessorWiseLocal2Global do_consider_processor_wise_local_2_global);
......@@ -40,6 +43,9 @@ namespace HappyHeart
* \brief Create all the finite element spaces.
*
* \internal <b><tt>[internal]</tt></b> Should not be called outside of InitGodOfDof().
*
* \copydoc doxygen_hide_input_parameter_data_arg
*/
template<class InputParameterDataT>
void CreateFEltSpaceList(const InputParameterDataT& input_parameter_data,
......@@ -50,11 +56,14 @@ namespace HappyHeart
* \brief Init each god of dof with its finite element spaces.
*
* \internal <b><tt>[internal]</tt></b> Should not be called outside of InitGodOfDof().
*
* \copydoc doxygen_hide_input_parameter_data_arg
* \copydetails doxygen_hide_do_consider_processor_wise_local_2_global
*/
template<class InputParameterDataT>
void InitEachGodOfDof(const InputParameterDataT& input_parameter_data,
std::map<unsigned int, FEltSpace::vector_unique_ptr>& felt_space_list_per_god_of_dof_index,
DoConsiderProcessorWiseLocal2Global do_consider_proc_wise_local_2_global);
DoConsiderProcessorWiseLocal2Global do_consider_processor_wise_local_2_global);
......
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