Remove '<' from doxygens above struct element to produce doc properly 49/318549/1 accepted/tizen/unified/20250123.133215 accepted/tizen/unified/x/20250124.014019
authorSangYoun Kwak <sy.kwak@samsung.com>
Mon, 20 Jan 2025 08:28:42 +0000 (17:28 +0900)
committerSangYoun Kwak <sy.kwak@samsung.com>
Mon, 20 Jan 2025 08:28:42 +0000 (17:28 +0900)
By the doxygen generation format, for the doxygen above the struct
elements, should be written by the format below:
/** ... */
or
/**
 * ...
 */

Previously, there was '<' in the doxygen comment above the struct
elements. Thus, it is fixed by removing '<'.

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

index d433e0f110944456983bd9a4e09a1e53f6d7418b..3e1848d745f7695eb6b05e60a7f0751e048e2785 100644 (file)
@@ -38,34 +38,34 @@ extern "C" {
  * @since HAL_MODULE_SENSOR 1.0
  */
 typedef struct {
-  /**< Get poll fd for event listening */
+  /** Get poll fd for event listening */
   int (*get_poll_fd)(uint32_t sensor_device_id, int *poll_fd);
-  /**< Get sensor entities */
+  /** Get sensor entities */
   int (*get_sensors)(uint32_t sensor_device_id, const sensor_info_t **sensors, size_t *sensors_len);
 
-  /**< Enable this sensor */
+  /** Enable this sensor */
   int (*enable)(uint32_t sensor_device_id, uint32_t id);
-  /**< Disable this sensor */
+  /** Disable this sensor */
   int (*disable)(uint32_t sensor_device_id, uint32_t id);
-  /**< Read sensor and return event ids */
+  /** Read sensor and return event ids */
   int (*read_fd)(uint32_t sensor_device_id, uint32_t **ids, size_t *ids_len);
-  /**< Get sensor data */
+  /** Get sensor data */
   int (*get_data)(uint32_t sensor_device_id, uint32_t id, sensor_data_t **data, size_t *length);
 
-  /**< Set sensor value interval */
+  /** Set sensor value interval */
   int (*set_interval)(uint32_t sensor_device_id, uint32_t id, unsigned long val);
-  /**< Set batch latency */
+  /** Set batch latency */
   int (*set_batch_latency)(uint32_t sensor_device_id, uint32_t id, unsigned long val);
-  /**< Set attribute as an integer value */
+  /** Set attribute as an integer value */
   int (*set_attribute_int)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, int32_t value);
-  /**< Set attribute as a string value */
+  /** Set attribute as a string value */
   int (*set_attribute_str)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, const char *value, size_t len);
-  /**< Get integer attribute value */
+  /** Get integer attribute value */
   int (*get_attribute_int)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, int32_t *value);
-  /**< Get string attribute value */
+  /** Get string attribute value */
   int (*get_attribute_str)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, char **value, size_t *len);
 
-  /**< Flush sensor datas */
+  /** Flush sensor datas */
   int (*flush)(uint32_t sensor_device_id, uint32_t id);
 } sensor_device_s;
 
@@ -75,9 +75,9 @@ typedef struct {
  */
 
 typedef struct _hal_backend_sensor_funcs {
-  /**< Create sensor devices */
+  /** Create sensor devices */
   int (*create_sensor)(sensor_device_s ***sensor_devices, size_t *sensor_devices_len);
-  /**< Delete sensors with their ids */
+  /** Delete sensors with their ids */
   int (*delete_sensor)(uint32_t *sensor_device_ids, size_t sensor_device_ids_len);
 } hal_backend_sensor_funcs;