enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

Fix typos in documentation #7 

Signed-off-by: Sanjeev BA <iamsanjeev@gmail.com>

SVN revision: 67910
This commit is contained in:
Sanjeev BA 2012-02-14 08:50:40 +00:00
parent b1e6437cf5
commit 55bc1bd62d
7 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
legacy/elementary/src/lib/elm_index.h
View File

@ -64,7 +64,7 @@ EAPI Evas_Object *elm_index_add(Evas_Object *parent);
/**
* Set whether a given index widget is or not visible,
* programatically.
* programmatically.
*
* @param obj The index object
* @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it

4
legacy/elementary/src/lib/elm_intro.h
View File

@ -16,7 +16,7 @@
*
* @section organization Organization
*
* One can divide Elemementary into three main groups:
* One can divide Elementary into three main groups:
* @li @ref infralist - These are modules that deal with Elementary as a whole.
* @li @ref widgetslist - These are the widgets you'll compose your UI out of.
* @li @ref containerslist - These are the containers which hold the widgets.
@ -30,5 +30,5 @@
* There is a lot that goes into making a widget set, and they don't happen out of
* nothing. It's like trying to make everyone everywhere happy, regardless of age,
* gender, race or nationality - and that is really tough. So thanks to people and
* organisations behind this, as listed in the @ref authors page.
* organizations behind this, as listed in the @ref authors page.
*/

4
legacy/elementary/src/lib/elm_label.h
View File

@ -12,7 +12,7 @@
* @li default - No animation
* @li marker - Centers the text in the label and make it bold by default
* @li slide_long - The entire text appears from the right of the screen and
* slides until it disappears in the left of the screen(reappering on the
* slides until it disappears in the left of the screen(reappearing on the
* right again).
* @li slide_short - The text appears in the left of the label and slides to
* the right to show the overflow. When all of the text has been shown the
@ -165,7 +165,7 @@ EAPI void elm_label_background_color_set(Evas_Object *obj
* will be shown at the end of the widget.
*
* @warning This doesn't work with slide(elm_label_slide_set()) or if the
* choosen wrap method was ELM_WRAP_WORD.
* chosen wrap method was ELM_WRAP_WORD.
*/
EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis);

10
legacy/elementary/src/lib/elm_layout.h
View File

@ -72,7 +72,7 @@
* sent to the Layout theme (with elm_object_signal_emit()) and the theme
* handled the signal by changing the box padding, or align, or both. Using
* the Elementary @ref Box widget is not necessarily harder or easier, it
* just depends on the circunstances and requirements.
* just depends on the circumstances and requirements.
*
* The Layout Box can be used through the @c elm_layout_box_* set of
* functions.
@ -181,7 +181,7 @@ EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const ch
* Set the edje group from the elementary theme that will be used as layout
*
* @param obj The layout object
* @param clas the clas of the group
* @param clas the class of the group
* @param group the group
* @param style the style to used
*
@ -586,7 +586,7 @@ EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const E
/**
* @def elm_layout_icon_get
* Convienience macro to get the icon object from a layout that follows the
* Convenience macro to get the icon object from a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
@ -596,7 +596,7 @@ EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const E
/**
* @def elm_layout_end_set
* Convienience macro to set the end object in a layout that follows the
* Convenience macro to set the end object in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
@ -612,7 +612,7 @@ EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const E
/**
* @def elm_layout_end_get
* Convienience macro to get the end object in a layout that follows the
* Convenience macro to get the end object in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout

22
legacy/elementary/src/lib/elm_list.h
View File

@ -70,7 +70,7 @@
*
* @note Default value is #ELM_LIST_SCROLL.
*
* Values <b> don't </b> work as bitmask, only one can be choosen.
* Values <b> don't </b> work as bitmask, only one can be chosen.
*
* @see elm_list_mode_set()
* @see elm_list_mode_get()
@ -81,7 +81,7 @@ typedef enum
{
ELM_LIST_COMPRESS = 0, /**< Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. */
ELM_LIST_SCROLL, /**< Default value. Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction (large items will get cropped). */
ELM_LIST_LIMIT, /**< Set a minimun size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
ELM_LIST_LIMIT, /**< Set a minimum size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like the previous mode, will set a minimum size on the longitudinal axis too, trying to reserve space to all its children to be visible at a time. Can have effects bounded by setting the list object's maximum size hints. */
ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
} Elm_List_Mode;
@ -235,7 +235,7 @@ EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj
* this function (if multi-select is enabled it will unselect the item).
*
* If always select is enabled, it will call the callback function
* everytime a item is pressed, so it will call when the item is selected,
* every time a item is pressed, so it will call when the item is selected,
* and again when a selected item is pressed.
*
* @see elm_list_always_select_mode_get()
@ -351,7 +351,7 @@ EAPI void elm_list_scroller_policy_get(const Evas_Object
* Associated @p data can be properly freed when item is deleted if a
* callback function is set with elm_widget_item_del_cb_set().
*
* If a function is passed as argument, it will be called everytime this item
* If a function is passed as argument, it will be called every time this item
* is selected, i.e., the user clicks over an unselected item.
* If always select is enabled it will call this function every time
* user clicks over an item (already selected or not).
@ -402,7 +402,7 @@ EAPI Elm_Object_Item *elm_list_item_append(Evas_Object *obj, const
* Associated @p data can be properly freed when item is deleted if a
* callback function is set with elm_widget_item_del_cb_set().
*
* If a function is passed as argument, it will be called everytime this item
* If a function is passed as argument, it will be called every time this item
* is selected, i.e., the user clicks over an unselected item.
* If always select is enabled it will call this function every time
* user clicks over an item (already selected or not).
@ -444,7 +444,7 @@ EAPI Elm_Object_Item *elm_list_item_prepend(Evas_Object *obj, cons
* Associated @p data can be properly freed when item is deleted if a
* callback function is set with elm_widget_item_del_cb_set().
*
* If a function is passed as argument, it will be called everytime this item
* If a function is passed as argument, it will be called every time this item
* is selected, i.e., the user clicks over an unselected item.
* If always select is enabled it will call this function every time
* user clicks over an item (already selected or not).
@ -486,7 +486,7 @@ EAPI Elm_Object_Item *elm_list_item_insert_before(Evas_Object *obj
* Associated @p data can be properly freed when item is deleted if a
* callback function is set with elm_widget_item_del_cb_set().
*
* If a function is passed as argument, it will be called everytime this item
* If a function is passed as argument, it will be called every time this item
* is selected, i.e., the user clicks over an unselected item.
* If always select is enabled it will call this function every time
* user clicks over an item (already selected or not).
@ -536,7 +536,7 @@ EAPI Elm_Object_Item *elm_list_item_insert_after(Evas_Object *obj,
* Associated @p data can be properly freed when item is deleted if a
* callback function is set with elm_widget_item_del_cb_set().
*
* If a function is passed as argument, it will be called everytime this item
* If a function is passed as argument, it will be called every time this item
* is selected, i.e., the user clicks over an unselected item.
* If always select is enabled it will call this function every time
* user clicks over an item (already selected or not).
@ -624,9 +624,9 @@ EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object
* This sets the selected state of the given item @p it.
* @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
*
* If a new item is selected the previosly selected will be unselected,
* If a new item is selected the previously selected will be unselected,
* unless multiple selection is enabled with elm_list_multi_select_set().
* Previoulsy selected item can be get with function
* Previously selected item can be get with function
* elm_list_selected_item_get().
*
* Selected items will be highlighted.
@ -690,7 +690,7 @@ EAPI Eina_Bool elm_list_item_separator_get(const Elm_Object_I
* @param it The list item to be shown.
*
* It won't animate list until item is visible. If such behavior is wanted,
* use elm_list_bring_in() intead.
* use elm_list_bring_in() instead.
*
* @ingroup List
*/

26
legacy/elementary/src/lib/elm_map.h
View File

@ -69,7 +69,7 @@
*
* Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
*
* Values <b> don't </b> work as bitmask, only one can be choosen.
* Values <b> don't </b> work as bitmask, only one can be chosen.
*
* @note Valid sizes are 2^zoom, consequently the map may be smaller
* than the scroller view.
@ -126,7 +126,7 @@ typedef enum
} Elm_Map_Route_Type;
/**
* Set the routing method, what should be priorized, time or distance.
* Set the routing method, what should be prioritized, time or distance.
*
* @see elm_map_route_add()
*
@ -134,8 +134,8 @@ typedef enum
*/
typedef enum
{
ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should prioritize time. */
ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should prioritized distance. */
ELM_MAP_ROUTE_METHOD_LAST
} Elm_Map_Route_Method;
@ -309,7 +309,7 @@ EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double
* @param lat Latitude to center at.
*
* This causes map to @b redraw its viewport's contents to the
* region contining the given @p lat and @p lon, that will be moved to the
* region containing the given @p lat and @p lon, that will be moved to the
* center of the map.
*
* @see elm_map_geo_region_bring_in() for a function to move with animation.
@ -500,7 +500,7 @@ EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Obje
* @param obj The map object.
* @param x horizontal coordinate of the point to convert.
* @param y vertical coordinate of the point to convert.
* @param lon A poniter to the longitude.
* @param lon A pointer to the longitude.
* @param lat A pointer to the latitude.
*
* This gets longitude and latitude from canvas x, y coordinates. The canvas
@ -521,8 +521,8 @@ EAPI void elm_map_canvas_to_geo_convert(const Evas_Object *obj,
* @param obj The map object.
* @param lon The longitude of the marker.
* @param lat The latitude of the marker.
* @param clas The class, to use when marker @b isn't grouped to others.
* @param clas_group The class group, to use when marker is grouped to others
* @param class The class, to use when marker @b isn't grouped to others.
* @param class_group The class group, to use when marker is grouped to others
* @param data The data passed to the callbacks.
*
* @return The created marker or @c NULL upon failure.
@ -630,7 +630,7 @@ EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker);
* @param marker The marker to center at.
*
* This causes map to @b redraw its viewport's contents to the
* region contining the given @p marker's coordinates, that will be
* region containing the given @p marker's coordinates, that will be
* moved to the center of the map.
*
* @see elm_map_marker_bring_in() for a function to move with animation.
@ -663,7 +663,7 @@ EAPI void elm_map_markers_list_show(Eina_List *markers);
/**
* Get the Evas object returned by the ElmMapMarkerGetFunc callback
*
* @param marker The marker wich content should be returned.
* @param marker The marker which content should be returned.
* @return Return the evas object if it exists, else @c NULL.
*
* To set callback function #ElmMapMarkerGetFunc for the marker class,
@ -759,7 +759,7 @@ EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj);
/**
* Set the marker's style of a group class.
*
* @param clas The group class.
* @param class The group class.
* @param style The style to be used by markers.
*
* Each marker must be associated to a group class, and will use the style
@ -780,7 +780,7 @@ EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *cl
/**
* Set the icon callback function of a group class.
*
* @param clas The group class.
* @param class The group class.
* @param icon_get The callback function that will return the icon.
*
* Each marker must be associated to a group class, and it can display a
@ -796,7 +796,7 @@ EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *
/**
* Set the data associated to the group class.
*
* @param clas The group class.
* @param class The group class.
* @param data The new user data.
*
* This data will be passed for callback functions, like icon get callback,

4
legacy/elementary/src/lib/elm_mapbuf.h
View File

@ -8,7 +8,7 @@
* This holds one content object and uses an Evas Map of transformation
* points to be later used with this content. So the content will be
* moved, resized, etc as a single image. So it will improve performance
* when you have a complex interafce, with a lot of elements, and will
* when you have a complex interface, with a lot of elements, and will
* need to resize or move it frequently (the content object and its
* children).
*
@ -56,7 +56,7 @@ EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent);
*
* Also, when enabled, alpha and smooth states will be used, so if the
* content isn't solid, alpha should be enabled, for example, otherwise
* a black retangle will fill the content.
* a black rectangle will fill the content.
*
* When disabled, the stored map will be freed and geometry prior to
* enabling the map will be restored.