From 2391e5c97b219f7b0c2e9890f0427667c12e0426 Mon Sep 17 00:00:00 2001 From: Kichan Kwon Date: Wed, 14 Jun 2017 15:01:03 +0900 Subject: [PATCH] Unify doxygen comment format - Add @privlevel before @privilege - Add @return before @retval - Unify whitespace Change-Id: Ic0c0a2f34c60df5419d2b9fb1e1570b81a8e4ee0 Signed-off-by: Kichan Kwon --- include/runtime_info.h | 571 +++++++++++++++++++++++++++---------------------- 1 file changed, 315 insertions(+), 256 deletions(-) diff --git a/include/runtime_info.h b/include/runtime_info.h index d49b6e4..426e383 100644 --- a/include/runtime_info.h +++ b/include/runtime_info.h @@ -26,292 +26,319 @@ extern "C" /** - * @addtogroup CAPI_SYSTEM_RUNTIME_INFO_MODULE + * @addtogroup CAPI_SYSTEM_RUNTIME_INFO_MODULE * @{ */ /** - * @brief Enumeration for error codes for runtime information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @brief Enumeration for error codes for runtime information. + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif */ typedef enum { - RUNTIME_INFO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + RUNTIME_INFO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ RUNTIME_INFO_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ - RUNTIME_INFO_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ - RUNTIME_INFO_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< An input/output error occurred when read value from system */ - RUNTIME_INFO_ERROR_REMOTE_IO = TIZEN_ERROR_REMOTE_IO, /**< Remote I/O error occured */ + RUNTIME_INFO_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ + RUNTIME_INFO_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< An input/output error occurred when read value from system */ + RUNTIME_INFO_ERROR_REMOTE_IO = TIZEN_ERROR_REMOTE_IO, /**< Remote I/O error occurred */ RUNTIME_INFO_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< No permission to use the api */ - RUNTIME_INFO_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported parameter */ - RUNTIME_INFO_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA /**< No data available (Since 3.0) */ + RUNTIME_INFO_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported parameter */ + RUNTIME_INFO_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA /**< No data available (Since 3.0) */ } runtime_info_error_e; /** - * @brief Enumeration for keys for runtime information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @brief Enumeration for keys for runtime information. + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif */ typedef enum { - RUNTIME_INFO_KEY_BLUETOOTH_ENABLED = 2, /** @@ -513,20 +569,23 @@ int runtime_info_get_all_apps_memory_usage(app_usage_h *usage); /** - * @brief Gets CPU rate of all apps. + * @brief Gets CPU rate of all apps. * @since_tizen 4.0 * + * @privlevel public * @privilege %http://tizen.org/privilege/systemmonitor - * @remarks You must release @a rate using runtime_info_app_usage_destroy(). - * - * @param[out] rate An array of each app's CPU usage rate (%), the values are rounded down. - * - * @retval #RUNTIME_INFO_ERROR_NONE Successful - * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Not able to allocate memory (for output param/other operations) - * @retval #RUNTIME_INFO_ERROR_REMOTE_IO Call to resource daemon failed (dbus errors/resource daemon errors) - * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error during dbus message operations - * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED Process not authorized to request app usage info + * @remarks You must release @a rate using runtime_info_app_usage_destroy(). + * + * @param[out] rate An array of each app's CPU usage rate (%), the values are rounded down. + * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #RUNTIME_INFO_ERROR_NONE Successful + * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Not able to allocate memory (for output param/other operations) + * @retval #RUNTIME_INFO_ERROR_REMOTE_IO Call to resource daemon failed (dbus errors/resource daemon errors) + * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error during dbus message operations + * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED Process not authorized to request app usage info * * @code * #include -- 2.7.4