From: SangYoun Kwak <sy.kwak@samsung.com>
Date: Mon, 20 Jan 2025 06:49:06 +0000 (+0900)
Subject: Fix the location of doxygen comment for interface to upside of elements
X-Git-Tag: accepted/tizen/9.0/unified/20250206.165030~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F41%2F318541%2F2;p=platform%2Fhal%2Fapi%2Fsensor.git

Fix the location of doxygen comment for interface to upside of elements

To increase readability, the doxygen comments for elements of structures
are relocated from right side of them to upside of them.

Change-Id: I987c31358cfb4bfcf553bfa952d9a217c455d80e
Signed-off-by: SangYoun Kwak <sy.kwak@samsung.com>
---

diff --git a/include/hal-sensor-interface-1.h b/include/hal-sensor-interface-1.h
index f244766..e4d1444 100644
--- a/include/hal-sensor-interface-1.h
+++ b/include/hal-sensor-interface-1.h
@@ -38,23 +38,36 @@ extern "C" {
  * @since HAL_MODULE_SENSOR 1.0
  */
 typedef struct {
-  int (*get_poll_fd)(uint32_t sensor_device_id, int *poll_fd); /**< Get poll fd for event listening */
-  int (*get_sensors)(uint32_t sensor_device_id, const sensor_info_t **sensors, size_t *sensors_len); /**< Get sensor entities */
+  /** Get poll fd for event listening */
+  int (*get_poll_fd)(uint32_t sensor_device_id, int *poll_fd);
+  /** Get sensor entities */
+  int (*get_sensors)(uint32_t sensor_device_id, const sensor_info_t **sensors, size_t *sensors_len);
 
-  int (*enable)(uint32_t sensor_device_id, uint32_t id); /**< Enable this sensor */
-  int (*disable)(uint32_t sensor_device_id, uint32_t id); /**< Disable this sensor */
+  /** Enable this sensor */
+  int (*enable)(uint32_t sensor_device_id, uint32_t id);
+  /** Disable this sensor */
+  int (*disable)(uint32_t sensor_device_id, uint32_t id);
 
-  int (*read_fd)(uint32_t sensor_device_id, uint32_t **ids, size_t *ids_len); /**< Read sensor and return event ids */
-  int (*get_data)(uint32_t sensor_device_id, uint32_t id, sensor_data_t **data, size_t *length); /**< Get sensor data */
+  /** Read sensor and return event ids */
+  int (*read_fd)(uint32_t sensor_device_id, uint32_t **ids, size_t *ids_len);
+  /** Get sensor data */
+  int (*get_data)(uint32_t sensor_device_id, uint32_t id, sensor_data_t **data, size_t *length);
 
-  int (*set_interval)(uint32_t sensor_device_id, uint32_t id, unsigned long val); /**< Set sensor value interval */
-  int (*set_batch_latency)(uint32_t sensor_device_id, uint32_t id, unsigned long val); /**< Set batch latency */
-  int (*set_attribute_int)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, int32_t value); /**< Set attribute as an integer value */
-  int (*set_attribute_str)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, const char *value, size_t len); /**< Set attribute as a string value */
-  int (*get_attribute_int)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, int32_t *value); /**< Get integer attribute value */
-  int (*get_attribute_str)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, char **value, size_t *len); /**< Get string attribute value */
+  /** Set sensor value interval */
+  int (*set_interval)(uint32_t sensor_device_id, uint32_t id, unsigned long val);
+  /** Set batch latency */
+  int (*set_batch_latency)(uint32_t sensor_device_id, uint32_t id, unsigned long val);
+  /** 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 */
+  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 */
+  int (*get_attribute_int)(uint32_t sensor_device_id, uint32_t id, int32_t attribute, int32_t *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);
 
-  int (*flush)(uint32_t sensor_device_id, uint32_t id); /**< Flush sensor datas */
+  /** Flush sensor datas */
+  int (*flush)(uint32_t sensor_device_id, uint32_t id);
 } sensor_device_s;
 
 /**
@@ -63,8 +76,10 @@ typedef struct {
  */
 
 typedef struct _hal_backend_sensor_funcs {
-  int (*create_sensor)(sensor_device_s ***sensor_devices, size_t *sensor_devices_len); /**< Create sensor devices */
-  int (*delete_sensor)(uint32_t *sensor_device_ids, size_t sensor_device_ids_len); /**< Delete sensors with their ids */
+  /** Create sensor devices */
+  int (*create_sensor)(sensor_device_s ***sensor_devices, size_t *sensor_devices_len);
+  /** Delete sensors with their ids */
+  int (*delete_sensor)(uint32_t *sensor_device_ids, size_t sensor_device_ids_len);
 } hal_backend_sensor_funcs;
 
 /**