From eaac392f377dcc332bcea5160f6c9af5e845f56b Mon Sep 17 00:00:00 2001
From: Varun Agrawal <varagrawal@gmail.com>
Date: Tue, 26 Jul 2022 16:47:27 -0400
Subject: [PATCH] add base module

---
 gtsam/base/ConcurrentMap.h        | 2 +-
 gtsam/base/DSFMap.h               | 2 +-
 gtsam/base/DSFVector.h            | 4 ++--
 gtsam/base/FastList.h             | 2 +-
 gtsam/base/FastMap.h              | 2 +-
 gtsam/base/FastSet.h              | 2 +-
 gtsam/base/FastVector.h           | 2 +-
 gtsam/base/SymmetricBlockMatrix.h | 2 +-
 gtsam/base/Testable.h             | 2 +-
 gtsam/base/ThreadsafeException.h  | 2 +-
 gtsam/base/VerticalBlockMatrix.h  | 2 +-
 gtsam/base/types.cpp              | 2 +-
 gtsam/base/types.h                | 2 +-
 gtsam/global_includes.h           | 2 +-
 gtsam/groups.dox                  | 3 +++
 gtsam_unstable/base/BTree.h       | 2 +-
 gtsam_unstable/base/DSF.h         | 2 +-
 17 files changed, 20 insertions(+), 17 deletions(-)

diff --git a/gtsam/base/ConcurrentMap.h b/gtsam/base/ConcurrentMap.h
index cf4537d4c..8d5f56675 100644
--- a/gtsam/base/ConcurrentMap.h
+++ b/gtsam/base/ConcurrentMap.h
@@ -62,7 +62,7 @@ namespace gtsam {
  * convenience to avoid having lengthy types in the code.  Through timing,
  * we've seen that the fast_pool_allocator can lead to speedups of several
  * percent.
- * @addtogroup base
+ * @ingroup base
  */
 template<typename KEY, typename VALUE>
 class ConcurrentMap : public ConcurrentMapBase<KEY,VALUE> {
diff --git a/gtsam/base/DSFMap.h b/gtsam/base/DSFMap.h
index 3a9d21aad..a666a8334 100644
--- a/gtsam/base/DSFMap.h
+++ b/gtsam/base/DSFMap.h
@@ -28,7 +28,7 @@ namespace gtsam {
 /**
  * Disjoint set forest using an STL map data structure underneath
  * Uses rank compression and union by rank, iterator version
- * @addtogroup base
+ * @ingroup base
  */
 template <class KEY>
 class DSFMap {
diff --git a/gtsam/base/DSFVector.h b/gtsam/base/DSFVector.h
index 6e9bc5c6b..9c22e012e 100644
--- a/gtsam/base/DSFVector.h
+++ b/gtsam/base/DSFVector.h
@@ -33,7 +33,7 @@ namespace gtsam {
  * A fast implementation of disjoint set forests that uses vector as underly data structure.
  * This is the absolute minimal DSF data structure, and only allows size_t keys
  * Uses rank compression but not union by rank :-(
- * @addtogroup base
+ * @ingroup base
  */
 class GTSAM_EXPORT DSFBase {
 
@@ -59,7 +59,7 @@ public:
 
 /**
  * DSFVector additionally keeps a vector of keys to support more expensive operations
- * @addtogroup base
+ * @ingroup base
  */
 class GTSAM_EXPORT DSFVector: public DSFBase {
 
diff --git a/gtsam/base/FastList.h b/gtsam/base/FastList.h
index 752b0b571..47f813311 100644
--- a/gtsam/base/FastList.h
+++ b/gtsam/base/FastList.h
@@ -34,7 +34,7 @@ namespace gtsam {
  * convenience to avoid having lengthy types in the code.  Through timing,
  * we've seen that the fast_pool_allocator can lead to speedups of several
  * percent.
-   * @addtogroup base
+   * @ingroup base
  */
 template<typename VALUE>
 class FastList: public std::list<VALUE, typename internal::FastDefaultAllocator<VALUE>::type> {
diff --git a/gtsam/base/FastMap.h b/gtsam/base/FastMap.h
index 65d532191..1f68c8d28 100644
--- a/gtsam/base/FastMap.h
+++ b/gtsam/base/FastMap.h
@@ -31,7 +31,7 @@ namespace gtsam {
  * convenience to avoid having lengthy types in the code.  Through timing,
  * we've seen that the fast_pool_allocator can lead to speedups of several
  * percent.
- * @addtogroup base
+ * @ingroup base
  */
 template<typename KEY, typename VALUE>
 class FastMap : public std::map<KEY, VALUE, std::less<KEY>,
diff --git a/gtsam/base/FastSet.h b/gtsam/base/FastSet.h
index 6fe2d06e3..906412f4d 100644
--- a/gtsam/base/FastSet.h
+++ b/gtsam/base/FastSet.h
@@ -43,7 +43,7 @@ namespace gtsam {
  * fast_pool_allocator instead of the default STL allocator.  This is just a
  * convenience to avoid having lengthy types in the code.  Through timing,
  * we've seen that the fast_pool_allocator can lead to speedups of several %.
- * @addtogroup base
+ * @ingroup base
  */
 template<typename VALUE>
 class FastSet: public std::set<VALUE, std::less<VALUE>,
diff --git a/gtsam/base/FastVector.h b/gtsam/base/FastVector.h
index e54b91126..0faf80f54 100644
--- a/gtsam/base/FastVector.h
+++ b/gtsam/base/FastVector.h
@@ -27,7 +27,7 @@ namespace gtsam {
 /**
  * FastVector is a type alias to a std::vector with a custom memory allocator.
  * The particular allocator depends on GTSAM's cmake configuration.
- * @addtogroup base
+ * @ingroup base
  */
 template <typename T>
 using FastVector =
diff --git a/gtsam/base/SymmetricBlockMatrix.h b/gtsam/base/SymmetricBlockMatrix.h
index 4e030606d..302a1ec34 100644
--- a/gtsam/base/SymmetricBlockMatrix.h
+++ b/gtsam/base/SymmetricBlockMatrix.h
@@ -47,7 +47,7 @@ namespace gtsam {
   * matrix view.  firstBlock() determines the block that appears to have index 0 for all operations
   * (except re-setting firstBlock()).
   *
-  * @addtogroup base */
+  * @ingroup base */
   class GTSAM_EXPORT SymmetricBlockMatrix
   {
   public:
diff --git a/gtsam/base/Testable.h b/gtsam/base/Testable.h
index d50d62c1f..f7eddd414 100644
--- a/gtsam/base/Testable.h
+++ b/gtsam/base/Testable.h
@@ -51,7 +51,7 @@ namespace gtsam {
    * tests and in generic algorithms.
    *
    * See macros for details on using this structure
-   * @addtogroup base
+   * @ingroup base
    * @tparam T is the objectype this constrains to be testable - assumes print() and equals()
    */
   template <class T>
diff --git a/gtsam/base/ThreadsafeException.h b/gtsam/base/ThreadsafeException.h
index 8d5115a19..652dbd90f 100644
--- a/gtsam/base/ThreadsafeException.h
+++ b/gtsam/base/ThreadsafeException.h
@@ -14,7 +14,7 @@
  * @brief    Base exception type that uses tbb_allocator if GTSAM is compiled with TBB
  * @author   Richard Roberts
  * @date     Aug 21, 2010
- * @addtogroup base
+ * @ingroup base
  */
 
 #pragma once
diff --git a/gtsam/base/VerticalBlockMatrix.h b/gtsam/base/VerticalBlockMatrix.h
index 0d8d69df8..ef6691cac 100644
--- a/gtsam/base/VerticalBlockMatrix.h
+++ b/gtsam/base/VerticalBlockMatrix.h
@@ -38,7 +38,7 @@ namespace gtsam {
    * row for all operations.  To include all rows, rowEnd() should be set to the number of rows in
    * the matrix (i.e. one after the last true row index).
    *
-   * @addtogroup base */
+   * @ingroup base */
   class GTSAM_EXPORT VerticalBlockMatrix
   {
   public:
diff --git a/gtsam/base/types.cpp b/gtsam/base/types.cpp
index edc449b12..0abfc71ac 100644
--- a/gtsam/base/types.cpp
+++ b/gtsam/base/types.cpp
@@ -14,7 +14,7 @@
  * @brief    Functions for handling type information
  * @author   Varun Agrawal
  * @date     May 18, 2020
- * @addtogroup base
+ * @ingroup base
  */
 
 #include <gtsam/base/types.h>
diff --git a/gtsam/base/types.h b/gtsam/base/types.h
index a0d24f1a6..cb8412cdf 100644
--- a/gtsam/base/types.h
+++ b/gtsam/base/types.h
@@ -14,7 +14,7 @@
  * @brief    Typedefs for easier changing of types
  * @author   Richard Roberts
  * @date     Aug 21, 2010
- * @addtogroup base
+ * @ingroup base
  */
 
 #pragma once
diff --git a/gtsam/global_includes.h b/gtsam/global_includes.h
index c04da2e5c..94ae9ee5b 100644
--- a/gtsam/global_includes.h
+++ b/gtsam/global_includes.h
@@ -13,7 +13,7 @@
  * @file     global_includes.h
  * @brief    Included from all GTSAM files
  * @author   Richard Roberts
- * @addtogroup base
+ * @ingroup base
  */
 
 #pragma once
diff --git a/gtsam/groups.dox b/gtsam/groups.dox
index 4a52371a5..b3fd9efaf 100644
--- a/gtsam/groups.dox
+++ b/gtsam/groups.dox
@@ -9,6 +9,9 @@
 \defgroup Sequential Solving by sequential variable elimination (QR and Cholesky)
 @{ @}
 
+\defgroup base Base
+@{ @}
+
 \defgroup basis Basis
 @{ @}
 
diff --git a/gtsam_unstable/base/BTree.h b/gtsam_unstable/base/BTree.h
index 94e27d6c4..edabd2528 100644
--- a/gtsam_unstable/base/BTree.h
+++ b/gtsam_unstable/base/BTree.h
@@ -28,7 +28,7 @@ namespace gtsam {
 
   /**
    * @brief Binary tree
-   * @addtogroup base
+   * @ingroup base
    */
   template<class KEY, class VALUE>
   class BTree {
diff --git a/gtsam_unstable/base/DSF.h b/gtsam_unstable/base/DSF.h
index 4ad7d3ea8..a7483cbf5 100644
--- a/gtsam_unstable/base/DSF.h
+++ b/gtsam_unstable/base/DSF.h
@@ -33,7 +33,7 @@ namespace gtsam {
  * S = {S_1,S_2,...} of disjoint dynamic sets. Each set is identified by
  * a representative, which is some member of the set.
  *
- * @addtogroup base
+ * @ingroup base
  */
 template<class KEY>
 class DSF: protected BTree<KEY, KEY> {