From 264b40d1566c7c412b22457c47c8324669723434 Mon Sep 17 00:00:00 2001 From: Hpsaturn Date: Thu, 21 Sep 2023 00:28:00 +0200 Subject: [PATCH] fixed some doxygen issues --- doxygen.conf | 11 ++--------- src/Sensors.hpp | 8 ++++---- 2 files changed, 6 insertions(+), 13 deletions(-) diff --git a/doxygen.conf b/doxygen.conf index 1116469b..402b4f21 100644 --- a/doxygen.conf +++ b/doxygen.conf @@ -1565,7 +1565,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = NO +DISABLE_INDEX = YES # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag @@ -1582,7 +1582,7 @@ DISABLE_INDEX = NO # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. @@ -2656,10 +2656,3 @@ GENERATE_LEGEND = YES # The default value is: YES. DOT_CLEANUP = YES - -# MODS: - - -DISABLE_INDEX = YES -GENERATE_TREEVIEW = YES - diff --git a/src/Sensors.hpp b/src/Sensors.hpp index 9cf8e345..e27dfd48 100644 --- a/src/Sensors.hpp +++ b/src/Sensors.hpp @@ -84,7 +84,7 @@ // UART defualt port #define SENSOR_COMMS SERIALPORT2 -/// Sensors units definitions (symbol/name) +// Sensors units definitions (symbol/name) #define SENSOR_UNITS \ X(NUNIT, "NUNIT", "NUNIT") \ X(PM1, "ug/m3", "PM1") \ @@ -114,7 +114,7 @@ typedef enum UNIT : size_t { SENSOR_UNITS } UNIT; #undef X -/// sensors types: 1:PM, 2:CO2, 3:ENV +// sensors types: 1:PM, 2:CO2, 3:ENV #define SENSORS_TYPES \ X(Auto, "GENERIC", 1) \ X(SGCJA5, "GCJA5", 1) \ @@ -142,14 +142,14 @@ typedef enum UNIT : size_t { SENSOR_UNITS } UNIT; typedef enum SENSORS : size_t { SENSORS_TYPES } SENSORS; // backward compatibility #undef X -/// MAIN SENSOR GROUPS TYPE +// MAIN SENSOR GROUPS TYPE enum class SensorGroup { SENSOR_NONE, SENSOR_PM, SENSOR_CO2, SENSOR_ENV, SENSOR_RAD // CAJOE_GEIGER }; -/// TEMPERATURE UNITS +// TEMPERATURE UNITS enum class TEMPUNIT { CELSIUS, FAHRENHEIT,