diff options
author | Hwankyu Jhun <h.jhun@samsung.com> | 2016-12-16 13:42:48 +0900 |
---|---|---|
committer | Hwankyu Jhun <h.jhun@samsung.com> | 2016-12-16 15:09:15 +0900 |
commit | 0b07e6ed0dd8215b8fc7744e7508cd49657ae186 (patch) | |
tree | 73ee21f348d9fa68f0e8f20f72c072268c178fea | |
parent | f24cb6537f74546932b43f0f0e2165862cce9af2 (diff) | |
download | minicontrol-0b07e6ed0dd8215b8fc7744e7508cd49657ae186.tar.gz minicontrol-0b07e6ed0dd8215b8fc7744e7508cd49657ae186.tar.bz2 minicontrol-0b07e6ed0dd8215b8fc7744e7508cd49657ae186.zip |
Fix API descriptionsubmit/tizen_3.0/20161216.082724submit/tizen_3.0.m2/20170104.093749accepted/tizen/3.0/wearable/20161219.095446accepted/tizen/3.0/tv/20161219.073818accepted/tizen/3.0/ivi/20161219.071306accepted/tizen/3.0/common/20161219.113516accepted/tizen/3.0.m2/wearable/20170104.122806accepted/tizen/3.0.m2/tv/20170104.122418accepted/tizen/3.0.m2/mobile/20170104.121921tizen_3.0.m2accepted/tizen_3.0.m2_wearableaccepted/tizen_3.0.m2_tvaccepted/tizen_3.0.m2_mobile
Change-Id: I53721b9fc41b2bff687e6010250fac03fe17224c
Signed-off-by: Hwankyu Jhun <h.jhun@samsung.com>
-rw-r--r-- | doc/minicontrol_doc.h | 26 | ||||
-rwxr-xr-x | include/minicontrol-error.h | 14 | ||||
-rwxr-xr-x | include/minicontrol-provider.h | 18 | ||||
-rwxr-xr-x | include/minicontrol-type.h | 33 | ||||
-rwxr-xr-x | include/minicontrol-viewer.h | 22 |
5 files changed, 53 insertions, 60 deletions
diff --git a/doc/minicontrol_doc.h b/doc/minicontrol_doc.h index 5718f82..3817919 100644 --- a/doc/minicontrol_doc.h +++ b/doc/minicontrol_doc.h @@ -15,10 +15,8 @@ */ /** - * - * @defgroup MINICONTROL_LIBRARY Minicontrol * @ingroup CAPI_UI_FRAMEWORK - * + * @defgroup MINICONTROL_LIBRARY Minicontrol * @section MINICONTROL_LIBRARY_OVERVIEW Overview * <table> * <tr> @@ -32,31 +30,29 @@ * <tr> * <td>@ref MINICONTROL_VIEWER_MODULE </td> * <td>Provides functions for displaying EFL socket window.<br> - * minicontrol holders calls this functions to attach minicontrols on UI area.</td> + * Minicontrol holders calls this functions to attach minicontrols on UI area.</td> * </tr> * </table> */ /** - * @defgroup MINICONTROL_PROVIDER_MODULE Provider - * @brief Minicontrol Provider APIs * @ingroup MINICONTROL_LIBRARY - * + * @defgroup MINICONTROL_PROVIDER_MODULE Provider + * @brief Minicontrol Provider APIs. * @section MINICONTROL_PROVIDER_MODULE_HEADER Required Header - * \#include <minicontrol-provider.h> + * \#include <minicontrol-provider.h> + * * @section MINICONTROL_PROVIDER_MODULE_OVERVIEW Overview * It provides functions for creating EFL socket window. - * */ /** - * @defgroup MINICONTROL_VIEWER_MODULE Viewer - * @brief Minicontrol Viewer APIs * @ingroup MINICONTROL_LIBRARY - * + * @defgroup MINICONTROL_VIEWER_MODULE Viewer + * @brief Minicontrol Viewer APIs. * @section MINICONTROL_VIEWER_MODULE_HEADER Required Header - * \#include <minicontrol-viewer.h> - * @section MINICONTROL_VIEWER_MODULE_OVERVIEW Overview - * It provides functions for displaying EFL socket window + * \#include <minicontrol-viewer.h> * + * @section MINICONTROL_VIEWER_MODULE_OVERVIEW Overview + * It provides functions for displaying EFL socket window. */ diff --git a/include/minicontrol-error.h b/include/minicontrol-error.h index 43a7022..460c74a 100755 --- a/include/minicontrol-error.h +++ b/include/minicontrol-error.h @@ -34,14 +34,14 @@ * @since_tizen 2.4 */ typedef enum _minicontrol_error { - MINICONTROL_ERROR_NONE = TIZEN_ERROR_NONE, /**< MiniControl error none */ - MINICONTROL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ - MINICONTROL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ + MINICONTROL_ERROR_NONE = TIZEN_ERROR_NONE, /**< MiniControl error none */ + MINICONTROL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ + MINICONTROL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ MINICONTROL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ - MINICONTROL_ERROR_IPC_FAILURE = TIZEN_ERROR_MINICONTROL | 0x02, /**< IPC error */ + MINICONTROL_ERROR_IPC_FAILURE = TIZEN_ERROR_MINICONTROL | 0x02, /**< IPC error */ MINICONTROL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< This function is not supported */ - MINICONTROL_ERROR_ELM_FAILURE = TIZEN_ERROR_MINICONTROL | 0x03, /**< Some error occurred when creating a minicontrol window */ - MINICONTROL_ERROR_UNKNOWN = TIZEN_ERROR_UNKNOWN, /**< Unknown error */ + MINICONTROL_ERROR_ELM_FAILURE = TIZEN_ERROR_MINICONTROL | 0x03, /**< Some error occurred when creating a minicontrol window */ + MINICONTROL_ERROR_UNKNOWN = TIZEN_ERROR_UNKNOWN, /**< Unknown error */ } minicontrol_error_e; /** @@ -49,5 +49,3 @@ typedef enum _minicontrol_error { */ #endif /* _MINICTRL_ERROR_H_ */ - - diff --git a/include/minicontrol-provider.h b/include/minicontrol-provider.h index b33dd08..1682d66 100755 --- a/include/minicontrol-provider.h +++ b/include/minicontrol-provider.h @@ -28,9 +28,9 @@ extern "C" { /** * @file minicontrol-provider.h - * @brief This minicontrol provider library used to create evas socket window.\n - * This library is providing functions for create a remote evas object to draw a minicontrol on a minicontrol viewer and\n - * sending some requests to the minicontrol viewer.\n + * @brief This minicontrol provider library is used to create evas socket window. \n + * This library provides functions to create a remote evas object to draw a minicontrol on a minicontrol viewer and \n + * sending some requests to the minicontrol viewer. \n * Drawings on this remote evas object will be shown on the place ofthe minicontrol viewer. */ @@ -40,10 +40,10 @@ extern "C" { */ /** - * @brief Called when a event comes from viewer + * @brief Called when a event comes from viewer. * @since_tizen 2.4 * @param[in] event_type The type of fired event - * @param[in] event_arg argument of the event + * @param[in] event_arg Argument of the event * @pre minicontrol_viewer_register_event_callback() used to register this callback. * @see #minicontrol_create_window * @see #minicontrol_viewer_event_e @@ -54,9 +54,9 @@ typedef void (*minicontrol_event_cb)(minicontrol_viewer_event_e event_type, bund * @brief Creates a window for minicontrol. * @since_tizen 2.4 * @param[in] name Name of minicontrol socket window - * @param[in] target_viewer Target viewer for minicontrol. You can select multiple viewers by using bitwise OR operator. - * @param[in] callback a callback function for events originated by minicontrol viewer. - * @return Evas object of socket window. @c NULL failed to create, get_last_result() will returns reason of failure. + * @param[in] target_viewer Target viewer for minicontrol. You can select multiple viewers by using bitwise OR operator + * @param[in] callback A callback function for events originated by minicontrol viewer + * @return Evas object of socket window. @c NULL failed to create, get_last_result() will return reason of failure * @see #minicontrol_target_viewer_e * @see #minicontrol_event_cb */ @@ -66,7 +66,7 @@ Evas_Object *minicontrol_create_window(const char *name, minicontrol_target_view * @brief Sends a event to the viewer. * @remarks When a viewer doesn't handle some events, it can be ignored. * @since_tizen 2.4 - * @param[in] mincontrol minicontrol window + * @param[in] minicontrol Minicontrol window * @param[in] event Type of the event * @param[in] event_arg Bundle argument of the event * @return #MINICONTROL_ERROR_NONE on success, diff --git a/include/minicontrol-type.h b/include/minicontrol-type.h index 154fb6d..3119b51 100755 --- a/include/minicontrol-type.h +++ b/include/minicontrol-type.h @@ -33,7 +33,6 @@ /** @section MINICONTROL_LIBRARY_EVENTS Events - <TABLE> <TR> <TD>Event Type</TD><TD>Originated by</TD> @@ -93,45 +92,45 @@ */ /** - * @brief Enumerations for describing types of events originated by a minicontrol provider. + * @brief Enumeration for describing types of events originated by a minicontrol provider. * @since_tizen 2.4 */ typedef enum { - MINICONTROL_EVENT_START, /**< A minicontrol object is created */ - MINICONTROL_EVENT_STOP, /**< A minicontrol object is deleted */ - MINICONTROL_EVENT_RESIZE, /**< A minicontrol object is resized */ - MINICONTROL_EVENT_REQUEST_HIDE = 100, /**< Requests that the minicontrol viewer(s) close the provider's minicontrol */ + MINICONTROL_EVENT_START, /**< A minicontrol object is created */ + MINICONTROL_EVENT_STOP, /**< A minicontrol object is deleted */ + MINICONTROL_EVENT_RESIZE, /**< A minicontrol object is resized */ + MINICONTROL_EVENT_REQUEST_HIDE = 100, /**< Requests that the minicontrol viewer(s) close the provider's minicontrol */ MINICONTROL_EVENT_REQUEST_ANGLE = 103, /**< Requests the current angle of the minicontrol viewer */ - MINICONTROL_EVENT_REPORT_ANGLE = 200, /**< Reports the current angle of the minicontrol viewer */ + MINICONTROL_EVENT_REPORT_ANGLE = 200, /**< Reports the current angle of the minicontrol viewer */ } minicontrol_event_e; /** - * @brief Enumerations for types of events which will be sent by minicontrol_send_event. + * @brief Enumeration for types of events which will be sent by minicontrol_send_event. * @since_tizen 2.4 */ typedef enum { - MINICONTROL_PROVIDER_EVENT_REQUEST_HIDE = MINICONTROL_EVENT_REQUEST_HIDE, /**< Requests that the minicontrol viewer(s) close the provider's minicontrol. Required bundle argument : NULL. */ + MINICONTROL_PROVIDER_EVENT_REQUEST_HIDE = MINICONTROL_EVENT_REQUEST_HIDE, /**< Requests that the minicontrol viewer(s) close the provider's minicontrol. Required bundle argument : NULL. */ MINICONTROL_PROVIDER_EVENT_REQUEST_ANGLE = MINICONTROL_EVENT_REQUEST_ANGLE, /**< Requests the current angle of the minicontrol viewer. Required bundle argument : NULL. */ } minicontrol_provider_event_e; /** - * @brief Enumerations for types of events which will be sent by minicontrol_viewer_send_event. + * @brief Enumeration for types of events which will be sent by minicontrol_viewer_send_event. * @since_tizen 2.4 */ typedef enum { - MINICONTROL_VIEWER_EVENT_REPORT_ANGLE = MINICONTROL_EVENT_REPORT_ANGLE, /**< Reports the current angle of the minicontrol viewer. Required argument : Angle of minicontrol viewer, Bundle Key : "angle", Bundle Value Type : string.*/ - MINICONTROL_VIEWER_EVENT_SHOW = 201, /**< The minicontrol viewer is shown. Required argument : NULL.*/ - MINICONTROL_VIEWER_EVENT_HIDE = 202, /**< The minicontrol viewer is hidden. Required argument : NULL.*/ + MINICONTROL_VIEWER_EVENT_REPORT_ANGLE = MINICONTROL_EVENT_REPORT_ANGLE, /**< Reports the current angle of the minicontrol viewer. Required argument : Angle of minicontrol viewer, Bundle Key : "angle", Bundle Value Type : string.*/ + MINICONTROL_VIEWER_EVENT_SHOW = 201, /**< The minicontrol viewer is shown. Required argument : NULL.*/ + MINICONTROL_VIEWER_EVENT_HIDE = 202, /**< The minicontrol viewer is hidden. Required argument : NULL.*/ } minicontrol_viewer_event_e; /** - * @brief Enumerations for selecting target viewers. + * @brief Enumeration for selecting target viewers. * @since_tizen 2.4 */ typedef enum { - MINICONTROL_TARGET_VIEWER_QUICK_PANEL = 0x0001, /**< Request to place the minicontrol on the quickpanel */ - MINICONTROL_TARGET_VIEWER_STOCK_LOCK_SCREEN = 0x0002, /**< Request to place the minicontrol on the stock lock screen */ - MINICONTROL_TARGET_VIEWER_CUSTOM_LOCK_SCREEN = 0x0004, /**< Request to place the minicontrol on a lock screen replacement application */ + MINICONTROL_TARGET_VIEWER_QUICK_PANEL = 0x0001, /**< Request to place the minicontrol on the quickpanel */ + MINICONTROL_TARGET_VIEWER_STOCK_LOCK_SCREEN = 0x0002, /**< Request to place the minicontrol on the stock lock screen */ + MINICONTROL_TARGET_VIEWER_CUSTOM_LOCK_SCREEN = 0x0004, /**< Request to place the minicontrol on a lock screen replacement application */ } minicontrol_target_viewer_e; /** diff --git a/include/minicontrol-viewer.h b/include/minicontrol-viewer.h index 1bd47f7..0599794 100755 --- a/include/minicontrol-viewer.h +++ b/include/minicontrol-viewer.h @@ -28,9 +28,9 @@ extern "C" { /** * @file minicontrol-viewer.h - * @brief This minicontrol viewer library used to display minicontrol which created by the minicontrol provider.\n - * This library is providing functions for attach a minicontrol viewer to a parent evas object and sending some requests to a minicontrol provider.\n - * The minicontrol viewer places a space which will be used by the minicontrol provider to draw minicontrol. + * @brief This minicontrol viewer library is used to display minicontrol which is created by the minicontrol provider. \n + * This library provides functions to attach a minicontrol viewer to a parent evas object and sending some requests to a minicontrol provider. \n + * The minicontrol viewer places a space which will be used by the minicontrol provider to draw minicontrol. */ /** @@ -43,7 +43,7 @@ extern "C" { * @since_tizen 2.4 * @param[in] parent Minicontrol object will be added to this parent evas object * @param[in] minicontrol_name Name of minicontrol - * @return Evas object of minicontrol. @c NULL failed to add, get_last_result() will returns reason of failure. + * @return Evas object of minicontrol. @c NULL failed to add, get_last_result() will return reason of failure */ Evas_Object *minicontrol_viewer_add(Evas_Object *parent, const char *minicontrol_name); @@ -54,14 +54,14 @@ Evas_Object *minicontrol_viewer_add(Evas_Object *parent, const char *minicontrol * @param[in] event Type of the event * @param[in] event_arg A bundle of arguments * @return #MINICONTROL_ERROR_NONE on success, - * otherwise an error code on failure - * @retval #MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument + * otherwise an error code on failure + * @retval #MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument * @see #minicontrol_viewer_event_e */ int minicontrol_viewer_send_event(const char *minicontrol_name, minicontrol_viewer_event_e event, bundle *event_arg); /** - * @brief Called when a event comes from the provider + * @brief Called when a event comes from the provider. * @since_tizen 2.4 * @param[in] event The type of fired event * @param[in] minicontrol_name The name of the minicontrol window @@ -78,9 +78,9 @@ typedef void (*minicontrol_viewer_event_cb)(minicontrol_event_e event, const cha * @param[in] user_data User data * @return #MINICONTROL_ERROR_NONE on success, * otherwise an error code on failure - * @retval #MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument + * @retval #MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument * @retval #MINICONTROL_ERROR_IPC_FAILURE IPC failure - * @retval #MINICONTROL_ERROR_OUT_OF_MEMORY out of memory + * @retval #MINICONTROL_ERROR_OUT_OF_MEMORY Out of memory * @see #minicontrol_viewer_unset_event_cb * @see #minicontrol_viewer_event_cb */ @@ -89,7 +89,8 @@ int minicontrol_viewer_set_event_cb(minicontrol_viewer_event_cb callback, void * /** * @brief Unregisters a callback for events originated by minicontrol provider. * @since_tizen 2.4 - * @return #MINICONTROL_ERROR_NONE if success, other value if failure + * @return #MINICONTROL_ERROR_NONE if success, + * other value if failure * @see #minicontrol_viewer_set_event_cb */ int minicontrol_viewer_unset_event_cb(void); @@ -102,4 +103,3 @@ int minicontrol_viewer_unset_event_cb(void); } #endif #endif /* _MINICTRL_VIEWER_H_ */ - |