From 243450719e46dd1944b0e2fd3af1676cc93437cc Mon Sep 17 00:00:00 2001
From: Raphael Grimm <raphael.grimm@kit.edu>
Date: Fri, 27 Jul 2018 15:08:15 +0200
Subject: [PATCH] Update doxygen
---
.../RobotUnit/ControlTargets/ControlTargetBase.h | 4 ----
.../ControlTargetHolonomicPlatformVelocity.h | 4 ----
.../RobotUnit/NJointControllers/NJointController.h | 11 +++--------
.../RobotAPI/components/units/RobotUnit/RobotUnit.h | 9 ++++++++-
.../RobotUnit/RobotUnitModules/RobotUnitModuleBase.h | 6 ++++++
.../RobotUnitModules/RobotUnitModuleControlThread.h | 1 +
.../RobotUnitModuleControlThreadDataBuffer.h | 1 +
.../RobotUnitModuleControllerManagement.h | 1 +
.../RobotUnitModules/RobotUnitModuleDevices.h | 1 +
.../RobotUnitModules/RobotUnitModuleLogging.h | 1 +
.../RobotUnitModules/RobotUnitModuleManagement.h | 1 +
.../RobotUnitModules/RobotUnitModulePublisher.h | 1 +
.../RobotUnitModules/RobotUnitModuleRobotData.h | 1 +
.../RobotUnitModuleSelfCollisionChecker.h | 1 +
.../RobotUnit/RobotUnitModules/RobotUnitModuleUnits.h | 1 +
.../units/RobotUnit/SensorValues/SensorValueBase.h | 4 ++++
16 files changed, 31 insertions(+), 17 deletions(-)
diff --git a/source/RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetBase.h b/source/RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetBase.h
index 5ca733da6..29ae86b6b 100644
--- a/source/RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetBase.h
+++ b/source/RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetBase.h
@@ -37,10 +37,6 @@
namespace armarx
{
/**
- * @defgroup Library-RobotUnit RobotUnit
- * @ingroup RobotAPI
- * A description of the library RobotUnit.
- *
* @class ControlTargetBase
* @ingroup Library-RobotUnit
* @brief Brief description of class JointControlTargetBase.
diff --git a/source/RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetHolonomicPlatformVelocity.h b/source/RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetHolonomicPlatformVelocity.h
index 2a8c9b454..93479e118 100644
--- a/source/RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetHolonomicPlatformVelocity.h
+++ b/source/RobotAPI/components/units/RobotUnit/ControlTargets/ControlTargetHolonomicPlatformVelocity.h
@@ -28,10 +28,6 @@
namespace armarx
{
/**
- * @defgroup Library-RobotUnit RobotUnit
- * @ingroup RobotAPI
- * A description of the library RobotUnit.
- *
* @class ControlTargetHolonomicPlatformVelocity
* @ingroup Library-RobotUnit
* @brief Brief description of class ControlTargetHolonomicPlatformVelocity.
diff --git a/source/RobotAPI/components/units/RobotUnit/NJointControllers/NJointController.h b/source/RobotAPI/components/units/RobotUnit/NJointControllers/NJointController.h
index 6085b8a6d..369109774 100644
--- a/source/RobotAPI/components/units/RobotUnit/NJointControllers/NJointController.h
+++ b/source/RobotAPI/components/units/RobotUnit/NJointControllers/NJointController.h
@@ -77,14 +77,9 @@ namespace armarx
TYPEDEF_PTRS_HANDLE(RobotUnit);
/**
- * @defgroup Library-RobotUnit-NJointControllers NJointControllers
- * @ingroup Library-RobotUnit
- *
- *
- * @defgroup Library-RobotUnit RobotUnit
- * @ingroup RobotAPI
- * A description of the library RobotUnit.
- */
+ * @defgroup Library-RobotUnit-NJointControllers NJointControllers
+ * @ingroup Library-RobotUnit
+ */
/**
* @ingroup Library-RobotUnit-NJointControllers
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnit.h b/source/RobotAPI/components/units/RobotUnit/RobotUnit.h
index eac584c03..a336b182c 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnit.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnit.h
@@ -25,12 +25,18 @@
#include "RobotUnitModules/RobotUnitModules.h"
#include "NJointControllers/NJointController.h"
+/**
+* @defgroup Library-RobotUnit RobotUnit
+* @ingroup RobotAPI
+* A description of the library RobotUnit.
+*/
+
namespace armarx
{
TYPEDEF_PTRS_HANDLE(RobotUnit);
/**
- * @class RobotUnitPropertyDefinitions
+ * @ingroup Library-RobotUnit
* @brief
*/
class RobotUnitPropertyDefinitions:
@@ -60,6 +66,7 @@ namespace armarx
namespace armarx
{
/**
+ * @ingroup Library-RobotUnit
* @brief The RobotUnit class manages a robot and its controllers.
*
* The \ref RobotUnit manages \ref NJointController and \ref JointController for a robot.
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleBase.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleBase.h
index 7cc6baa74..6cd42fa40 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleBase.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleBase.h
@@ -40,6 +40,11 @@
#include "../util/JointAndNJointControllers.h"
#include "../util.h"
+/**
+ * @defgroup Library-RobotUnit-Modules RobotUnitModules
+ * @ingroup Library-RobotUnit
+ */
+
namespace armarx
{
TYPEDEF_PTRS_HANDLE(RobotUnit);
@@ -123,6 +128,7 @@ namespace armarx
#undef forward_declare
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief Base class for all RobotUnitModules
*
* Since the robot unit is a complex class, it is split into several modules.
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControlThread.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControlThread.h
index 37f339650..d8d6eb6b7 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControlThread.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControlThread.h
@@ -55,6 +55,7 @@ namespace armarx
};
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" manages the \ref ControlThread.
*
* It offers the basic functions called in the \ref ControlThread.
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControlThreadDataBuffer.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControlThreadDataBuffer.h
index fd4db3e7e..bb05c426c 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControlThreadDataBuffer.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControlThreadDataBuffer.h
@@ -41,6 +41,7 @@ namespace armarx
namespace RobotUnitModule
{
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" manages all communication into and out of the \ref ControlThread.
*
* \section buffers Data Buffers
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControllerManagement.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControllerManagement.h
index 49c90c949..1175d350c 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControllerManagement.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleControllerManagement.h
@@ -33,6 +33,7 @@ namespace armarx
namespace RobotUnitModule
{
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" manages \ref NJointController "NJointControllers".
*
* @see ModuleBase
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleDevices.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleDevices.h
index f69404c25..f8fae7385 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleDevices.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleDevices.h
@@ -59,6 +59,7 @@ namespace armarx
};
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" manages sensor and control devices for a RobotUnit and only allows save and sane access.
*
* @see ModuleBase
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleLogging.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleLogging.h
index 91af3f333..c583a459c 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleLogging.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleLogging.h
@@ -75,6 +75,7 @@ namespace armarx
};
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" manages logging of data.
*
* There are two types of data:
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleManagement.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleManagement.h
index cdc5db9aa..89638c670 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleManagement.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleManagement.h
@@ -41,6 +41,7 @@ namespace armarx
};
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" handles some general management tasks.
* It implements the \ref RobotUnitManagementInterface.
*
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModulePublisher.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModulePublisher.h
index 925c935ab..1e1b3f489 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModulePublisher.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModulePublisher.h
@@ -73,6 +73,7 @@ namespace armarx
};
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" manages publishing of all data to Topics,
* updating of all units managed by \ref Units "the Units module" and calling of \ref NJointController hooks.
*
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleRobotData.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleRobotData.h
index ad3f31798..c8bb7354b 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleRobotData.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleRobotData.h
@@ -55,6 +55,7 @@ namespace armarx
};
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" holds all high-level data about the robot.
*
* @see ModuleBase
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleSelfCollisionChecker.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleSelfCollisionChecker.h
index 45bd71a70..08ce23f30 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleSelfCollisionChecker.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleSelfCollisionChecker.h
@@ -59,6 +59,7 @@ namespace armarx
};
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" manages self collision avoidance.
* If the distance between a pair of bodies falls below a threshold, the the emergency stop is activated.
*
diff --git a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleUnits.h b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleUnits.h
index 1f75b820f..30a11c636 100644
--- a/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleUnits.h
+++ b/source/RobotAPI/components/units/RobotUnit/RobotUnitModules/RobotUnitModuleUnits.h
@@ -82,6 +82,7 @@ namespace armarx
};
/**
+ * @ingroup Library-RobotUnit-Modules
* @brief This \ref ModuleBase "Module" manages all Units of a \ref RobotUnit
*
* These are the managed Units:
diff --git a/source/RobotAPI/components/units/RobotUnit/SensorValues/SensorValueBase.h b/source/RobotAPI/components/units/RobotUnit/SensorValues/SensorValueBase.h
index 661ef6177..6b358e1c5 100644
--- a/source/RobotAPI/components/units/RobotUnit/SensorValues/SensorValueBase.h
+++ b/source/RobotAPI/components/units/RobotUnit/SensorValues/SensorValueBase.h
@@ -34,6 +34,10 @@
namespace armarx
{
+ /**
+ * @ingroup Library-RobotUnit
+ * @brief The SensorValueBase class
+ */
class SensorValueBase
{
template<class...Ts>
--
GitLab