Fix doxygen to make html link and to explain enum meaning properly 26/318526/2
authorSangYoun Kwak <sy.kwak@samsung.com>
Wed, 15 Jan 2025 02:47:48 +0000 (11:47 +0900)
committerSangYoun Kwak <sy.kwak@samsung.com>
Mon, 20 Jan 2025 04:52:47 +0000 (13:52 +0900)
To make html link in the doxygen, '#' is added to the enum name.
Also, explanation of the enum value 'SENSOR_ATTR_EXERCISE_PSERVICE' be
more informative, it is improved as "/**< exercise personal service */".

Change-Id: Ib6e2d00bb7ac3f3b3e8ac4e937e1ccc09d744ba0
Signed-off-by: SangYoun Kwak <sy.kwak@samsung.com>
include/hal-sensor-types.h

index 79be7d8826690a11ea68985aa577b4132e0008a3..d65e6d4d968de6362fe83ab68695c0c8124a37c3 100644 (file)
@@ -352,7 +352,7 @@ enum sensor_attribute {
   SENSOR_ATTR_EXERCISE_BATCH_INTERVAL =
       CONVERT_TYPE_ATTR(SENSOR_DEVICE_EXERCISE_STANDALONE, 0x3),                       /**< exercise batch interval */
   SENSOR_ATTR_EXERCISE_PSERVICE =
-      CONVERT_TYPE_ATTR(SENSOR_DEVICE_EXERCISE_STANDALONE, 0x4),                       /**< exercise pservice */
+      CONVERT_TYPE_ATTR(SENSOR_DEVICE_EXERCISE_STANDALONE, 0x4),                       /**< exercise personal service */
 
   SENSOR_ATTR_CYCLE_DURATION =
       CONVERT_TYPE_ATTR(SENSOR_DEVICE_CYCLE_MONITOR, 0x1),                             /**< cycle duration */
@@ -604,7 +604,7 @@ enum sensor_activity {
 /**
  * @brief Enumeration(hal) for sensitivity level of proximity sensor
  * @since HAL_MODULE_SENSOR 1.0
- * @details HAL_SENSOR_ATTR_PROXIMITY_SENSITIVITY_LEVEL attribute value
+ * @details #HAL_SENSOR_ATTR_PROXIMITY_SENSITIVITY_LEVEL attribute value
  */
 enum hal_sensor_proximity_sensitivity_level {
   HAL_SENSOR_PROXIMITY_SENSITIVITY_LEVEL_WEAK = 1,     /**< Weak */
@@ -615,7 +615,7 @@ enum hal_sensor_proximity_sensitivity_level {
 /**
  * @brief Enumeration(hal) for power state of lidar
  * @since HAL_MODULE_SENSOR 1.0
- * @details HAL_SENSOR_ATTR_LIDAR_POWER_STATE attribute value
+ * @details #HAL_SENSOR_ATTR_LIDAR_POWER_STATE attribute value
  */
 enum hal_sensor_lidar_power_state {
   HAL_SENSOR_LIDAR_POWER_STATE_OFF = 0,        /**< Off */