diff --git a/legacy/elementary/src/lib/elm_flip.eo b/legacy/elementary/src/lib/elm_flip.eo index 7e908afdf4..46818079d5 100644 --- a/legacy/elementary/src/lib/elm_flip.eo +++ b/legacy/elementary/src/lib/elm_flip.eo @@ -1,8 +1,6 @@ enum Elm.Flip.Mode { - /*@ - @ingroup Flip - */ + [[]] legacy: elm_flip; rotate_y_center_axis, rotate_x_center_axis, @@ -20,9 +18,7 @@ enum Elm.Flip.Mode enum Elm.Flip.Interaction { - /*@ - @ingroup Flip - */ + [[]] none, rotate, cube, @@ -31,13 +27,10 @@ enum Elm.Flip.Interaction enum Elm.Flip.Direction { - /*@ - @ingroup Flip - */ - up = 0, /*@< Allows interaction with the top of the widget */ - down, /*@< Allows interaction with the bottom of the widget */ - left, /*@< Allows interaction with the left portion of the widget */ - right /*@< Allows interaction with the right portion of the widget */ + up = 0, [[Allows interaction with the top of the widget]] + down, [[Allows interaction with the bottom of the widget]] + left, [[Allows interaction with the left portion of the widget]] + right [[Allows interaction with the right portion of the widget]] } class Elm.Flip (Elm.Container) diff --git a/legacy/elementary/src/lib/elm_general.eot b/legacy/elementary/src/lib/elm_general.eot index aa84a665c3..b492041b9e 100644 --- a/legacy/elementary/src/lib/elm_general.eot +++ b/legacy/elementary/src/lib/elm_general.eot @@ -1,85 +1,89 @@ struct Elm.Event.Policy_Changed { - /*@ - @struct _Elm_Event_Policy_Changed - - Data on the event when an Elementary policy has changed - */ - policy: uint; /*@< the policy identifier */ - new_value: int; /*@< value the policy had before the change */ - old_value: int; /*@< new value the policy got */ + [[Data on the event when an Elementary policy has changed]] + policy: uint; [[the policy identifier]] + new_value: int; [[value the policy had before the change]] + old_value: int; [[new value the policy got]] } enum Elm.Policy { - /*@ - Policy identifiers. - */ - quit, /*@< under which circumstances the application should quit automatically. @see Elm_Policy_Quit. */ - exit, /*@< defines elm_exit() behaviour. @see Elm_Policy_Exit. + [[Policy identifiers.]] + quit, [[under which circumstances the application should quit automatically. + See also @Elm_Policy_Quit.]] + exit, [[defines elm_exit() behaviour. See also @Elm_Policy_Exit. + @since 1.8 - */ - throttle, /*@< defines how throttling should work @see Elm_Policy_Throttle + ]] + throttle, [[defines how throttling should work. See also @Elm_Policy_Throttle + @since 1.8 - */ + ]] last } enum Elm.Policy.Quit { - /*@ - Possible values for the #ELM_POLICY_QUIT policy - */ - none = 0, /*@< never quit the application - automatically */ - last_window_closed /*@< quit when the - application's last - window is closed */ + [[Possible values for the #ELM_POLICY_QUIT policy]] + none = 0, [[never quit the application automatically]] + last_window_closed [[quit when the application's last window is closed]] } enum Elm.Policy.Exit { - /*@ - Possible values for the #ELM_POLICY_EXIT policy. + [[Possible values for the #ELM_POLICY_EXIT policy. + @since 1.8 - */ - none = 0, /*@< just quit the main loop on elm_exit() */ - windows_del /*@< delete all the windows after quitting - the main loop */ + ]] + none = 0, [[just quit the main loop on elm_exit()]] + windows_del [[delete all the windows after quitting the main loop]] } enum Elm.Policy.Throttle { - /*@ - Possible values for the #ELM_POLICY_THROTTLE policy. + [[Possible values for the #ELM_POLICY_THROTTLE policy. + @since 1.8 - */ - config = 0, /*@< do whatever elementary config is configured to do */ - hidden_always, /*@< always throttle when all windows are no longer visible */ - never /*@< never throttle when windows are all hidden, regardless of config settings */ + ]] + config = 0, [[do whatever elementary config is configured to do]] + hidden_always, [[always throttle when all windows are no longer visible]] + never [[never throttle when windows are all hidden, regardless of config + settings]] } enum Elm.Object.Select_Mode { - /*@ - Possible values for the #ELM_OBJECT_SELECT_MODE policy. + [[Possible values for the #ELM_OBJECT_SELECT_MODE policy. + @since 1.7 - */ - default = 0, /*@< default select mode. Once an item is selected, it would stay highlighted and not going to call selected callback again even it was clicked. Items can get focus. */ - always, /*@< always select mode. Item selected callbacks will be called every time for click events, even after the item was already selected. Items can get focus. */ - none, /*@< no select mode. Items will never be highlighted and selected but the size will be adjusted by the finger size configuration. Items can't get focus. */ - display_only, /*@< no select mode with no finger size rule. Items will never be highlighted and selected and ignore the finger size. So the item size can be reduced below than the finger size configuration. Items can't get focus. */ - max /*@< canary value: any value greater or equal to ELM_OBJECT_SELECT_MODE_MAX is forbidden. */ + ]] + default = 0, [[default select mode. Once an item is selected, it would stay + highlighted and not going to call selected callback again + even it was clicked. Items can get focus.]] + always, [[always select mode. Item selected callbacks will be called every + time for click events, even after the item was already selected. + Items can get focus.]] + none, [[no select mode. Items will never be highlighted and selected but + the size will be adjusted by the finger size configuration. Items + can't get focus.]] + display_only, [[no select mode with no finger size rule. Items will never + be highlighted and selected and ignore the finger size. So + the item size can be reduced below than the finger size + configuration. Items can't get focus.]] + max [[canary value: any value greater or equal to ELM_OBJECT_SELECT_MODE_MAX + is forbidden.]] } enum Elm.Object.Multi_Select_Mode { - /*@ - Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy. + [[Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy. + @since 1.8 - */ - default = 0, /*@< default multiple select mode */ - with_control, /*@< disallow mutiple selection when clicked without control key pressed */ - max /*@< canary value: any value greater or equal to ELM_OBJECT_MULTI_SELECT_MODE_MAX is forbidden. */ + ]] + default = 0, [[default multiple select mode]] + with_control, [[disallow mutiple selection when clicked without control key + pressed]] + max [[canary value: any value greater or equal to + ELM_OBJECT_MULTI_SELECT_MODE_MAX is forbidden.]] } diff --git a/legacy/elementary/src/lib/elm_panel.eo b/legacy/elementary/src/lib/elm_panel.eo index d178f00fa0..c4970e2efd 100644 --- a/legacy/elementary/src/lib/elm_panel.eo +++ b/legacy/elementary/src/lib/elm_panel.eo @@ -1,14 +1,11 @@ enum Elm.Panel.Orient { - /*@ - Panel orientation mode + [[Panel orientation mode]] - @ingroup Panel */ - - top, /*@< Panel (dis)appears from the top */ - bottom, /*@< Panel (dis)appears from the bottom */ - left, /*@< Panel (dis)appears from the left */ - right /*@< Panel (dis)appears from the right */ + top, [[Panel (dis)appears from the top]] + bottom, [[Panel (dis)appears from the bottom]] + left, [[Panel (dis)appears from the left]] + right [[Panel (dis)appears from the right]] } class Elm.Panel (Elm.Layout, Elm_Interface_Scrollable, diff --git a/legacy/elementary/src/lib/elm_scroller.eo b/legacy/elementary/src/lib/elm_scroller.eo index 1c29a6fccc..d4441deb57 100644 --- a/legacy/elementary/src/lib/elm_scroller.eo +++ b/legacy/elementary/src/lib/elm_scroller.eo @@ -1,45 +1,39 @@ enum Elm.Scroller.Policy { - /*@ - @brief Type that controls when scrollbars should appear. - @see elm_scroller_policy_set() + [[Type that controls when scrollbars should appear. - @ingroup Scroller - */ - auto = 0, /*@< Show scrollbars as needed */ - on, /*@< Always show scrollbars */ - off, /*@< Never show scrollbars */ + See also @elm_scroller_policy_set. + ]] + auto = 0, [[Show scrollbars as needed]] + on, [[Always show scrollbars]] + off, [[Never show scrollbars]] last } enum Elm.Scroller.Single_Direction { - /*@ - @brief Type that controls how the content is scrolled. + [[Type that controls how the content is scrolled. - @see elm_scroller_single_direction_set() - @ingroup Scroller - */ - none = 0, /*@< Scroll every direction */ - soft, /*@< Scroll single direction if the direction is certain*/ - hard, /*@< Scroll only single direction */ + See also @elm_scroller_single_direction_set. + ]] + none = 0, [[Scroll every direction]] + soft, [[Scroll single direction if the direction is certain]] + hard, [[Scroll only single direction]] last } enum Elm.Scroller.Movement_Block { - /*@ - @brief Type that blocks the scroll movement in one or more direction. + [[Type that blocks the scroll movement in one or more direction. - @see elm_scroller_movement_block() + See also @elm_scroller_movement_block. - @since 1.8 - @ingroup Scroller - */ - legacy: elm_scroller_movement; - no_block = 1 << 0, /*@< Do not block movements */ - block_vertical = 1 << 1, /*@< Block vertical movements */ - block_horizontal = 1 << 2 /*@< Block horizontal movements */ + @since 1.8 + ]] + legacy: elm_scroller_movement; + no_block = 1 << 0, [[Do not block movements]] + block_vertical = 1 << 1, [[Block vertical movements]] + block_horizontal = 1 << 2 [[Block horizontal movements]] } class Elm.Scroller (Elm.Layout, Elm_Interface_Scrollable, diff --git a/legacy/elementary/src/lib/elm_toolbar.eo b/legacy/elementary/src/lib/elm_toolbar.eo index a6d643115d..3735f2eddd 100644 --- a/legacy/elementary/src/lib/elm_toolbar.eo +++ b/legacy/elementary/src/lib/elm_toolbar.eo @@ -2,29 +2,25 @@ import elm_general; enum Elm.Toolbar.Shrink_Mode { -/*@ - Set toolbar's items display behavior, it can be scrollable, - show a menu with exceeding items, or simply hide them. + [[Set toolbar's items display behavior, it can be scrollable, + show a menu with exceeding items, or simply hide them. - @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value - from elm config. + Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value + from elm config. - Values don't work as bitmask, only one can be chosen. + Values don't work as bitmask, only one can be chosen. - @see elm_toolbar_shrink_mode_set() - @see elm_toolbar_shrink_mode_get() - - @ingroup Toolbar - */ + See also @elm_toobar_shrink_mode_set, @elm_toolbar_shrink_mode_get. + ]] legacy: elm_toolbar_shrink; - none, /*@< Set toolbar minimum size to fit all the items. */ - hide, /*@< Hide exceeding items. */ - scroll, /*@< Allow accessing exceeding items through a scroller. */ - menu, /*@< Inserts a button to pop up a menu with exceeding items. */ - expand, /*@< Expand all items according the size of the toolbar. */ - last /*@< Indicates error if returned by elm_toolbar_shrink_mode_get() */ + none, [[Set toolbar minimum size to fit all the items.]] + hide, [[Hide exceeding items.]] + scroll, [[Allow accessing exceeding items through a scroller.]] + menu, [[Inserts a button to pop up a menu with exceeding items.]] + expand, [[Expand all items according the size of the toolbar.]] + last [[Indicates error if returned by elm_toolbar_shrink_mode_get()]] } class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable, diff --git a/legacy/elementary/src/lib/elm_toolbar_item.eo b/legacy/elementary/src/lib/elm_toolbar_item.eo index ff6712aae9..2fb998bdca 100644 --- a/legacy/elementary/src/lib/elm_toolbar_item.eo +++ b/legacy/elementary/src/lib/elm_toolbar_item.eo @@ -1,17 +1,13 @@ enum Elm.Toolbar_Item.Scrollto_Type { - /*@ - Defines where to position the item in the toolbar. - @ingroup Toolbar - */ - + [[Defines where to position the item in the toolbar.]] legacy: elm_toolbar_item_scrollto; - none = 0, /*@< no scrollto */ - in = (1 << 0), /*@< to the nearest viewport */ - first = (1 << 1), /*@< to the first of viewport */ - middle = (1 << 2), /*@< to the middle of viewport */ - last = (1 << 3) /*@< to the last of viewport */ + none = 0, [[no scrollto]] + in = (1 << 0), [[to the nearest viewport]] + first = (1 << 1), [[to the first of viewport]] + middle = (1 << 2), [[to the middle of viewport]] + last = (1 << 3) [[to the last of viewport]] } class Elm.Toolbar_Item(Elm.Widget_Item) diff --git a/legacy/elementary/src/lib/elm_win.eo b/legacy/elementary/src/lib/elm_win.eo index ed3d0e808d..10b236bd57 100644 --- a/legacy/elementary/src/lib/elm_win.eo +++ b/legacy/elementary/src/lib/elm_win.eo @@ -1,177 +1,157 @@ enum Elm.Win.Type { - /*@ - Defines the types of window that can be created + [[Defines the types of window that can be created - These are hints set on the window so that a running Window Manager knows - how the window should be handled and/or what kind of decorations it - should have. + These are hints set on the window so that a running Window Manager knows + how the window should be handled and/or what kind of decorations it + should have. - Currently, only the X11 backed engines use them. - - @ingroup Win */ + Currently, only the X11 backed engines use them. + ]] legacy: elm_win; unknown = -1, - basic, /*@ A normal window. Indicates a normal, top-level - window. Almost every window will be created with this - type. */ - dialog_basic, /*@ Used for simple dialog windows. */ - desktop, /*@ For special desktop windows, like a background - window holding desktop icons. */ - dock, /*@ The window is used as a dock or panel. Usually would - be kept on top of any other window by the Window - Manager. */ - toolbar, /*@ The window is used to hold a floating toolbar, or - similar. */ - menu, /*@ Similar to #ELM_WIN_TOOLBAR. */ - utility, /*@ A persistent utility window, like a toolbox or - palette. */ - splash, /*@ Splash window for a starting up application. */ - dropdown_menu, /*@ The window is a dropdown menu, as when an - entry in a menubar is clicked. Typically used - with elm_win_override_set(). This hint exists - for completion only, as the EFL way of - implementing a menu would not normally use a - separate window for its contents. */ - popup_menu, /*@ Like #ELM_WIN_DROPDOWN_MENU, but for the menu - triggered by right-clicking an object. */ - tooltip, /*@ The window is a tooltip. A short piece of - explanatory text that typically appear after the - mouse cursor hovers over an object for a while. - Typically used with elm_win_override_set() and also - not very commonly used in the EFL. */ - notification, /*@ A notification window, like a warning about - battery life or a new E-Mail received. */ - combo, /*@ A window holding the contents of a combo box. Not - usually used in the EFL. */ - dnd, /*@ Used to indicate the window is a representation of an - object being dragged across different windows, or even - applications. Typically used with - elm_win_override_set(). */ - inlined_image, /*@ The window is rendered onto an image - buffer. No actual window is created for this - type, instead the window and all of its - contents will be rendered to an image buffer. - This allows to have children window inside a - parent one just like any other object would - be, and do other things like applying @c - Evas_Map effects to it. This is the only type - of window that requires the @c parent - parameter of elm_win_add() to be a valid @c - Evas_Object. */ - socket_image, /*@ The window is rendered onto an image buffer - and can be shown other process's plug image object. - No actual window is created for this type, - instead the window and all of its contents will be - rendered to an image buffer and can be shown - other process's plug image object. */ - fake /*@ This window was created using a pre-existing canvas. - The window widget can be deleted, but the canvas - must be managed externally. - @since 1.13 */ + basic, [[A normal window. Indicates a normal, top-level window. Almost every + window will be created with this type.]] + dialog_basic, [[Used for simple dialog windows.]] + desktop, [[For special desktop windows, like a background window holding + desktop icons.]] + dock, [[The window is used as a dock or panel. Usually would be kept on top + of any other window by the Window Manager.]] + toolbar, [[The window is used to hold a floating toolbar, or similar.]] + menu, [[Similar to #ELM_WIN_TOOLBAR.]] + utility, [[A persistent utility window, like a toolbox or palette.]] + splash, [[Splash window for a starting up application.]] + dropdown_menu, [[The window is a dropdown menu, as when an entry in a + menubar is clicked. Typically used with @elm_win_override_set. + This hint exists for completion only, as the EFL way of + implementing a menu would not normally use a separate + window for its contents.]] + popup_menu, [[Like #ELM_WIN_DROPDOWN_MENU, but for the menu triggered by + right-clicking an object.]] + tooltip, [[The window is a tooltip. A short piece of explanatory text that + typically appear after the mouse cursor hovers over an object + for a while. Typically used with @elm_win_override_set and also + not very commonly used in the EFL.]] + notification, [[A notification window, like a warning about battery life or + a new E-Mail received.]] + combo, [[A window holding the contents of a combo box. Not usually used in + the EFL.]] + dnd, [[Used to indicate the window is a representation of an object being + dragged across different windows, or even applications. Typically + used with elm_win_override_set().]] + inlined_image, [[The window is rendered onto an image buffer. No actual + window is created for this type, instead the window and + all of its contents will be rendered to an image buffer. + This allows to have children window inside a parent one + just like any other object would be, and do other things + like applying @Evas_Map effects to it. This is the only + type of window that requires the parent parameter of + @elm_win_add to be a valid @Evas_Object.]] + socket_image, [[The window is rendered onto an image buffer and can be shown + other process's plug image object. No actual window is + created for this type, instead the window and all of its + contents will be rendered to an image buffer and can be + shown other process's plug image object. + ]] + fake [[This window was created using a pre-existing canvas. The window + widget can be deleted, but the canvas must be managed externally. + + @since 1.13 + ]] } enum Elm.Win.Keyboard_Mode { - /*@ - The different layouts that can be requested for the virtual keyboard. + [[The different layouts that can be requested for the virtual keyboard. - When the application window is being managed by Illume, it may request - any of the following layouts for the virtual keyboard. - - @ingroup Win */ + When the application window is being managed by Illume, it may request + any of the following layouts for the virtual keyboard. + ]] legacy: elm_win_keyboard; - unknown, /*@ Unknown keyboard state */ - off, /*@ Request to deactivate the keyboard */ - on, /*@ Enable keyboard with default layout */ - alpha, /*@ Alpha (a-z) keyboard layout */ - numeric, /*@ Numeric keyboard layout */ - pin, /*@ PIN keyboard layout */ - phone_number, /*@ Phone keyboard layout */ - hex, /*@ Hexadecimal numeric keyboard layout */ - terminal, /*@ Full (QWERTY) keyboard layout */ - password, /*@ Password keyboard layout */ - ip, /*@ IP keyboard layout */ - host, /*@ Host keyboard layout */ - file, /*@ File keyboard layout */ - url, /*@ URL keyboard layout */ - keypad, /*@ Keypad layout */ - j2me /*@ J2ME keyboard layout */ + unknown, [[Unknown keyboard state]] + off, [[Request to deactivate the keyboard]] + on, [[Enable keyboard with default layout]] + alpha, [[Alpha (a-z) keyboard layout]] + numeric, [[Numeric keyboard layout]] + pin, [[PIN keyboard layout]] + phone_number, [[Phone keyboard layout]] + hex, [[Hexadecimal numeric keyboard layout]] + terminal, [[Full (QWERTY) keyboard layout]] + password, [[Password keyboard layout]] + ip, [[IP keyboard layout]] + host, [[Host keyboard layout]] + file, [[File keyboard layout]] + url, [[URL keyboard layout]] + keypad, [[Keypad layout]] + j2me [[J2ME keyboard layout]] } enum Elm.Win.Indicator_Mode { - /*@ - In some environments, like phones, you may have an indicator that - shows battery status, reception, time etc. This is the indicator. + [[In some environments, like phones, you may have an indicator that + shows battery status, reception, time etc. This is the indicator. - Sometimes you don't want it because you provide the same functionality - inside your app, so this will request that the indicator is hidden in - this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default - is to have the indicator shown. - - @ingroup Win */ + Sometimes you don't want it because you provide the same functionality + inside your app, so this will request that the indicator is hidden in + this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default + is to have the indicator shown. + ]] legacy: elm_win_indicator; - unknown, /*@ Unknown indicator state */ - hide, /*@ Hides the indicator */ - show /*@ Shows the indicator */ + unknown, [[Unknown indicator state]] + hide, [[Hides the indicator]] + show [[Shows the indicator]] } enum Elm.Win.Indicator_Opacity_Mode { - /*@ - Defines the opacity modes of indicator that can be shown - - @ingroup Win */ - + [[Defines the opacity modes of indicator that can be shown]] legacy: elm_win_indicator; - opacity_unknown, /*@ Unknown indicator opacity mode */ - opaque, /*@ Opacifies the indicator */ - translucent, /*@ Be translucent the indicator */ - transparent /*@ Transparentizes the indicator */ + opacity_unknown, [[Unknown indicator opacity mode]] + opaque, [[Opacifies the indicator]] + translucent, [[Be translucent the indicator]] + transparent [[Transparentizes the indicator]] } /** */ enum Elm.Win.Keygrab_Mode { - /*@ - Define the keygrab modes of window. - A window may send commands to the Keyrouter according this mode, - and perform different actions. - - @ingroup Win */ - + [[Define the keygrab modes of window. A window may send commands to the + Keyrouter according this mode, and perform different actions.]] legacy: elm_win_keygrab; - unknown = 0, /*@ Unknown keygrab mode */ - shared = (1 << 8), /*@ Getting the grabbed-key together with the other client windows */ - topmost = (1 << 9), /*@ Getting the grabbed-key only when window is top of the stack */ - exclusive = (1 << 10), /*@ Getting the grabbed-key exclusively regardless of window's position */ - override_exclusive = (1 << 11) /*@ Getting the grabbed-key exclusively regardless of window's position. Being overrided the grab by the other client window */ + unknown = 0, [[Unknown keygrab mode]] + shared = (1 << 8), [[Getting the grabbed-key together with the other client + windows]] + topmost = (1 << 9), [[Getting the grabbed-key only when window is top of the + stack]] + exclusive = (1 << 10), [[Getting the grabbed-key exclusively regardless of + window's position]] + override_exclusive = (1 << 11) [[Getting the grabbed-key exclusively + regardless of window's position. Being + overrided the grab by the other client + window]] } enum Elm.Illume_Command { - /*@ - Available commands that can be sent to the Illume manager. + [[Available commands that can be sent to the Illume manager. - When running under an Illume session, a window may send commands to the - Illume manager to perform different actions. + When running under an Illume session, a window may send commands to the + Illume manager to perform different actions. + ]] - @ingroup Win */ - - focus_back, /*@ Reverts focus to the previous window */ - focus_forward, /*@ Sends focus to the next window in the list */ - focus_home, /*@ Hides all windows to show the Home screen */ - close /*@ Closes the currently active window */ + focus_back, [[Reverts focus to the previous window]] + focus_forward, [[Sends focus to the next window in the list]] + focus_home, [[Hides all windows to show the Home screen]] + close [[Closes the currently active window]] } class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,