diff --git a/thermal/AbstractTemperatureSensor.h b/thermal/AbstractTemperatureSensor.h index 75437dca..3bebbe73 100644 --- a/thermal/AbstractTemperatureSensor.h +++ b/thermal/AbstractTemperatureSensor.h @@ -10,6 +10,15 @@ #include "ThermalModuleIF.h" #include "tcsDefinitions.h" +/** + * @defgroup thermal Thermal Components + * @brief Contains all components related to thermal tasks (sensors, heaters) + */ + +/** + * @brief Base class for Temperature Sensor, implements all important interfaces + * @ingroup thermal + */ class AbstractTemperatureSensor: public HasHealthIF, public SystemObject, public ExecutableObjectIF, diff --git a/thermal/CoreComponent.h b/thermal/CoreComponent.h index f7e7aff8..e21ee113 100644 --- a/thermal/CoreComponent.h +++ b/thermal/CoreComponent.h @@ -8,6 +8,7 @@ #include #include +// TODO: Documentaiton, how to use this? only use Thermal COmponent, which inherits core component? class CoreComponent: public ThermalComponentIF { public: struct Parameters { diff --git a/thermal/TemperatureSensor.h b/thermal/TemperatureSensor.h index de280d87..cbf8ea30 100644 --- a/thermal/TemperatureSensor.h +++ b/thermal/TemperatureSensor.h @@ -5,6 +5,14 @@ #include "AbstractTemperatureSensor.h" #include +/** + * @brief This building block handles non-linear value conversion and + * range checks for analog temperature sensors. + * @details + * + * + */ + template class TemperatureSensor: public AbstractTemperatureSensor { public: diff --git a/thermal/ThermalModule.h b/thermal/ThermalModule.h index d8ac7d73..e65560cd 100644 --- a/thermal/ThermalModule.h +++ b/thermal/ThermalModule.h @@ -11,6 +11,9 @@ #include "RedundantHeater.h" class PowerSwitchIF; +/** + * @brief Allows creation of different thermal control domains within a system. + */ class ThermalModule: public ThermalModuleIF { friend class ThermalController; public: