#9 Doxygen: exclude all forward declaration blocks, which seem to bother...

#9 Doxygen: exclude all forward declaration blocks, which seem to bother Doxygen on the topic of missing comments.

Sources/Core/Crtp/NumberingSubsetForMatrix.hpp

@@ -19,7 +19,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -28,6 +29,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/Core/LinearAlgebra/GlobalMatrix.hpp

@@ -24,7 +24,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -33,6 +34,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/Core/LinearAlgebra/GlobalVector.hpp

@@ -22,7 +22,8 @@ namespace HappyHeart
 
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -31,6 +32,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/Core/NumberingSubset.hpp

@@ -24,7 +24,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -40,6 +41,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
 
 

Sources/Core/Private/NumberingSubset.hpp

@@ -22,7 +22,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -31,6 +32,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/FiniteElement/BoundaryConditions/DirichletBoundaryCondition.hpp

@@ -26,10 +26,10 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
-    
     class Domain;
     class GodOfDof;
     class GlobalVector;
@@ -48,6 +48,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/FiniteElement/BoundaryConditions/Private/BoundaryConditionDofStorage.hpp

@@ -27,7 +27,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -36,6 +37,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
 
     

Sources/FiniteElement/FiniteElement/FElt.hpp

@@ -31,7 +31,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
   
     
@@ -50,6 +51,7 @@ namespace HappyHeart
 
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
 
 

Sources/FiniteElement/FiniteElement/LocalFEltSpace.hpp

@@ -31,7 +31,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -69,6 +70,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/FiniteElement/FiniteElement/Private/Local2GlobalStorage.hpp

@@ -26,7 +26,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -35,6 +36,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
 
     

Sources/FiniteElement/FiniteElementSpace/FEltSpace.hpp

@@ -39,7 +39,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -94,6 +95,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
      
     

Sources/FiniteElement/FiniteElementSpace/GodOfDof.hpp

@@ -36,7 +36,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -48,6 +49,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
 
 

Sources/FiniteElement/FiniteElementSpace/Private/BreakCircularDependancy.hpp

@@ -22,27 +22,38 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
     class GodOfDof;
     
-    
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
-    
+
     
     namespace Private
     {
         
+        /*!
+         * \class doxygen_hide_break_circular_dependancy_text
+         *
+         * This merely calls the \a GodOfDof namesake method, but this allows to do so without breaking
+         * the cycling dependancy between \a GodOfDof and \a FEltSpace.
+         *
+         * \param[in] god_of_dof God of dof which member quantity is required.
+         */
+        
         
         /*!
-         * \brief Return the id of a god of dof.
+         * \brief Return the id of \a god_of_dof.
+         *
+         * \copydoc doxygen_hide_break_circular_dependancy_text
          *
-         * This merely calls the namespace method, but this allows to do so without breaking the cycling dependancy
-         * between GodOfDof and FEltSpace.
+         * \return Unique identifier of the \a god_of_dof.
          */
         unsigned int GetUniqueId(const GodOfDof& god_of_dof);
         
@@ -50,18 +61,19 @@ namespace HappyHeart
         /*!
          * \brief Return the geometric mesh region of a god of dof.
          *
-         * This merely calls the namespace method, but this allows to do so without breaking the cycling dependancy
-         * between GodOfDof and FEltSpace.
+         * \copydoc doxygen_hide_break_circular_dependancy_text
+         *
+         * \return GeometricMeshRegion related to the \a god_of_dof.
          */
-
         const GeometricMeshRegion& GetGeometricMeshRegion(const GodOfDof& god_of_dof);
         
 
         /*!
          * \brief Return the mpi object of a god of dof.
          *
-         * This merely calls the namespace method, but this allows to do so without breaking the cycling dependancy
-         * between GodOfDof and FEltSpace.
+         * \copydoc doxygen_hide_break_circular_dependancy_text
+         *
+         * \return Wrappers::Mpi object associated to the \a god_of_dof.
          */
         const Wrappers::Mpi& GetMpi(const GodOfDof& god_of_dof);
         

Sources/FiniteElement/FiniteElementSpace/Private/ComputeMatrixPattern.hpp

@@ -23,7 +23,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -42,6 +43,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/FiniteElement/FiniteElementSpace/Private/CreateNodeListHelper.hpp

@@ -31,7 +31,8 @@ namespace HappyHeart
 {
 
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -39,6 +40,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/FiniteElement/FiniteElementSpace/Private/DofProgramWiseIndexListPerVertexCoordIndex.hpp

@@ -24,7 +24,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -34,6 +35,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
 

Sources/FiniteElement/FiniteElementSpace/Private/DofProgramWiseIndexListPerVertexCoordIndexManager.hpp

@@ -24,7 +24,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -35,6 +36,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/FiniteElement/FiniteElementSpace/Private/FEltSpaceStorage.hpp

@@ -24,7 +24,8 @@ namespace HappyHeart
 {
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
 
     
@@ -44,6 +45,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
     
     

Sources/FiniteElement/FiniteElementSpace/Private/Impl/AttributeProcessorHelper.hpp

@@ -30,7 +30,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
 
     
@@ -39,6 +40,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================
 
 

Sources/FiniteElement/FiniteElementSpace/Private/Impl/FEltSpaceInternalStorage.hpp

@@ -32,7 +32,8 @@ namespace HappyHeart
     
     
     // ============================
-    // Forward declarations.
+    //! \cond IGNORE_BLOCK_IN_DOXYGEN
+    // Forward declarations.    
     // ============================
     
     
@@ -42,6 +43,7 @@ namespace HappyHeart
     
     // ============================
     // End of forward declarations.
+    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
     // ============================