Commit b9247714 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Doxygen: add Node, NodeBearer, Dof and LocalNode to FElt group.

parent d869299f
......@@ -16,6 +16,10 @@
/// \namespace HappyHeart::Internal::FEltSpaceNS
/// \brief Namespace that enclose library's developer tools related to \a FEltSpace.
/// \namespace HappyHeart::ExceptionNS::Dof
/// \brief Namespace that enclose Dof-related exceptions.
///@}
......
......@@ -41,6 +41,10 @@ namespace HappyHeart
// ============================
/// \addtogroup FElt
///@{
/*!
* \brief Class in charge of dof informations.
*
......@@ -249,6 +253,9 @@ namespace HappyHeart
bool operator==(const Dof& dof1, const Dof& dof2);
///@} // \addtogroup
} // namespace HappyHeart
......
......@@ -24,10 +24,14 @@
namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief A LocalNode is the pendant of a geometric interface in a BasicRefFElt.
* \brief A LocalNode is the pendant of a geometric interface in a \a BasicRefFElt.
*/
class LocalNode final
{
......@@ -105,7 +109,9 @@ namespace HappyHeart
bool operator<(const LocalNode& lhs, const LocalNode& rhs);
///@} // \addtogroup
} // namespace HappyHeart
......
......@@ -39,6 +39,10 @@ namespace HappyHeart
// ============================
/// \addtogroup FElt
///@{
/*!
* \brief A Node is an ensemble of Dofs located at the same place and addressing the same unknown and shape function
* label.
......@@ -142,6 +146,9 @@ namespace HappyHeart
bool operator==(const Node& lhs, const Node& rhs);
///@} // \addtogroup
} // namespace HappyHeart
......
......@@ -62,6 +62,9 @@ namespace HappyHeart
// ============================
/// \addtogroup FElt
///@{
//! Enum to list all the possible choices available to number the dofs.
enum class DofNumberingScheme
{
......@@ -244,6 +247,8 @@ namespace HappyHeart
bool operator==(const NodeBearer& node1, const NodeBearer& node2);
///@} // \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