From 39a1e98bf65bdb5f58421a5aecdc9396118745b5 Mon Sep 17 00:00:00 2001 From: Vivek Ellur Date: Tue, 14 Jul 2015 14:44:02 +0100 Subject: [PATCH] elm_app_client: convert eo docs to new format Summary: Converted docs of elm_app_client.eo and elm_app_client_view.eo to new format Signed-off-by: Vivek Ellur Reviewers: cedric, q66 Reviewed By: q66 Differential Revision: https://phab.enlightenment.org/D2814 --- src/lib/elm_app_client.eo | 30 ++++++++++---------- src/lib/elm_app_client_view.eo | 64 ++++++++++++++++++++++-------------------- 2 files changed, 49 insertions(+), 45 deletions(-) diff --git a/src/lib/elm_app_client.eo b/src/lib/elm_app_client.eo index b4cfa51..d58ec3a 100644 --- a/src/lib/elm_app_client.eo +++ b/src/lib/elm_app_client.eo @@ -5,46 +5,46 @@ class Elm_App_Client (Eo.Base) methods { @property views { get { - /*@ Return a iterator with all views of application. */ + [[Return a iterator with all views of application.]] } values { - ret: free(own(iterator *), eina_iterator_free); /*@ The iterator with all views, must be freed after use */ + ret: free(own(iterator *), eina_iterator_free); [[The iterator with all views, must be freed after use.]] } } @property package { get { - /*@ Return the application package. */ + [[Return the application package.]] } values { - ret: const(char)*; /*@ application package */ + ret: const(char)*; [[application package]] } } constructor { - /*@ Class constructor of elm_app_client. */ + [[Class constructor of elm_app_client.]] legacy: null; params { - @in package: const(char)*; /*@ Package of application */ + @in package: const(char)*; [[Package of application]] } } view_all_close { - /*@ Close all views of application. */ + [[Close all views of application.]] } terminate { - /*@ Terminate application. */ + [[Terminate application.]] } view_open { - /*@ Open an application view. */ + [[Open an application view.]] params { - @in args: Eina_Value * @optional; /*@ an array of */ - @in view_open_cb: Elm_App_Client_Open_View_Cb @optional; /*@ callback to be called when view open */ - @in data: const(void)* @optional; /*@ calback user data */ + @in args: Eina_Value * @optional; [[an array of.]] + @in view_open_cb: Elm_App_Client_Open_View_Cb @optional; [[callback to be called when view open]] + @in data: const(void)* @optional; [[callback user data]] } - return: Elm_App_Client_Pending *; /*@ handler to cancel the view opening if it takes to long */ + return: Elm_App_Client_Pending *; [[handler to cancel the view opening if it takes to long ]] } view_open_cancel { - /*@ Cancel a pending elm_app_client_view_open(). */ + [[Cancel a pending elm_app_client_view_open().]] params { - @in pending: Elm_App_Client_Pending *; /*@ the view open handler */ + @in pending: Elm_App_Client_Pending *; [[the view open handler]] } } } diff --git a/src/lib/elm_app_client_view.eo b/src/lib/elm_app_client_view.eo index 8534a3f..3a2e4e5 100644 --- a/src/lib/elm_app_client_view.eo +++ b/src/lib/elm_app_client_view.eo @@ -5,37 +5,39 @@ class Elm_App_Client_View (Eo.Base) methods { @property state { get { - /*@ Get state of view */ + [[Get state of view]] } values { - state: Elm_App_View_State; /*@ state of view */ + state: Elm_App_View_State; [[state of view]] } } @property new_events { get { - /*@ Get new events of view */ + [[Get new events of view]] } values { - events: int; /*@ number of events of view */ + events: int; [[number of events of view]] } } @property window { get { - /*@ Get window of view */ + [[Get window of view]] } values { - window: int; /*@ window of view */ + window: int; [[window of view]] } } @property icon_pixels { get { - /*@ Get icon pixels of view, view could have a icon in raw format not saved in disk. */ + [[Get icon pixels of view, view could have a icon + in raw format not saved in disk. + ]] } values { - w: uint; /*@ icon width */ - h: uint; /*@ icon height */ - has_alpha: bool; /*@ if icon have alpha channel */ - pixels: const(ubyte)*; /*@ uchar array, with all bytes of icon */ + w: uint; [[icon width]] + h: uint; [[icon height]] + has_alpha: bool; [[if icon have alpha channel]] + pixels: const(ubyte)*; [[uchar array, with all bytes of icon]] } } path_set { @@ -45,63 +47,65 @@ class Elm_App_Client_View (Eo.Base) } @property path { get { - /*@ Get DBus path of view */ + [[Get DBus path of view]] } values { - ret: Eina_Stringshare *; /*@ DBus path of view */ + ret: Eina_Stringshare *; [[DBus path of view]] } } @property package { get { - /*@ Get application package */ + [[Get application package]] } values { - ret: const(char)*; /*@ Package of application */ + ret: const(char)*; [[Package of application]] } } @property icon { get { - /*@ Get icon path of view */ + [[Get icon path of view]] } values { - ret: const(char)*; /*@ icon path of view */ + ret: const(char)*; [[icon path of view]] } } @property progress { get { - /*@ Get progress of view, should be -1 if there nothing in progress or something between 0-100 */ + [[Get progress of view, should be -1 if there nothing in progress + or something between 0-100 + ]] } values { - progress: ushort; /*@ progress of view */ + progress: ushort; [[progress of view]] } } @property title { get { - /*@ Get title of view */ + [[Get title of view]] } values { - ret: const(char)*; /*@ title of view */ + ret: const(char)*; [[title of view]] } } pause { - /*@ Pause view */ + [[Pause view]] params { - @in cb: Elm_App_Client_View_Cb @optional; /*@ callback to be called when view was paused */ - @in data: const(void)* @optional; /*@ callback user data */ + @in cb: Elm_App_Client_View_Cb @optional; [[callback to be called when view was paused ]] + @in data: const(void)* @optional; [[callback user data]] } } resume { - /*@ Resume view */ + [[Resume view]] params { - @in cb: Elm_App_Client_View_Cb @optional; /*@ callback to be called when view was resumed */ - @in data: const(void)* @optional; /*@ callback user data */ + @in cb: Elm_App_Client_View_Cb @optional; [[callback to be called when view was resumed]] + @in data: const(void)* @optional; [[callback user data]] } } close { - /*@ Close view */ + [[Close view]] params { - @in cb: Elm_App_Client_View_Cb @optional; /*@ callback to be called when view was closed */ - @in data: const(void)* @optional; /*@ callback user data */ + @in cb: Elm_App_Client_View_Cb @optional; [[callback to be called when view was closed]] + @in data: const(void)* @optional; [[callback user data]] } } } -- 2.7.4