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

#9 Doxygen: add Unknown related stuff to FElt group.

parent b9247714
......@@ -18,6 +18,10 @@ namespace HappyHeart
namespace UnknownNS
{
/// \addtogroup FElt
///@{
/*!
......@@ -29,6 +33,9 @@ namespace HappyHeart
vectorial = 1
};
///@} // \addtogroup
} // namespace UnknownNS
......
......@@ -17,8 +17,13 @@
namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief This class encapsulates an unknown in a given finite element space.
*
......@@ -97,6 +102,9 @@ namespace HappyHeart
//! Two such objects are equal if both unknown and numbering subset are the same.
bool operator==(const ExtendedUnknown& lhs, const ExtendedUnknown& rhs);
///@} // \addtogroup
} // namespace HappyHeart
......
......@@ -43,6 +43,9 @@ namespace HappyHeart
// ============================
/// \addtogroup FElt
///@{
/*!
* \brief Very generic informations about a given unknown.
......@@ -139,6 +142,9 @@ namespace HappyHeart
const unsigned int mesh_dimension);
///@} // \addtogroup
} // namespace HappyHeart
......
......@@ -28,6 +28,10 @@
namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief Singleton that is aware of all considered unknown, regardless of GodOfDof.
......@@ -146,6 +150,9 @@ namespace HappyHeart
*/
void WriteUnknownList(const std::string& output_directory);
///@} // \addtogroup
} // namespace HappyHeart
......
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