Merge pull request #1771 from su2code/improve_doxydocs

Improve doxygen documentation

Author: pcarruscag

Common/doc/docmain.hpp

@@ -38,6 +38,7 @@ using namespace std;
 
 /*!
  * \class CADTBaseClass
+ * \ingroup ADT
  * \brief  Base class for storing an ADT in an arbitrary number of dimensions.
  * \author E. van der Weide
  */

Common/include/adt/CADTBaseClass.hpp

@@ -30,6 +30,7 @@
 
 /*!
  * \class CADTComparePointClass
+ * \ingroup ADT
  * \brief  Functor, used for the sorting of the points when building an ADT.
  * \author E. van der Weide
  */

Common/include/adt/CADTComparePointClass.hpp

@@ -33,6 +33,7 @@
 
 /*!
  * \class CADTElemClass
+ * \ingroup ADT
  * \brief  Class for storing an ADT of (linear) elements in an arbitrary number of dimensions.
  * \author E. van der Weide
  * \version 7.4.0 "Blackbird"

Common/include/adt/CADTElemClass.hpp

@@ -30,6 +30,7 @@
 
 /*!
  * \class CADTNodeClass
+ * \ingroup ADT
  * \brief  Class for storing the information needed in a node of an ADT.
  * \author E. van der Weide
  */

Common/include/adt/CADTNodeClass.hpp

@@ -30,6 +30,7 @@
 
 /*!
  * \class CADTPointsOnlyClass
+ * \ingroup ADT
  * \brief  Class for storing an ADT of only points in an arbitrary number of dimensions.
  * \author E. van der Weide
  */

Common/include/adt/CADTPointsOnlyClass.hpp

@@ -31,6 +31,7 @@
 
 /*!
  * \class CBBoxTargetClass
+ * \ingroup ADT
  * \brief  Class for storing the information of a possible bounding box candidate
            during a minimum distance search.
  * \author E. van der Weide

Common/include/adt/CBBoxTargetClass.hpp

@@ -34,6 +34,9 @@
 #include <utility>
 #include <type_traits>
 
+/// \addtogroup Containers
+/// @{
+
 /*!
  * \enum StorageType
  * \brief Supported ways to flatten a matrix into an array.
@@ -635,3 +638,5 @@ using su2activematrix = su2matrix<su2double>;
 
 using su2passivevector = su2vector<passivedouble>;
 using su2passivematrix = su2matrix<passivedouble>;
+
+/// @}

Common/include/containers/C2DContainer.hpp

@@ -35,6 +35,7 @@
 
 /*!
  * \class CFastFindAndEraseQueue
+ * \ingroup Containers
  * \brief A queue-type container (push back, pop front), but with
  *        fast deletion of arbitrary items (possibly in the middle).
  * \param[in] ItemType_ - Type of the stored items.

Common/include/containers/CFastFindAndEraseQueue.hpp

@@ -34,6 +34,10 @@
 #include "../../../Common/include/linear_algebra/blas_structure.hpp"
 #include "../../../Common/include/toolboxes/CSquareMatrixCM.hpp"
 
+/*!
+ * \brief File reader for look up tables.
+ * \ingroup LookUpInterp
+ */
 class CFileReaderLUT {
  protected:
   int rank;