diff options
author | Yakov Goldberg <yakov.g@samsung.com> | 2014-02-18 18:06:20 +0200 |
---|---|---|
committer | Yakov Goldberg <yakov.g@samsung.com> | 2014-02-18 18:12:40 +0200 |
commit | 48542ba5856a76d174e1227f169c84cf25504d29 (patch) | |
tree | 89970db9fbea8461c520a2a1edf6a9e7f5ba6aae | |
parent | 2031cfc49d4e19b5d1fe79fbf9181b0c6b04ede3 (diff) | |
download | elementary-48542ba5856a76d174e1227f169c84cf25504d29.tar.gz |
app, atspi: add comments for Eo API
Add minimum comments for Eo API to make Eolian correctly
process methods and parameter directions
There are still exist not/half implemented functions, for which
I didn't add comments.
-rw-r--r-- | src/lib/elm_app_server_eo.h | 24 | ||||
-rw-r--r-- | src/lib/elm_app_server_view_eo.h | 92 |
2 files changed, 116 insertions, 0 deletions
diff --git a/src/lib/elm_app_server_eo.h b/src/lib/elm_app_server_eo.h index f4db07bcf..c6186cd0d 100644 --- a/src/lib/elm_app_server_eo.h +++ b/src/lib/elm_app_server_eo.h @@ -84,16 +84,40 @@ typedef Elm_App_Server_View *(*Elm_App_Server_Create_View_Cb)(Elm_App_Server *ap */ #define elm_app_server_title_get(ret) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_TITLE_GET), EO_TYPECHECK(Eina_Stringshare **, ret) +/** + * @def elm_app_server_icon_set + * @since 1.8 + * + * @param[in] icon title of icon + */ #define elm_app_server_icon_set(icon) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_ICON_SET), EO_TYPECHECK(const char*, icon) +/** + * @def elm_app_server_icon_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_icon_get(ret) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_ICON_GET), EO_TYPECHECK(Eina_Stringshare **, ret) #define elm_app_server_icon_pixels_set(w, h, has_alpha, pixels) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_ICON_PIXELS_SET), EO_TYPECHECK(unsigned int, w), EO_TYPECHECK(unsigned int, h), EO_TYPECHECK(Eina_Bool, has_alpha), EO_TYPECHECK(const unsigned char *, pixels) #define elm_app_server_icon_pixels_get(w, h, has_alpha, pixels) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_ICON_PIXELS_GET), EO_TYPECHECK(unsigned int *, w), EO_TYPECHECK(unsigned int *, h), EO_TYPECHECK(Eina_Bool *, has_alpha), EO_TYPECHECK(const unsigned char **, pixels) +/** + * @def elm_app_server_package_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_package_get(ret) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_PACKAGE_GET), EO_TYPECHECK(Eina_Stringshare **, ret) +/** + * @def elm_app_server_path_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_path_get(ret) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_PATH_GET), EO_TYPECHECK(const char **, ret) /** diff --git a/src/lib/elm_app_server_view_eo.h b/src/lib/elm_app_server_view_eo.h index 990d840ae..3b448cb40 100644 --- a/src/lib/elm_app_server_view_eo.h +++ b/src/lib/elm_app_server_view_eo.h @@ -42,40 +42,132 @@ enum */ #define elm_app_server_view_constructor(id) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(const char *, id) +/** + * @def elm_app_server_view_resume + * @since 1.8 + * + */ #define elm_app_server_view_resume() ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_RESUME) +/** + * @def elm_app_server_view_pause + * @since 1.8 + * + */ #define elm_app_server_view_pause() ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_PAUSE) +/** + * @def elm_app_server_view_close + * @since 1.8 + * + */ #define elm_app_server_view_close() ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_CLOSE) +/** + * @def elm_app_server_view_shallow + * @since 1.8 + * + */ #define elm_app_server_view_shallow() ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_SHALLOW) +/** + * @def elm_app_server_view_state_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_view_state_get(ret) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_STATE_GET), EO_TYPECHECK(Elm_App_View_State *, ret) +/** + * @def elm_app_server_view_window_set + * @since 1.8 + * + * @param[in] win + */ #define elm_app_server_view_window_set(win) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_WINDOW_SET), EO_TYPECHECK(Evas_Object *, win) +/** + * @def elm_app_server_view_title_set + * @since 1.8 + * + * @param[in] title + */ #define elm_app_server_view_title_set(title) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_TITLE_SET), EO_TYPECHECK(const char *, title) +/** + * @def elm_app_server_view_title_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_view_title_get(ret) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_TITLE_GET), EO_TYPECHECK(const char **, ret) +/** + * @def elm_app_server_view_icon_set + * @since 1.8 + * + * @param[in] icon + */ #define elm_app_server_view_icon_set(icon) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_ICON_NAME_SET), EO_TYPECHECK(const char *, icon) +/** + * @def elm_app_server_view_icon_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_view_icon_get(ret) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_ICON_NAME_GET), EO_TYPECHECK(const char **, ret) #define elm_app_server_view_icon_pixels_set(w, h, has_alpha, pixels) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_ICON_PIXELS_SET), EO_TYPECHECK(unsigned int, w), EO_TYPE_CHECK(unsigned int, h), EO_TYPE_CHECK(Eina_Bool, has_alpha), EO_TYPE_CHECK(const unsigned char *, pixels) #define elm_app_server_view_icon_pixels_get(w, h, has_alpha, pixels) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_ICON_PIXELS_GET), EO_TYPECHECK(unsigned int *, w), EO_TYPE_CHECK(unsigned int *, h), EO_TYPE_CHECK(Eina_Bool *, has_alpha), EO_TYPE_CHECK(const unsigned char **, pixels) +/** + * @def elm_app_server_view_progress_set + * @since 1.8 + * + * @param[in] progress + */ #define elm_app_server_view_progress_set(progress) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_PROGRESS_SET), EO_TYPECHECK(short, progress) +/** + * @def elm_app_server_view_progress_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_view_progress_get(ret) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_PROGRESS_GET), EO_TYPECHECK(short *, ret) +/** + * @def elm_app_server_view_new_events_set + * @since 1.8 + * + * @param[in] events + */ #define elm_app_server_view_new_events_set(events) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_NEW_EVENTS_SET), EO_TYPECHECK(int, events) +/** + * @def elm_app_server_view_new_events_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_view_new_events_get(ret) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_NEW_EVENTS_GET), EO_TYPECHECK(int *, ret) +/** + * @def elm_app_server_view_id_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_view_id_get(ret) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_ID_GET), EO_TYPECHECK(Eina_Stringshare **, ret) +/** + * @def elm_app_server_view_path_get + * @since 1.8 + * + * @param[out] ret + */ #define elm_app_server_view_path_get(ret) ELM_APP_SERVER_VIEW_ID(ELM_APP_SERVER_VIEW_SUB_ID_PATH_GET), EO_TYPECHECK(const char **, ret) /** |