From fcec57e69c0a36c65d3e3e09ed2c00d96e9bc9e0 Mon Sep 17 00:00:00 2001 From: SangYoun Kwak Date: Thu, 23 May 2024 10:44:45 +0900 Subject: [PATCH] Fix remarks and example codes as its rules To use parameter name in the, format is: "@a " Also, in the example code, spaces should be used instead of tabs. Change-Id: Ie6944944436fc5af9aa6e2354c85f9245092f936 Signed-off-by: SangYoun Kwak --- include/sensor.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/sensor.h b/include/sensor.h index 6738ca7..ecfba59 100644 --- a/include/sensor.h +++ b/include/sensor.h @@ -242,7 +242,7 @@ int sensor_is_wake_up(sensor_h sensor, bool *wakeup); * #SENSOR_HRM, #SENSOR_HRM_LED_GREEN, #SENSOR_HRM_LED_IR, #SENSOR_HRM_LED_RED, * #SENSOR_HUMAN_PEDOMETER, #SENSOR_HUMAN_SLEEP_MONITOR, #SENSOR_HUMAN_SLEEP_DETECTOR, * and #SENSOR_HUMAN_STRESS_MONITOR. - * @remarks The @sensor should not be released. + * @remarks The @a sensor should not be released. * * @param[in] type A sensor type to get the handle of its default sensor * @param[out] sensor The sensor handle of the default sensor @@ -264,7 +264,7 @@ int sensor_is_wake_up(sensor_h sensor, bool *wakeup); * sensor_h sensor; * ret = sensor_get_default_sensor(SENSOR_ACCELEROMETER, &sensor); * if (ret != SENSOR_ERROR_NONE) - * return ret; + * return ret; * ... * @endcode */ @@ -281,7 +281,7 @@ int sensor_get_default_sensor(sensor_type_e type, sensor_h *sensor); * @remarks Some sensor types are privileged. An application should have the privilege * %http://tizen.org/privilege/healthinfo to get handles for the sensor URIs of @"healthinfo@" category. * See \ref CAPI_SYSTEM_SENSOR_LISTENER_MODULE_URI to find the @"healthinfo@" category sensor URIs. - * @remarks The @sensor should not be released. + * @remarks The @a sensor should not be released. * * @param[in] uri A sensor or a sensor type URI to get the handle of its default sensor * @param[out] sensor The default sensor handle @@ -303,7 +303,7 @@ int sensor_get_default_sensor(sensor_type_e type, sensor_h *sensor); * sensor_h sensor; * ret = sensor_get_default_sensor_by_uri("http://tizen.org/sensor/general/accelerometer", &sensor); * if (ret != SENSOR_ERROR_NONE) - * return ret; + * return ret; * ... * @endcode */ -- 2.34.1