mola-kernel Doxygen docs: add groups

mola_kernel/include/mola_kernel/entities/EntityBase.h

@@ -23,13 +23,13 @@ namespace mola
 {
 /** Arbitrary annotated data, indexed by "label" or "variable name" and
  *capable of offline storage on disk when not used.
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 using annotations_data_t = std::map<std::string, LazyLoadResource>;
 
 /** Base class for all "entities" in the world model
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 class EntityBase : public mrpt::serialization::CSerializable
 {

mola_kernel/include/mola_kernel/entities/EntityRelativeBase.h

@@ -17,7 +17,7 @@ namespace mola
 {
 /** World optimizable entities which are relative to some keyframe.
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 class EntityRelativeBase : public EntityBase
 {

mola_kernel/include/mola_kernel/entities/KeyFrameBase.h

@@ -25,7 +25,7 @@ namespace mola
  * This class is used as a base class for all world-model entities that can be
  * used as robot/vehicle keyframes.
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 class KeyFrameBase
 {

mola_kernel/include/mola_kernel/entities/LandmarkPoint3.h

@@ -18,7 +18,7 @@ namespace mola
 {
 /** A 3D point landmark.
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 class LandmarkPoint3 : public EntityBase
 {

mola_kernel/include/mola_kernel/entities/RefPose3.h

@@ -21,7 +21,7 @@ namespace mola
  * relative maps (submaps). Global SLAM frameworks should have only one entity
  * of this class, submapping approaches will have several instances.
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 class RefPose3 : public EntityBase
 {

mola_kernel/include/mola_kernel/entities/RelDynPose3KF.h

@@ -21,7 +21,7 @@ namespace mola
 /** A relative "dynamic" pose: SE(3) pose + velocity vector.
  * Both the pose and the velocity vector are given in the frame of the base KF.
  * This entity is also a key-frame.
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 class RelDynPose3KF : public EntityRelativeBase, public KeyFrameBase
 {

mola_kernel/include/mola_kernel/entities/RelPose3.h

@@ -18,7 +18,7 @@ namespace mola
 {
 /** A relative SE(3) pose (e.g. a sensor pose wrt the vehicle)
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 class RelPose3 : public EntityRelativeBase
 {

mola_kernel/include/mola_kernel/entities/RelPose3KF.h

@@ -20,7 +20,7 @@ namespace mola
 /** A relative SE(3) keyframe, holding a relative SE(3) pose wrt to the base
  * frame.
  * This entity is also a key-frame.
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_entities_grp
  */
 class RelPose3KF : public EntityRelativeBase, public KeyFrameBase
 {

mola_kernel/include/mola_kernel/entities/entities-common.h

@@ -21,7 +21,13 @@
 
 namespace mola
 {
+/** \addtogroup mola_kernel_entities_grp Centralized map database entities
+ *  \ingroup mola_kernel_grp
+ *  @{ */
+
 /** Placeholder for generic entity of user-defined types */
 using EntityOther = std::shared_ptr<EntityBase>;
 
+/** @} */
+
 }  // namespace mola

mola_kernel/include/mola_kernel/factors/FactorBase.h

@@ -17,8 +17,12 @@
 
 namespace mola
 {
+/** \addtogroup mola_kernel_factors_grp Centralized map database factors
+ *  \ingroup mola_kernel_grp
+ *  @{ */
+
 /** Defines a type of robust (m-Estimator) factor
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_factors_grp
  */
 enum class Robust : uint8_t
 {
@@ -32,7 +36,7 @@ enum class Robust : uint8_t
 
 /** Base class for all "factors" in the world model
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_factors_grp
  */
 class FactorBase : public mrpt::serialization::CSerializable
 {
@@ -73,4 +77,6 @@ class FactorBase : public mrpt::serialization::CSerializable
     void baseSerializeFrom(mrpt::serialization::CArchive& in);
 };
 
+/** @}  */
+
 }  // namespace mola

mola_kernel/include/mola_kernel/factors/FactorConstVelKinematics.h

@@ -19,7 +19,7 @@ namespace mola
 /** Abstract representation of a constant-velocity kinematic motion model factor
  * between two key frames.
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_factors_grp
  */
 class FactorConstVelKinematics : public FactorBase
 {

mola_kernel/include/mola_kernel/factors/FactorRelativePose3.h

@@ -21,7 +21,7 @@ namespace mola
 {
 /**
  *
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_factors_grp
  */
 class FactorRelativePose3 : public FactorBase
 {

mola_kernel/include/mola_kernel/factors/FactorStereoProjectionPose.h

@@ -26,7 +26,7 @@ struct StereoObservation
 
 /** Smart factor for a set of stereo-camera observations of one point landmark.
  * The ID of the factor is the ID of the landmark.
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_factors_grp
  */
 class FactorStereoProjectionPose : public FactorBase
 {

mola_kernel/include/mola_kernel/factors/SmartFactorIMU.h

@@ -20,7 +20,7 @@ namespace mola
 class BackEndBase;
 
 /** Smart factor for a set of IMU measurements (acceleration & gyroscope).
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_factors_grp
  */
 class SmartFactorIMU : public FactorBase
 {

mola_kernel/include/mola_kernel/factors/SmartFactorStereoProjectionPose.h

@@ -23,7 +23,7 @@ class BackEndBase;
 
 /** Smart factor for a set of stereo-camera observations of one point landmark.
  * The ID of the factor is the ID of the landmark.
- * \ingroup mola_kernel_grp
+ * \ingroup mola_kernel_factors_grp
  */
 class SmartFactorStereoProjectionPose : public FactorBase
 {

mola_kernel/include/mola_kernel/interfaces/BackEndBase.h

@@ -26,11 +26,15 @@
 
 namespace mola
 {
+/** \addtogroup mola_kernel_interfaces_grp MOLA virtual interfaces
+ *  \ingroup mola_kernel_grp
+ *  @{ */
+
 /** Virtual interface for SLAM back-ends.
  * All calls to `onXXX()` methods are enqueued and executed in a separate
  * thread.
  *
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class BackEndBase : public ExecutableBase
 {
 #if MRPT_VERSION < 0x020e00
@@ -157,4 +161,6 @@ class BackEndBase : public ExecutableBase
         2, mrpt::WorkerThreadsPool::POLICY_FIFO, "slam_backend"};
 };
 
+/** @}  */
+
 }  // namespace mola

mola_kernel/include/mola_kernel/interfaces/Dataset_UI.h

@@ -16,7 +16,7 @@
 namespace mola
 {
 /** Virtual base for offline dataset sources to have a GUI within MolaViz
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class Dataset_UI
 {
    public:

mola_kernel/include/mola_kernel/interfaces/ExecutableBase.h

@@ -31,7 +31,7 @@ using ProfilerEntry       = mrpt::system::CTimeLoggerEntry;
 using ProfilerSaverAtDtor = mrpt::system::CTimeLoggerSaveAtDtor;
 
 /** Base virtual class for all executable (nodelet-like) units inside a
- * SLAM system. \ingroup mola_kernel_grp */
+ * SLAM system. \ingroup mola_kernel_interfaces_grp */
 class ExecutableBase : public mrpt::system::COutputLogger,  // for logging
                        public mrpt::rtti::CObject,  // RTTI helpers
                        std::enable_shared_from_this<ExecutableBase>

mola_kernel/include/mola_kernel/interfaces/FilterBase.h

@@ -22,7 +22,7 @@ namespace mola
 /** Base class for filters: get observations via `onNewObservation()`, and
  * immediately send them to a worker thread that works on it, possibly
  * publishing the output via `sendObservationsToFrontEnds()`.
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class FilterBase : public RawDataSourceBase, RawDataConsumer
 {
 #if MRPT_VERSION < 0x020e00

mola_kernel/include/mola_kernel/interfaces/FrontEndBase.h

@@ -31,7 +31,7 @@ namespace mola
  * (default=1 Hz), or
  * - Use your own logic to enqueue a task into a worker thread pool (preferred).
  *
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class FrontEndBase : public ExecutableBase, public RawDataConsumer
 {
 #if MRPT_VERSION < 0x020e00

mola_kernel/include/mola_kernel/interfaces/LocalizationSourceBase.h

@@ -31,7 +31,7 @@ namespace mola
  * must call subscribeToLocalizationUpdates() providing a callback that returns
  * as fast as possible.
  *
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class LocalizationSourceBase
 {
    public:

mola_kernel/include/mola_kernel/interfaces/MapServer.h

@@ -17,7 +17,7 @@
 namespace mola
 {
 /** Virtual interface for map server services offered by MOLA modules
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class MapServer
 {
    public:

mola_kernel/include/mola_kernel/interfaces/MapSourceBase.h

@@ -23,7 +23,7 @@ namespace mola
 {
 /** Virtual interface for SLAM/odometry methods publishing a map
  *
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class MapSourceBase
 {
    public:

mola_kernel/include/mola_kernel/interfaces/NavStateFilter.h

@@ -26,7 +26,7 @@ namespace mola
 {
 /** The state returned by NavStateFilter
  *
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 struct NavState
 {
     NavState()  = default;
@@ -52,7 +52,7 @@ struct NavState
 /** Unified API for kinematic state filtering algorithms,
  *  fusing information from multiple odometry or twist sources.
  *
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class NavStateFilter : public mrpt::system::COutputLogger
 {
    public:

mola_kernel/include/mola_kernel/interfaces/OfflineDatasetSource.h

@@ -24,7 +24,7 @@ namespace mola
 using trajectory_t = mrpt::poses::CPose3DInterpolator;
 
 /** Virtual base for offline dataset sources
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class OfflineDatasetSource
 {
    public:

mola_kernel/include/mola_kernel/interfaces/RawDataConsumer.h

@@ -20,7 +20,7 @@ namespace mola
 using CObservation = mrpt::obs::CObservation;
 
 /** Virtual base for raw-observation consumers
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class RawDataConsumer
 {
    public:

mola_kernel/include/mola_kernel/interfaces/RawDataSourceBase.h

@@ -27,7 +27,7 @@ namespace mola
 using timestep_t = std::size_t;
 
 /** Virtual base for raw-observation data sources (sensors, dataset
- * parsers,...) \ingroup mola_kernel_grp */
+ * parsers,...) \ingroup mola_kernel_interfaces_grp */
 class RawDataSourceBase : public mola::ExecutableBase
 {
 #if MRPT_VERSION < 0x020e00

mola_kernel/include/mola_kernel/interfaces/Relocalization.h

@@ -17,7 +17,7 @@
 namespace mola
 {
 /** Virtual interface for relocalization offered by MOLA modules
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class Relocalization
 {
    public:

mola_kernel/include/mola_kernel/interfaces/VizInterface.h

@@ -21,7 +21,7 @@ namespace mola
 {
 /** Virtual visualization interface (see MolaViz)
  *
- * \ingroup mola_kernel_grp */
+ * \ingroup mola_kernel_interfaces_grp */
 class VizInterface
 {
    public: