From: Yunhee Seo <yuni.seo@samsung.com>
Date: Thu, 8 Aug 2024 06:10:57 +0000 (+0900)
Subject: Fix wrong style description to Native API header style
X-Git-Tag: accepted/tizen/unified/20240809.055151^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Faccepted%2Ftizen_unified_dev;p=platform%2Fcore%2Fapi%2Fdevice.git

Fix wrong style description to Native API header style

Remove the wrong style descriptions and change descriptions
to keep Native API style.

Change-Id: Id7b12cd457483e4149123032a133fb71f1ba7c34
Signed-off-by: Yunhee Seo <yuni.seo@samsung.com>
---

diff --git a/doc/device_doc.h b/doc/device_doc.h
index d1d394b..1d7aa00 100644
--- a/doc/device_doc.h
+++ b/doc/device_doc.h
@@ -60,7 +60,7 @@
  * It also supports the API for an application to receive the battery events from the system.
  * To receive the battery event it should be described by the callback function.
  *
- * @section CAPI_SYSTEM_DEVICE_BATTERY_MODULE_OVERVIEW Related Features
+ * @section CAPI_SYSTEM_DEVICE_BATTERY_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - %http://tizen.org/feature/battery\n
  *
@@ -89,7 +89,7 @@
  * It also supports the API to set the display brightness.
  * Application can receive the display event by callback function from the system.
  *
- * @section CAPI_SYSTEM_DEVICE_DISPLAY_MODULE__FEATURE Related Features
+ * @section CAPI_SYSTEM_DEVICE_DISPLAY_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - %http://tizen.org/feature/display\n
  * - %http://tizen.org/feature/display.state\n
@@ -116,7 +116,7 @@
  * The Haptic API provides the way to control vibration functionality of a device.
  * It allows the management of the device's vibrator parameters, such as the vibration count and level.
  *
- * @section CAPI_SYSTEM_DEVICE_HAPTIC_MODULE__FEATURE Related Features
+ * @section CAPI_SYSTEM_DEVICE_HAPTIC_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - %http://tizen.org/feature/feedback.vibration\n
  *
@@ -169,7 +169,7 @@
  * The Power API provides the way to control the power service.
  * It can be made to hold the specific state to avoid changing display and CPU state internally.
  *
- * @section CAPI_SYSTEM_DEVICE_POWER_MODULE__FEATURE Related Features
+ * @section CAPI_SYSTEM_DEVICE_POWER_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - %http://tizen.org/feature/display.state\n
  *
diff --git a/include/battery.h b/include/battery.h
index 46f8a5c..ca96ac9 100644
--- a/include/battery.h
+++ b/include/battery.h
@@ -105,7 +105,6 @@ typedef enum {
  * @details It returns an integer value from @c 0 to @c 100 that indicates remaining battery charge
  *          as a percentage of the maximum level.
  * @since_tizen 2.3
- * @remarks In order to be notified when the battery state changes, use system_info_set_changed_cb().
  * @param[out] percent The remaining battery charge percentage (@c 0 ~ @c 100)
  * @return @c 0 on success,
  *         otherwise a negative error value
diff --git a/include/callback.h b/include/callback.h
index 887855a..afc8fee 100644
--- a/include/callback.h
+++ b/include/callback.h
@@ -53,13 +53,13 @@ typedef enum {
  * @details Each device callback has a different output param type. \n
  *          So you need to check below output param before using this function. \n
  *                  callback enum               output type \n
- *          DEVICE_CALLBACK_BATTERY_CAPACITY        int \n
- *          DEVICE_CALLBACK_BATTERY_LEVEL           int \n
- *          DEVICE_CALLBACK_BATTERY_CHARGING        bool \n
- *          DEVICE_CALLBACK_DISPLAY_STATE           int \n
- *          DEVICE_CALLBACK_FLASH_BRIGHTNESS        int
+ *          #DEVICE_CALLBACK_BATTERY_CAPACITY        int \n
+ *          #DEVICE_CALLBACK_BATTERY_LEVEL           int \n
+ *          #DEVICE_CALLBACK_BATTERY_CHARGING        bool \n
+ *          #DEVICE_CALLBACK_DISPLAY_STATE           int \n
+ *          #DEVICE_CALLBACK_FLASH_BRIGHTNESS        int
  * @since_tizen 2.3
- * @remarks DEVICE_CALLBACK_FLASH_BRIGHTNESS callback invoked when user set flash brightness by using device_flash_set_brightness(). It does not work by camera flash operation. To register DEVICE_CALLBACK_FLASH_BRIGHTNESS callback, you need to declare the LED privilege (%http://tizen.org/privilege/led).
+ * @remarks #DEVICE_CALLBACK_FLASH_BRIGHTNESS callback invoked when user set flash brightness by using device_flash_set_brightness(). It does not work by camera flash operation. To register #DEVICE_CALLBACK_FLASH_BRIGHTNESS callback, you need to declare the LED privilege (%http://tizen.org/privilege/led).
  * @param[out] type The device type to monitor
  * @param[out] value The changed value
  * @param[out] user_data The user data passed from the callback registration function