Commit 9a8fbd6a authored by GILLES Sebastien's avatar GILLES Sebastien

#1497 Fix a small Doxygen issue.

parent 740667f7
......@@ -154,7 +154,7 @@ namespace MoReFEM
explicit Coords();
/*!
* \class class_doxygen_hide_coords_from_components_params
* \class doxygen_hide_coords_from_components_params
*
* \param[in] x First component.
* \param[in] y Second component.
......@@ -165,12 +165,12 @@ namespace MoReFEM
/*!
* \brief Constructor from components.
*
* \copydoc class_doxygen_hide_coords_from_components_params
* \copydoc doxygen_hide_coords_from_components_params
*/
explicit Coords(double x, double y, double z, const double space_unit);
/*!
* \class class_doxygen_hide_coords_from_array_params
* \class doxygen_hide_coords_from_array_params
*
* \tparam T Must be std::array<Floating-point type, 3>.
* \param[in] value Value of the array to set.
......@@ -181,13 +181,13 @@ namespace MoReFEM
/*!
* \brief Constructor from an array.
*
* \copydoc class_doxygen_hide_coords_from_array_params
* \copydoc doxygen_hide_coords_from_array_params
*/
template<typename T>
explicit Coords(T&& value, const double space_unit);
/*!
* \class class_doxygen_hide_coords_from_stream_params
* \class doxygen_hide_coords_from_stream_params
*
* \param[in] Ncoor Number of coordinates to be read. Expected to be at most 3.
* \param[in,out] stream Stream from which the point is read. Coordinates are expected to be separated by tabs
......@@ -200,7 +200,7 @@ namespace MoReFEM
/*!
* \brief Constructor from a input stream.
*
* \copydoc class_doxygen_hide_coords_from_stream_params
* \copydoc doxygen_hide_coords_from_stream_params
*/
explicit Coords(unsigned int Ncoor, std::istream& stream, const double space_unit);
......
......@@ -52,7 +52,7 @@ namespace MoReFEM
/*!
* \brief Create a \a Coords objets from its three components.
*
* \copydoc class_doxygen_hide_coords_from_components_params
* \copydoc doxygen_hide_coords_from_components_params
*
* \return Pointer to newly created \a Coords.
*/
......@@ -62,7 +62,7 @@ namespace MoReFEM
/*!
* \brief Create a \a Coords objets from its three components.
*
* \copydoc class_doxygen_hide_coords_from_stream_params
* \copydoc doxygen_hide_coords_from_stream_params
*
* \return Pointer to newly created \a Coords.
*/
......@@ -71,7 +71,7 @@ namespace MoReFEM
/*!
* \brief Create a \a Coords objets from a 3D array.
*
* \copydoc class_doxygen_hide_coords_from_array_params
* \copydoc doxygen_hide_coords_from_array_params
*
* \return Pointer to newly created \a Coords.
*/
......
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