Commit 02aa0663 authored by GILLES Sebastien's avatar GILLES Sebastien

#859 Fix Doxygen warnings.

parent 967b2108
......@@ -44,6 +44,7 @@ namespace MoReFEM
{
//! Enum class used in some methods that might eother print default value or a value stored elsewhere.
enum class print_default_value { yes, no };
......@@ -132,9 +133,13 @@ namespace MoReFEM
/*!
* \brief Prepare default entry for a given input parameter.
* \brief Prepareentry for a given input parameter/.
*
* \tparam DoPrintDefaultValueT If yes, print the default value for each tuple item. If false, print
* the value from \a input_data
* \param[in,out] parameter_block_per_identifier List of key/default value for input data items.
* \param[in] input_data Should be nullptr if DoPrintDefaultValueT is yes. Otherwise, object which
* values are to be printed.
*/
template<print_default_value DoPrintDefaultValueT, class InputDataT>
static void PrepareEntry(std::vector<std::pair<std::string, std::string>>&
......@@ -441,6 +446,12 @@ namespace MoReFEM
void PrepareDefaultEntries(std::ostream& stream);
/*!
* \brief Print the content of \a input_data onto the \a stream.
*
* \copydoc doxygen_hide_input_data_arg
* \copydoc doxygen_hide_stream_inout
*/
template<class InputDataT>
void PrintContent(const InputDataT& input_data,
std::ostream& stream);
......
......@@ -28,7 +28,7 @@ namespace MoReFEM
* Doing so might be useful to make sure the comments are up-to-date: if the documentation of the fields has changed
* you will get the latest version this way. It will also trim fields that were in fact not used in the model.
*
* \copydoc
* \copydoc doxygen_hide_input_data_arg
*/
template<class InputDataT>
void RewriteInputDataFile(const InputDataT& input_data);
......
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