From 7d4bec5f746aa96fd4bef47af35f523ba120f920 Mon Sep 17 00:00:00 2001 From: Kichan Kwon Date: Tue, 3 Sep 2019 10:58:25 +0900 Subject: [PATCH] Change the category of API reference - System - Battery - Battery Monitor - This doc header file also define System - Battery category Change-Id: I3f1198241b123792d00228857856042f5966b12c Signed-off-by: Kichan Kwon --- doc/{battery_monitor_doc.h => battery_doc.h} | 24 +++++++++++++------- include/battery_monitor.h | 6 ++--- include/battery_monitor_dbg.h | 6 ++--- include/battery_monitor_internal.h | 6 ++--- include/battery_monitor_util.h | 6 ++--- 5 files changed, 28 insertions(+), 20 deletions(-) rename doc/{battery_monitor_doc.h => battery_doc.h} (81%) diff --git a/doc/battery_monitor_doc.h b/doc/battery_doc.h similarity index 81% rename from doc/battery_monitor_doc.h rename to doc/battery_doc.h index a237c30..a8a0740 100755 --- a/doc/battery_monitor_doc.h +++ b/doc/battery_doc.h @@ -14,19 +14,27 @@ * limitations under the License. */ -#ifndef __TIZEN_SERVICE_BATTERY_MONITOR_DOC_H__ -#define __TIZEN_SERVICE_BATTERY_MONITOR_DOC_H__ +#ifndef __TIZEN_SYSTEM_BATTERY_DOC_H__ +#define __TIZEN_SYSTEM_BATTERY_DOC_H__ /** - * @ingroup CAPI_SERVICE_FRAMEWORK - * @defgroup CAPI_SERVICE_BATTERY_MONITOR_MODULE Battery Monitor + * @ingroup CAPI_SYSTEM_FRAMEWORK + * @defgroup CAPI_SYSTEM_BATTERY_MODULE Battery + * + * @brief The Battery API provides functions to get status of battery. + * + */ + +/** + * @ingroup CAPI_SYSTEM_BATTERY_MODULE + * @defgroup CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE Battery Monitor * * @brief The API's provide per resource battery consumption by the application. * - * @section CAPI_SERVICE_BATTERY_MONITOR_MODULE_HEADER Required Header + * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_HEADER Required Header * \#include * - * @section CAPI_SERVICE_BATTERY_MONITOR_MODULE_OVERVIEW Overview + * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_OVERVIEW Overview * Battery consumption by a device does not only comprises power consumed by CPU, * but it also includes power consumed by other components like - WiFi, Bt, Display, Mobile radio etc. * The user is normally unaware of power consumed by these components & hence when battery drains out, @@ -49,7 +57,7 @@ * - total battery usage in percent by an app-id for certain time duration. * - battery consumption in percent usage by a resource for certain time duration. * - * @section CAPI_SERVICE_BATTERY_MONITOR_MODULE_FEATURE Related Features + * @section CAPI_SYSTEM_BATTERY_BATTERY_MONITOR_MODULE_FEATURE Related Features * The API's defined are related with the following features:\n * - http://tizen.org/feature/battery\n * @@ -61,5 +69,5 @@ * */ -#endif /* __TIZEN_SERVICE_BATTERY_MONITOR_DOC_H__ */ +#endif /* __TIZEN_SYSTEM_BATTERY_DOC_H__ */ diff --git a/include/battery_monitor.h b/include/battery_monitor.h index 8ff32c6..fca285c 100644 --- a/include/battery_monitor.h +++ b/include/battery_monitor.h @@ -15,8 +15,8 @@ * */ -#ifndef __TIZEN_SERVICE_BATTERY_MONITOR_H__ -#define __TIZEN_SERVICE_BATTERY_MONITOR_H__ +#ifndef __TIZEN_SYSTEM_BATTERY_MONITOR_H__ +#define __TIZEN_SYSTEM_BATTERY_MONITOR_H__ #include @@ -242,4 +242,4 @@ int battery_monitor_get_total_usage_by_resource_id(battery_monitor_resource_id_e } #endif -#endif /* __TIZEN_SERVICE_BATTERY_MONITOR_H__ */ +#endif /* __TIZEN_SYSTEM_BATTERY_MONITOR_H__ */ diff --git a/include/battery_monitor_dbg.h b/include/battery_monitor_dbg.h index 21ecc0a..a988d9c 100644 --- a/include/battery_monitor_dbg.h +++ b/include/battery_monitor_dbg.h @@ -15,8 +15,8 @@ * */ -#ifndef __TIZEN_SERVICE_BATTERY_MONITOR_DBG_H__ -#define __TIZEN_SERVICE_BATTERY_MONITOR_DBG_H__ +#ifndef __TIZEN_SYSTEM_BATTERY_MONITOR_DBG_H__ +#define __TIZEN_SYSTEM_BATTERY_MONITOR_DBG_H__ #include #include @@ -54,4 +54,4 @@ extern "C" { } #endif -#endif /* __TIZEN_SERVICE_BATTERY_MONITOR_DBG_H__ */ +#endif /* __TIZEN_SYSTEM_BATTERY_MONITOR_DBG_H__ */ diff --git a/include/battery_monitor_internal.h b/include/battery_monitor_internal.h index d8020cf..910b311 100644 --- a/include/battery_monitor_internal.h +++ b/include/battery_monitor_internal.h @@ -15,8 +15,8 @@ * */ -#ifndef __TIZEN_SERVICE_BATTERY_MONITOR_INTERNAL_H__ -#define __TIZEN_SERVICE_BATTERY_MONITOR_INTERNAL_H__ +#ifndef __TIZEN_SYSTEM_BATTERY_MONITOR_INTERNAL_H__ +#define __TIZEN_SYSTEM_BATTERY_MONITOR_INTERNAL_H__ #ifdef __cplusplus @@ -43,4 +43,4 @@ struct battery_monitor_total_consumption_s { } #endif -#endif /* __TIZEN_SERVICE_BATTERY_MONITOR_INTERNAL_H__ */ +#endif /* __TIZEN_SYSTEM_BATTERY_MONITOR_INTERNAL_H__ */ diff --git a/include/battery_monitor_util.h b/include/battery_monitor_util.h index 3161edc..e12b039 100644 --- a/include/battery_monitor_util.h +++ b/include/battery_monitor_util.h @@ -15,8 +15,8 @@ * */ -#ifndef __TIZEN_SERVICE_BATTERY_MONITOR_UTIL_H__ -#define __TIZEN_SERVICE_BATTERY_MONITOR_UTIL_H__ +#ifndef __TIZEN_SYSTEM_BATTERY_MONITOR_UTIL_H__ +#define __TIZEN_SYSTEM_BATTERY_MONITOR_UTIL_H__ #include #include @@ -146,4 +146,4 @@ void unmarshal_serialized_data(GVariant *handle, battery_monitor_h data_handle); } #endif -#endif /* __TIZEN_SERVICE_BATTERY_MONITOR_UTIL_H__ */ +#endif /* __TIZEN_SYSTEM_BATTERY_MONITOR_UTIL_H__ */ -- 2.34.1