From 91151bd479fc08f6bef98106026e53ff4a019cc2 Mon Sep 17 00:00:00 2001 From: Somin Kim Date: Mon, 22 May 2017 11:15:55 +0900 Subject: [PATCH] [History] Align contents for better readability Change-Id: I67a0bd0d15d6fef3b4adf1633bfcd5bd836652de Signed-off-by: Somin Kim --- include/context_history.h | 102 +++++++++++++++++++++++++--------------------- 1 file changed, 56 insertions(+), 46 deletions(-) diff --git a/include/context_history.h b/include/context_history.h index d0c918d..f90b3f5 100644 --- a/include/context_history.h +++ b/include/context_history.h @@ -109,14 +109,14 @@ extern "C" { * @since_tizen 2.4 */ typedef enum { - CONTEXT_HISTORY_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + CONTEXT_HISTORY_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ CONTEXT_HISTORY_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ CONTEXT_HISTORY_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ CONTEXT_HISTORY_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Memory allocation failed */ CONTEXT_HISTORY_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA, /**< No Data */ - CONTEXT_HISTORY_ERROR_OUT_OF_RANGE = (TIZEN_ERROR_CONTEXT | 0x03), /**< Out of range */ - CONTEXT_HISTORY_ERROR_OPERATION_FAILED = (TIZEN_ERROR_CONTEXT | 0x04), /**< Operation failed */ + CONTEXT_HISTORY_ERROR_OUT_OF_RANGE = (TIZEN_ERROR_CONTEXT | 0x03), /**< Out of range */ + CONTEXT_HISTORY_ERROR_OPERATION_FAILED = (TIZEN_ERROR_CONTEXT | 0x04), /**< Operation failed */ } context_history_error_e; /** @@ -124,18 +124,28 @@ typedef enum { * @since_tizen 2.4 */ typedef enum { - CONTEXT_HISTORY_RECENTLY_USED_APP = 1, /**< Recently used application.@n Privilege : http://tizen.org/privilege/apphistory.read*/ - CONTEXT_HISTORY_FREQUENTLY_USED_APP, /**< Frequently used application.@n Privilege : http://tizen.org/privilege/apphistory.read*/ - CONTEXT_HISTORY_RARELY_USED_APP, /**< Rarely used application.@n Privilege : http://tizen.org/privilege/apphistory.read (Deprecated since 4.0)*/ - CONTEXT_HISTORY_PEAK_TIME_FOR_APP, /**< Peak time of application use activity.@n Privilege : http://tizen.org/privilege/apphistory.read (Deprecated since 4.0)*/ - CONTEXT_HISTORY_PEAK_TIME_FOR_MUSIC, /**< Peak time of music listening activity.@n Privilege : http://tizen.org/privilege/mediahistory.read (Deprecated since 4.0)*/ - CONTEXT_HISTORY_PEAK_TIME_FOR_VIDEO, /**< Peak time of video watching activity.@n Privilege : http://tizen.org/privilege/mediahistory.read (Deprecated since 4.0)*/ - CONTEXT_HISTORY_COMMON_SETTING_FOR_APP, /**< Common setting value of application use activity.@n Privilege : http://tizen.org/privilege/apphistory.read (Deprecated since 4.0)*/ - CONTEXT_HISTORY_COMMON_SETTING_FOR_MUSIC, /**< Common setting value of music listening activity.@n Privilege : http://tizen.org/privilege/mediahistory.read (Deprecated since 4.0)*/ - CONTEXT_HISTORY_COMMON_SETTING_FOR_VIDEO, /**< Common setting value of video watching activity.@n Privilege : http://tizen.org/privilege/mediahistory.read (Deprecated since 4.0)*/ - CONTEXT_HISTORY_FREQUENTLY_COMMUNICATED_ADDRESS, /**< Frequently communicated address.@n Privilege : http://tizen.org/privilege/callhistory.read (Deprecated since 4.0)*/ - CONTEXT_HISTORY_BATTERY_USAGE, /**< Per-app battery usage in percentage (Since 3.0) @n Privilege : http://tizen.org/privilege/apphistory.read*/ - CONTEXT_HISTORY_RECENT_BATTERY_USAGE, /**< Per-app battery usage in percentage since last charge (Since 3.0) @n Privilege : http://tizen.org/privilege/apphistory.read*/ + CONTEXT_HISTORY_RECENTLY_USED_APP = 1, /**< Recently used application @n Privilege : http://tizen.org/privilege/apphistory.read */ + CONTEXT_HISTORY_FREQUENTLY_USED_APP, /**< Frequently used application @n Privilege : http://tizen.org/privilege/apphistory.read */ + CONTEXT_HISTORY_RARELY_USED_APP, /**< Rarely used application (Deprecated since 4.0) + @n Privilege : http://tizen.org/privilege/apphistory.read */ + CONTEXT_HISTORY_PEAK_TIME_FOR_APP, /**< Peak time of application use activity (Deprecated since 4.0) + @n Privilege : http://tizen.org/privilege/apphistory.read */ + CONTEXT_HISTORY_PEAK_TIME_FOR_MUSIC, /**< Peak time of music listening activity (Deprecated since 4.0) + @n Privilege : http://tizen.org/privilege/mediahistory.read */ + CONTEXT_HISTORY_PEAK_TIME_FOR_VIDEO, /**< Peak time of video watching activity (Deprecated since 4.0) + @n Privilege : http://tizen.org/privilege/mediahistory.read */ + CONTEXT_HISTORY_COMMON_SETTING_FOR_APP, /**< Common setting value of application use activity (Deprecated since 4.0) + @n Privilege : http://tizen.org/privilege/apphistory.read */ + CONTEXT_HISTORY_COMMON_SETTING_FOR_MUSIC, /**< Common setting value of music listening activity (Deprecated since 4.0) + @n Privilege : http://tizen.org/privilege/mediahistory.read */ + CONTEXT_HISTORY_COMMON_SETTING_FOR_VIDEO, /**< Common setting value of video watching activity (Deprecated since 4.0) + @n Privilege : http://tizen.org/privilege/mediahistory.read */ + CONTEXT_HISTORY_FREQUENTLY_COMMUNICATED_ADDRESS, /**< Frequently communicated address (Deprecated since 4.0) + @n Privilege : http://tizen.org/privilege/callhistory.read */ + CONTEXT_HISTORY_BATTERY_USAGE, /**< Per-app battery usage in percentage (Since 3.0) + @n Privilege : http://tizen.org/privilege/apphistory.read */ + CONTEXT_HISTORY_RECENT_BATTERY_USAGE, /**< Per-app battery usage in percentage since last charge (Since 3.0) + @n Privilege : http://tizen.org/privilege/apphistory.read */ } context_history_data_e; /** @@ -143,15 +153,15 @@ typedef enum { * @since_tizen 2.4 */ typedef enum { - CONTEXT_HISTORY_FILTER_TIME_SPAN = 1, /**< Time span of data in days*/ - CONTEXT_HISTORY_FILTER_RESULT_SIZE, /**< Result size of data records*/ - CONTEXT_HISTORY_FILTER_APP_ID, /**< Application id (Deprecated since 4.0)*/ - CONTEXT_HISTORY_FILTER_DAY_OF_WEEK, /**< Weekdays, weekends (Deprecated since 4.0)*/ - CONTEXT_HISTORY_FILTER_START_TIME, /**< Start time of data in epoch time*/ - CONTEXT_HISTORY_FILTER_END_TIME, /**< End time of data in epoch time*/ - CONTEXT_HISTORY_FILTER_WIFI_BSSID, /**< Wi-Fi BSSID value (Deprecated since 4.0)*/ - CONTEXT_HISTORY_FILTER_AUDIO_JACK, /**< Audio jack status value*/ - CONTEXT_HISTORY_FILTER_COMMUNICATION_TYPE /**< Type of phone log (Deprecated since 4.0)*/ + CONTEXT_HISTORY_FILTER_TIME_SPAN = 1, /**< Time span of data in days */ + CONTEXT_HISTORY_FILTER_RESULT_SIZE, /**< Result size of data records */ + CONTEXT_HISTORY_FILTER_APP_ID, /**< Application id (Deprecated since 4.0) */ + CONTEXT_HISTORY_FILTER_DAY_OF_WEEK, /**< Weekdays, weekends (Deprecated since 4.0) */ + CONTEXT_HISTORY_FILTER_START_TIME, /**< Start time of data in epoch time */ + CONTEXT_HISTORY_FILTER_END_TIME, /**< End time of data in epoch time */ + CONTEXT_HISTORY_FILTER_WIFI_BSSID, /**< Wi-Fi BSSID value (Deprecated since 4.0) */ + CONTEXT_HISTORY_FILTER_AUDIO_JACK, /**< Audio jack status value */ + CONTEXT_HISTORY_FILTER_COMMUNICATION_TYPE /**< Type of phone log (Deprecated since 4.0) */ } context_history_filter_e; /** @@ -160,9 +170,9 @@ typedef enum { * @since_tizen 2.4 */ typedef enum { - CONTEXT_HISTORY_FILTER_DAY_OF_WEEK_WEEKDAYS = 1, /**< Includes only weekdays*/ - CONTEXT_HISTORY_FILTER_DAY_OF_WEEK_WEEKENDS, /**< Includes only weekends*/ - CONTEXT_HISTORY_FILTER_DAY_OF_WEEK_ALL /**< Includes all days*/ + CONTEXT_HISTORY_FILTER_DAY_OF_WEEK_WEEKDAYS = 1, /**< Includes only weekdays */ + CONTEXT_HISTORY_FILTER_DAY_OF_WEEK_WEEKENDS, /**< Includes only weekends */ + CONTEXT_HISTORY_FILTER_DAY_OF_WEEK_ALL /**< Includes all days */ } context_history_filter_day_of_week_e; /** @@ -170,8 +180,8 @@ typedef enum { * @since_tizen 2.4 */ typedef enum { - CONTEXT_HISTORY_FILTER_AUDIO_JACK_NOT_CONNECTED = 0, /**< Audio jack is not connected*/ - CONTEXT_HISTORY_FILTER_AUDIO_JACK_CONNECTED /**< Audio jack is connected*/ + CONTEXT_HISTORY_FILTER_AUDIO_JACK_NOT_CONNECTED = 0, /**< Audio jack is not connected */ + CONTEXT_HISTORY_FILTER_AUDIO_JACK_CONNECTED /**< Audio jack is connected */ } context_history_filter_audio_jack_e; /** @@ -180,9 +190,9 @@ typedef enum { * @since_tizen 2.4 */ typedef enum { - CONTEXT_HISTORY_FILTER_COMMUNICATION_TYPE_CALL = 1, /**< Includes only call logs*/ - CONTEXT_HISTORY_FILTER_COMMUNICATION_TYPE_MESSAGE, /**< Includes only message logs*/ - CONTEXT_HISTORY_FILTER_COMMUNICATION_TYPE_ALL /**< Includes all logs*/ + CONTEXT_HISTORY_FILTER_COMMUNICATION_TYPE_CALL = 1, /**< Includes only call logs */ + CONTEXT_HISTORY_FILTER_COMMUNICATION_TYPE_MESSAGE, /**< Includes only message logs */ + CONTEXT_HISTORY_FILTER_COMMUNICATION_TYPE_ALL /**< Includes all logs */ } context_history_filter_communication_type_e; /** @@ -218,8 +228,8 @@ typedef struct _context_history_record_handle_s* context_history_record_h; * * @return @c 0 on success, otherwise a negative error value * @retval #CONTEXT_HISTORY_ERROR_NONE Successful - * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY Out of memory * * @see context_history_destroy() */ @@ -235,7 +245,7 @@ int context_history_create(context_history_h* handle); * * @return @c 0 on success, otherwise a negative error value * @retval #CONTEXT_HISTORY_ERROR_NONE Successful - * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter * * @pre context_history_create() */ @@ -341,12 +351,12 @@ int context_history_is_supported(context_history_data_e data_type, bool* support * * @return @c 0 on success, otherwise a negative error value * @retval #CONTEXT_HISTORY_ERROR_NONE Successful - * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTEXT_HISTORY_ERROR_PERMISSION_DENIED Permission denied + * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTEXT_HISTORY_ERROR_PERMISSION_DENIED Permission denied * @retval #CONTEXT_HISTORY_ERROR_NOT_SUPPORTED Unsupported history data contained * @retval #CONTEXT_HISTORY_ERROR_OPERATION_FAILED Operation failed - * @retval #CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY Out of memory - * @retval #CONTEXT_HISTORY_ERROR_NO_DATA Requested data does not exist + * @retval #CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTEXT_HISTORY_ERROR_NO_DATA Requested data does not exist * * @pre context_history_create() * @post context_history_list_destroy() @@ -362,7 +372,7 @@ int context_history_get_list(context_history_h handle, context_history_data_e da * * @return @c 0 on success, otherwise a negative error value * @retval #CONTEXT_HISTORY_ERROR_NONE Successful - * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter * @retval #CONTEXT_HISTORY_ERROR_OPERATION_FAILED Operation failed * * @pre context_history_get_list() @@ -382,9 +392,9 @@ int context_history_list_get_count(context_history_list_h list, int* count); * * @return @c 0 on success, otherwise a negative error value * @retval #CONTEXT_HISTORY_ERROR_NONE Successful - * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter * @retval #CONTEXT_HISTORY_ERROR_OPERATION_FAILED Operation failed - * @retval #CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY Out of memory + * @retval #CONTEXT_HISTORY_ERROR_OUT_OF_MEMORY Out of memory * * @pre context_history_get_list() * @post context_history_record_destroy() @@ -399,7 +409,7 @@ int context_history_list_get_current(context_history_list_h list, context_histor * * @return @c 0 on success, otherwise a negative error value * @retval #CONTEXT_HISTORY_ERROR_NONE Successful - * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter * * @pre context_history_get_list() * @see context_history_list_get_count() @@ -415,8 +425,8 @@ int context_history_list_move_first(context_history_list_h list); * * @return @c 0 on success, otherwise a negative error value * @retval #CONTEXT_HISTORY_ERROR_NONE Successful - * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #CONTEXT_HISTORY_ERROR_NO_DATA Requested data does not exist + * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTEXT_HISTORY_ERROR_NO_DATA Requested data does not exist * * @pre context_history_get_list() * @see context_history_list_get_count() @@ -432,7 +442,7 @@ int context_history_list_move_next(context_history_list_h list); * * @return @c 0 on success, otherwise a negative error value * @retval #CONTEXT_HISTORY_ERROR_NONE Successful - * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #CONTEXT_HISTORY_ERROR_INVALID_PARAMETER Invalid parameter * * @pre context_history_get_list() */ -- 2.7.4