#9 Remove some internal free functions from Doxygen scope, and document...

#9 Remove some internal free functions from Doxygen scope, and document instead the enclosing namespace.

Sources/Geometry/Geometry.doxygen

@@ -17,9 +17,28 @@
 /// \namespace HappyHeart::Internal::MeshNS
 /// \brief Namespace that enclose internals related to meshes.
 
+/// \namespace HappyHeart::Internal::MeshNS::FormatNS
+/// \brief Namespace that enclose internals related to the different file format supported for meshes.
+
+/// \namespace HappyHeart::Internal::MeshNS::FormatNS::Medit
+/// \brief Namespace that enclose internals related to Medit file format.
+
+/// \namespace HappyHeart::Internal::MeshNS::FormatNS::Medit::Dispatch
+/// \brief Namespace that enclose free functions used to dispatch Mesh methods depending on the format employed.
+
+/// \namespace HappyHeart::Internal::MeshNS::FormatNS::Ensight
+/// \brief Namespace that enclose internals related to Medit file format.
+
+/// \namespace HappyHeart::Internal::MeshNS::FormatNS::Ensight::Dispatch
+/// \brief Namespace that enclose free functions used to dispatch Mesh methods depending on the format employed.
+
+
+
 /// \namespace HappyHeart::Internal::ColoringNS
 /// \brief Namespace that enclose internals related to coloring of a mesh (in which two connected vertices must not
 /// share the same color; this is useful for shared memory parallelism).
 
+
+
 ///@} // addtogroup
 

Sources/Geometry/Mesh/Internal/Coloring.hpp

@@ -58,10 +58,12 @@ namespace HappyHeart
             
             
             /*!
-             * \brief Compute for each vertex the list of GeometricElements of a given dimension to which it belongs to.
+             * \brief Compute for each vertex the list of \a GeometricElt of a given dimension to which it belongs to.
              *
-             * \param[in] geometric_mesh_region Geometric mesh region in which the computation is performed.
+             * \param[in] geometric_mesh_region \a GeometricMeshRegion in which the computation is performed.
              * \param[in] dimension Only geometric elements of this dimension are considered.
+             *
+             * \return Key is the \a Vertex, value the list of \a GeometricElt to which the \a Vertex belongs to.
              */
             std::unordered_map<Vertex::shared_ptr, GeometricElt::vector_shared_ptr>
             ComputeGeometricElementForEachVertex(const GeometricMeshRegion& geometric_mesh_region,

Sources/Geometry/Mesh/Internal/Format/Dispatch/Ensight.hpp

@@ -42,6 +42,11 @@ namespace HappyHeart
                     namespace Dispatch
                     {
                     
+                        
+                        // ============================
+                        //! \cond IGNORE_BLOCK_IN_DOXYGEN
+                        // ============================
+                        
                     
                         template<class GeoRefEltT>
                         [[noreturn]] const std::string& GetName(std::false_type);
@@ -65,6 +70,11 @@ namespace HappyHeart
                                                       const Coords::vector_shared_ptr& coords_list);
                         
                         
+                        // ============================
+                        //! \endcond IGNORE_BLOCK_IN_DOXYGEN
+                        // ============================
+                        
+                        
                     } // namespace Dispatch
 
                     

Sources/Geometry/Mesh/Internal/Format/Dispatch/Medit.hpp

@@ -41,6 +41,11 @@ namespace HappyHeart
                     
                     namespace Dispatch
                     {
+                        
+                        
+                        // ============================
+                        //! \cond IGNORE_BLOCK_IN_DOXYGEN
+                        // ============================
                     
                     
                         template<class GeoRefEltT>
@@ -80,6 +85,11 @@ namespace HappyHeart
                                                               int& label_index);
                         
                         
+                        // ============================
+                        //! \endcond IGNORE_BLOCK_IN_DOXYGEN
+                        // ============================
+                        
+                        
                     } // namespace Dispatch