seoz pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=2a57c8cae227c544d8a0c36e209d57703205137e
commit 2a57c8cae227c544d8a0c36e209d57703205137e Author: Daniel Juyung Seo <seojuyu...@gmail.com> Date: Wed Nov 19 19:51:57 2014 +0900 elm: Modify document for APIs. Retrieve -> Get as the API says. This is not a critical change but was done due to the consistency. --- src/lib/elm_app.h | 14 +++++++------- src/lib/elm_box.eo | 2 +- src/lib/elm_clock.eo | 4 ++-- src/lib/elm_cnp.h | 2 +- src/lib/elm_entry.eo | 8 ++++---- src/lib/elm_gengrid_common.h | 2 +- src/lib/elm_genlist_common.h | 2 +- src/lib/elm_panes.eo | 4 ++-- src/lib/elm_prefs.eo | 12 ++++++------ src/lib/elm_prefs_data.h | 4 ++-- src/lib/elm_prefs_legacy.h | 2 +- src/lib/elm_progressbar.eo | 4 ++-- src/lib/elm_removed.h | 14 +++++++------- src/lib/elm_scroller_legacy.h | 2 +- src/lib/elm_slider.eo | 2 +- src/lib/elm_slideshow.eo | 4 ++-- src/lib/elm_systray.eo | 16 ++++++++-------- src/lib/elm_tooltip.h | 2 +- src/lib/elm_widget.c | 2 +- src/lib/elm_widget_item.eo | 2 +- src/lib/elm_win.eo | 2 +- 21 files changed, 53 insertions(+), 53 deletions(-) diff --git a/src/lib/elm_app.h b/src/lib/elm_app.h index df2a37c..76c663b 100644 --- a/src/lib/elm_app.h +++ b/src/lib/elm_app.h @@ -186,7 +186,7 @@ EAPI void elm_app_compile_data_dir_set(const char *dir); EAPI void elm_app_compile_locale_set(const char *dir); /** - * Retrieve the application formal name, as set by elm_app_name_set(). + * Get the application formal name, as set by elm_app_name_set(). * * @return The application formal name. * @@ -196,7 +196,7 @@ EAPI void elm_app_compile_locale_set(const char *dir); EAPI const char *elm_app_name_get(void); /** - * Retrieve the path to the '.desktop' file, as set by + * Get the path to the '.desktop' file, as set by * elm_app_desktop_entry_set(). * * @return The '.desktop' file path. @@ -207,7 +207,7 @@ EAPI const char *elm_app_name_get(void); EAPI const char *elm_app_desktop_entry_get(void); /** - * Retrieve the application's run time prefix directory, as set by + * Get the application's run time prefix directory, as set by * elm_app_info_set() and the way (environment) the application was * run from. * @@ -218,7 +218,7 @@ EAPI const char *elm_app_desktop_entry_get(void); EAPI const char *elm_app_prefix_dir_get(void); /** - * Retrieve the application's run time binaries prefix directory, as + * Get the application's run time binaries prefix directory, as * set by elm_app_info_set() and the way (environment) the application * was run from. * @@ -230,7 +230,7 @@ EAPI const char *elm_app_prefix_dir_get(void); EAPI const char *elm_app_bin_dir_get(void); /** - * Retrieve the application's run time libraries prefix directory, as + * Get the application's run time libraries prefix directory, as * set by elm_app_info_set() and the way (environment) the application * was run from. * @@ -242,7 +242,7 @@ EAPI const char *elm_app_bin_dir_get(void); EAPI const char *elm_app_lib_dir_get(void); /** - * Retrieve the application's run time data prefix directory, as + * Get the application's run time data prefix directory, as * set by elm_app_info_set() and the way (environment) the application * was run from. * @@ -254,7 +254,7 @@ EAPI const char *elm_app_lib_dir_get(void); EAPI const char *elm_app_data_dir_get(void); /** - * Retrieve the application's run time locale prefix directory, as + * Get the application's run time locale prefix directory, as * set by elm_app_info_set() and the way (environment) the application * was run from. * diff --git a/src/lib/elm_box.eo b/src/lib/elm_box.eo index 3c08969..97537b2 100644 --- a/src/lib/elm_box.eo +++ b/src/lib/elm_box.eo @@ -141,7 +141,7 @@ class Elm_Box (Elm_Widget) children { get { /*@ - Retrieve a list of the objects packed into the box + Get a list of the objects packed into the box Returns a new @c list with a pointer to @c Evas_Object in its nodes. The order of the list corresponds to the packing order the box uses. diff --git a/src/lib/elm_clock.eo b/src/lib/elm_clock.eo index 25d991d..422969b 100644 --- a/src/lib/elm_clock.eo +++ b/src/lib/elm_clock.eo @@ -128,7 +128,7 @@ class Elm_Clock (Elm_Layout) } get { /*@ - Retrieve whether a given clock widget is under editing mode + Get whether a given clock widget is under editing mode or under (default) displaying-only mode. @return @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE otherwise @@ -224,7 +224,7 @@ class Elm_Clock (Elm_Layout) } get { /*@ - Retrieve what digits of the given clock widget should be + Get what digits of the given clock widget should be editable when in edition mode. @return Bit mask indicating the digits to be editable diff --git a/src/lib/elm_cnp.h b/src/lib/elm_cnp.h index a4d1ed6..dceab77 100644 --- a/src/lib/elm_cnp.h +++ b/src/lib/elm_cnp.h @@ -219,7 +219,7 @@ EAPI Eina_Bool elm_cnp_selection_set(Evas_Object *obj, Elm_Sel_Type selection, const void *buf, size_t buflen); /** - * @brief Retrieve data from a widget that has a selection. + * @brief Get data from a widget that has a selection. * * Get the current selection data from a widget. * The widget input here will usually be elm_entry, diff --git a/src/lib/elm_entry.eo b/src/lib/elm_entry.eo index c28e955..1f7c145 100644 --- a/src/lib/elm_entry.eo +++ b/src/lib/elm_entry.eo @@ -168,7 +168,7 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface, } get { /*@ - Retrieve the autocapitalization type on the immodule. + Get the autocapitalization type on the immodule. @return autocapitalization type @@ -488,7 +488,7 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface, } get { /*@ - Retrieve the attribute to show the input panel automatically. + Get the attribute to show the input panel automatically. @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise @@ -539,7 +539,7 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface, } get { /*@ - Retrieves the current position of the cursor in the entry + Get the current position of the cursor in the entry @return The cursor position @@ -914,7 +914,7 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface, } text_style_user_peek @const { /*@ - Retrieve the style on the top of user style stack. + Get the style on the top of user style stack. @return style on the top of user style stack if exist, otherwise NULL. diff --git a/src/lib/elm_gengrid_common.h b/src/lib/elm_gengrid_common.h index eba0791..b5aa1f9 100644 --- a/src/lib/elm_gengrid_common.h +++ b/src/lib/elm_gengrid_common.h @@ -216,7 +216,7 @@ EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_ EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable); /** - * @brief Retrieve size restriction state of an object's tooltip + * @brief Get size restriction state of an object's tooltip * @param it The tooltip's anchor object * @return If @c EINA_TRUE, size restrictions are disabled * diff --git a/src/lib/elm_genlist_common.h b/src/lib/elm_genlist_common.h index f8ad74a..f2ed511 100644 --- a/src/lib/elm_genlist_common.h +++ b/src/lib/elm_genlist_common.h @@ -245,7 +245,7 @@ EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_ EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable); /** - * @brief Retrieve size restriction state of an object's tooltip + * @brief Get size restriction state of an object's tooltip * @param it The tooltip's anchor object * @return If @c EINA_TRUE, size restrictions are disabled * diff --git a/src/lib/elm_panes.eo b/src/lib/elm_panes.eo index 4cff973..5fad9b5 100644 --- a/src/lib/elm_panes.eo +++ b/src/lib/elm_panes.eo @@ -57,7 +57,7 @@ class Elm_Panes (Elm_Layout) } get { /*@ - Retrieve the split direction of a given panes widget. + Get the split direction of a given panes widget. @return @c EINA_TRUE, if @p obj is set to be @b horizontal, @c EINA_FALSE if it's @b vertical (and on errors). @@ -87,7 +87,7 @@ class Elm_Panes (Elm_Layout) } get { /*@ - Retrieve the resize mode for the panes of a given panes widget. + Get the resize mode for the panes of a given panes widget. @return @c EINA_TRUE, if @p obj is set to be resizable by user interaction. diff --git a/src/lib/elm_prefs.eo b/src/lib/elm_prefs.eo index a111ef8..0218482 100644 --- a/src/lib/elm_prefs.eo +++ b/src/lib/elm_prefs.eo @@ -38,7 +38,7 @@ class Elm_Prefs (Elm_Widget, Efl.File) } get { /*@ - Retrieve user data for a given prefs widget + Get user data for a given prefs widget @return A pointer to the user data of a given prefs widget on success. @c NULL otherwise. @@ -129,7 +129,7 @@ class Elm_Prefs (Elm_Widget, Efl.File) } item_value_get @const { /*@ - Retrieve the value of a given prefs widget's item. + Get the value of a given prefs widget's item. @return @c EINA_TRUE, on success, @c EINA_FALSE otherwise @@ -149,7 +149,7 @@ class Elm_Prefs (Elm_Widget, Efl.File) } item_object_get { /*@ - Retrieve the Elementary widget bound to a given prefs widget's + Get the Elementary widget bound to a given prefs widget's item. @return A valid widget handle, on success, or @c NULL, otherwise @@ -188,7 +188,7 @@ class Elm_Prefs (Elm_Widget, Efl.File) } item_disabled_get @const { /*@ - Retrieve whether the widget bound to a given prefs widget's item is + Get whether the widget bound to a given prefs widget's item is disabled or not. @return @c EINA_TRUE, if it is disabled, @c EINA_FALSE @@ -242,7 +242,7 @@ class Elm_Prefs (Elm_Widget, Efl.File) } item_editable_get @const { /*@ - Retrieve whether the widget bound to a given prefs widget's item is + Get whether the widget bound to a given prefs widget's item is editable or not. @return @c EINA_TRUE, if it is editable, @c EINA_FALSE @@ -295,7 +295,7 @@ class Elm_Prefs (Elm_Widget, Efl.File) } item_visible_get @const { /*@ - Retrieve whether the widget bound to a given prefs widget's item is + Get whether the widget bound to a given prefs widget's item is visible or not. @return @c EINA_TRUE, if it is visible, @c EINA_FALSE diff --git a/src/lib/elm_prefs_data.h b/src/lib/elm_prefs_data.h index e2890c6..e37d8e6 100644 --- a/src/lib/elm_prefs_data.h +++ b/src/lib/elm_prefs_data.h @@ -137,7 +137,7 @@ EAPI Eina_Bool elm_prefs_data_version_set(Elm_Prefs_Data *prefs_data, unsigned int version); /** - * Retrieve the version field of a given prefs data handle. + * Get the version field of a given prefs data handle. * * @param prefs_data A valid prefs data handle * @return The version of @a prefs_data or -1, on errors. @@ -201,7 +201,7 @@ EAPI Eina_Bool elm_prefs_data_value_set(Elm_Prefs_Data *prefs_data, const Eina_Value *value); /** - * Retrieve one value of a given prefs data handle (by key). + * Get one value of a given prefs data handle (by key). * * @param prefs_data A valid prefs data handle * @param path The (unique) name (key) of the given value diff --git a/src/lib/elm_prefs_legacy.h b/src/lib/elm_prefs_legacy.h index c4c1677..5c9dd91 100644 --- a/src/lib/elm_prefs_legacy.h +++ b/src/lib/elm_prefs_legacy.h @@ -42,7 +42,7 @@ EAPI Eina_Bool elm_prefs_file_set(Eo *obj, const char *file, const char *page); /** * - * Retrieve file and page bound to a given prefs widget. + * Get file and page bound to a given prefs widget. * * @return @c EINA_TRUE, on success, @c EINA_FALSE otherwise * diff --git a/src/lib/elm_progressbar.eo b/src/lib/elm_progressbar.eo index 8af02cc..c95e664 100644 --- a/src/lib/elm_progressbar.eo +++ b/src/lib/elm_progressbar.eo @@ -151,7 +151,7 @@ class Elm_Progressbar (Elm_Layout) } get { /*@ - Retrieve the orientation of a given progress bar widget + Get the orientation of a given progress bar widget @return @c EINA_TRUE, if @p obj is set to be @b horizontal, @c EINA_FALSE if it's @b vertical (and on errors) @@ -188,7 +188,7 @@ class Elm_Progressbar (Elm_Layout) } get { /*@ - Retrieve the format string set for a given progress bar widget's + Get the format string set for a given progress bar widget's units label @return The format set string for @p obj's units label or diff --git a/src/lib/elm_removed.h b/src/lib/elm_removed.h index f1232ae..8bff73d 100644 --- a/src/lib/elm_removed.h +++ b/src/lib/elm_removed.h @@ -510,7 +510,7 @@ EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, cons /** * Get the markup text set for the anchorblock * - * Retrieves the text set on the anchorblock, with markup tags included. + * Gets the text set on the anchorblock, with markup tags included. * * @param obj The anchorblock object * @return The markup text set or @c NULL if nothing was set or an error @@ -540,7 +540,7 @@ EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const /** * Get the markup text set for the anchorview * - * Retrieves the text set on the anchorview, with markup tags included. + * Gets the text set on the anchorview, with markup tags included. * * @param obj The anchorview object * @return The markup text set or @c NULL if nothing was set or an error @@ -2941,7 +2941,7 @@ EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *o EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon); /** - * Retrieve the icon object set for a given progress bar widget + * Get the icon object set for a given progress bar widget * * @param obj The progress bar object * @return The icon object's handle, if @p obj had one set, or @c NULL, @@ -3092,7 +3092,7 @@ EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Obj EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj); /** - * Retrieve the icon object set for a given slider widget. + * Get the icon object set for a given slider widget. * * @param obj The slider object. * @return The icon object's handle, if @p obj had one set, or @c NULL, @@ -3153,7 +3153,7 @@ EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Obje EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj); /** - * Retrieve the end object set for a given slider widget. + * Get the end object set for a given slider widget. * * @param obj The slider object. * @return The end object's handle, if @p obj had one set, or @c NULL, @@ -3752,7 +3752,7 @@ EINA_DEPRECATED EAPI Eina_Bool elm_list_item_disabled_get(con EINA_DEPRECATED EAPI Eina_Bool elm_list_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable); /** - * @brief Retrieve size restriction state of an object's tooltip + * @brief Get size restriction state of an object's tooltip * @param obj The tooltip's anchor object * @return If EINA_TRUE, size restrictions are disabled * @@ -6014,7 +6014,7 @@ EINA_DEPRECATED EAPI double elm_clock_interval_get(const Evas_Object EINA_DEPRECATED EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Edit_Mode digedit); /** - * Retrieve what digits of the given clock widget should be + * Get what digits of the given clock widget should be * editable when in edition mode. * * @param obj The clock object diff --git a/src/lib/elm_scroller_legacy.h b/src/lib/elm_scroller_legacy.h index c9864cf..235a3c1 100644 --- a/src/lib/elm_scroller_legacy.h +++ b/src/lib/elm_scroller_legacy.h @@ -258,7 +258,7 @@ EAPI void elm_scroller_page_relative_get(const Evas_Obj EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize); /** - * @brief Retrieve a scroller widget's current page size. + * @brief Get a scroller widget's current page size. * * @param obj The scroller object * @param h_pagesize Where to store its horizontal page size diff --git a/src/lib/elm_slider.eo b/src/lib/elm_slider.eo index 173f988..b23f5db 100644 --- a/src/lib/elm_slider.eo +++ b/src/lib/elm_slider.eo @@ -19,7 +19,7 @@ class Elm_Slider (Elm_Layout, Elm_Interface_Atspi_Value, } get { /*@ - Retrieve the orientation of a given slider widget + Get the orientation of a given slider widget @return @c EINA_TRUE, if @p obj is set to be @b horizontal, @c EINA_FALSE if it's @b vertical (and on errors). diff --git a/src/lib/elm_slideshow.eo b/src/lib/elm_slideshow.eo index 4ae792f..cf63c07 100644 --- a/src/lib/elm_slideshow.eo +++ b/src/lib/elm_slideshow.eo @@ -17,7 +17,7 @@ class Elm_Slideshow (Elm_Layout, Elm_Interface_Atspi_Widget_Action) } get { /*@ - Retrieve the number of items to cache, on a given slideshow widget, + Get the number of items to cache, on a given slideshow widget, <b>after the current item</b> @return The number of items set to be cached after the current one @@ -45,7 +45,7 @@ class Elm_Slideshow (Elm_Layout, Elm_Interface_Atspi_Widget_Action) } get { /*@ - Retrieve the number of items to cache, on a given slideshow widget, + Get the number of items to cache, on a given slideshow widget, <b>before the current item</b> @return The number of items set to be cached before the current one diff --git a/src/lib/elm_systray.eo b/src/lib/elm_systray.eo index 1a5b0da..154bb34 100644 --- a/src/lib/elm_systray.eo +++ b/src/lib/elm_systray.eo @@ -8,7 +8,7 @@ class Elm_Systray (Eo.Base) /*@ Set the id of the Status Notifier Item. */ } get { - /*@ Retrieve the id of the Status Notifier Item. */ + /*@ Get the id of the Status Notifier Item. */ } values { const(char)* id; @@ -19,7 +19,7 @@ class Elm_Systray (Eo.Base) /*@ Set the category of the Status Notifier Item. */ } get { - /*@ Retrieve the category of the Status Notifier Item. */ + /*@ Get the category of the Status Notifier Item. */ } values { Elm_Systray_Category cat; /*@ Category */ @@ -30,7 +30,7 @@ class Elm_Systray (Eo.Base) /*@ Set the path to the theme where the icons can be found. Set this value to "" to use the default path. */ } get { - /*@ Retrieve the path to the icon's theme currently in use. */ + /*@ Get the path to the icon's theme currently in use. */ } values { const(char)* icon_theme_path; @@ -41,7 +41,7 @@ class Elm_Systray (Eo.Base) /*@ Set the object path of the D-Bus Menu that is to be show when the Status Notifier Item is activated by the user. */ } get { - /*@ Retrieve the object path of the D-Bus Menu currently in use. */ + /*@ Get the object path of the D-Bus Menu currently in use. */ } values { const(Eo)* menu; @@ -52,7 +52,7 @@ class Elm_Systray (Eo.Base) /*@ Set the name of the attention icon to be used by the Status Notifier Item. */ } get { - /*@ Retrieve the name of the attention icon used by the Status Notifier Item. */ + /*@ Get the name of the attention icon used by the Status Notifier Item. */ } values { const(char)* att_icon_name; @@ -63,7 +63,7 @@ class Elm_Systray (Eo.Base) /*@ Set the status of the Status Notifier Item. */ } get { - /*@ Retrieve the status of the Status Notifier Item. */ + /*@ Get the status of the Status Notifier Item. */ } values { Elm_Systray_Status st; /*@ Status */ @@ -74,7 +74,7 @@ class Elm_Systray (Eo.Base) /*@ Set the name of the icon to be used by the Status Notifier Item. */ } get { - /*@ Retrieve the name of the icon used by the Status Notifier Item. */ + /*@ Get the name of the icon used by the Status Notifier Item. */ } values { const(char)* icon_name; @@ -85,7 +85,7 @@ class Elm_Systray (Eo.Base) /*@ Set the title of the Status Notifier Item. */ } get { - /*@ Retrieve the title of the Status Notifier Item. */ + /*@ Get the title of the Status Notifier Item. */ } values { const(char)* title; diff --git a/src/lib/elm_tooltip.h b/src/lib/elm_tooltip.h index ad46a97..2d934d4 100644 --- a/src/lib/elm_tooltip.h +++ b/src/lib/elm_tooltip.h @@ -231,7 +231,7 @@ EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable); /** - * @brief Retrieve size restriction state of an object's tooltip + * @brief Get size restriction state of an object's tooltip * * @param obj The tooltip's anchor object * @return If @c EINA_TRUE, size restrictions are disabled diff --git a/src/lib/elm_widget.c b/src/lib/elm_widget.c index 6d862b4..e5dbdb3 100644 --- a/src/lib/elm_widget.c +++ b/src/lib/elm_widget.c @@ -4277,7 +4277,7 @@ _elm_widget_item_del_cb_set(Eo *eo_item EINA_UNUSED, /** * @internal * - * Retrieves owner widget of this item. + * Get owner widget of this item. * * @param item a valid #Elm_Widget_Item to get data from. * @return owner widget of this item. diff --git a/src/lib/elm_widget_item.eo b/src/lib/elm_widget_item.eo index 1c6de72..2c080fa 100644 --- a/src/lib/elm_widget_item.eo +++ b/src/lib/elm_widget_item.eo @@ -6,7 +6,7 @@ class Elm_Widget_Item(Eo.Base) tooltip_window_mode { get { /** - @brief Retrieve size restriction state of an object's tooltip + @brief Get size restriction state of an object's tooltip This function returns whether a tooltip is allowed to expand beyond its parent window's canvas. diff --git a/src/lib/elm_win.eo b/src/lib/elm_win.eo index ff71cd1..f613434 100644 --- a/src/lib/elm_win.eo +++ b/src/lib/elm_win.eo @@ -342,7 +342,7 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window, } get { /*@ - Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen + Get the constraints on the maximum width and height of a window relative to the width and height of its screen When this function returns true, @p obj will never resize larger than the screen. @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction --