Fix some typos and documentation.
authorsanjeev <sanjeev@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Mon, 5 Mar 2012 01:57:17 +0000 (01:57 +0000)
committersanjeev <sanjeev@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Mon, 5 Mar 2012 01:57:17 +0000 (01:57 +0000)
Signed-off-by: Sanjeev BA <eflelev8@gmail.com>
git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@68667 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

src/lib/elc_anchorview.h
src/lib/elc_multibuttonentry.h
src/lib/elm_cnp.h
src/lib/elm_focus.h
src/lib/elm_gengrid.h
src/lib/elm_genlist.h
src/lib/elm_object_item.h
src/lib/elm_tooltip.h
src/lib/elm_video.h

index 5e426f3..4a4516b 100644 (file)
@@ -80,7 +80,7 @@ struct _Elm_Entry_Anchorview_Info
 };
 
 /**
- * Add a new Anchorview object
+ * Add a new Anchorview object to the parent.
  *
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
@@ -113,7 +113,7 @@ EAPI Evas_Object                *elm_anchorview_hover_parent_get(const Evas_Obje
 /**
  * Set the style that the hover should use
  *
- * When creating the popup hover, anchorview will request that it's
+ * When creating the popup hover, anchorview will request that it is
  * themed according to @p style.
  *
  * @param obj The anchorview object
@@ -124,7 +124,7 @@ EAPI Evas_Object                *elm_anchorview_hover_parent_get(const Evas_Obje
 EAPI void                        elm_anchorview_hover_style_set(Evas_Object *obj, const char *style);
 
 /**
- * Get the style that the hover should use
+ * Get the style that the hover uses.
  *
  * Get the style the hover created by anchorview will use.
  *
@@ -161,9 +161,9 @@ EAPI void                        elm_anchorview_hover_end(Evas_Object *obj);
 EAPI void                        elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
 
 /**
- * Get the set bouncing behaviour of the internal scroller
+ * Get the bouncing behaviour of the internal scroller
  *
- * Get whether the internal scroller should bounce when the edge of each
+ * Get whether the internal scroller will bounce when the edge of each
  * axis is reached scrolling.
  *
  * @param obj The anchorview object
index 798ffc5..2abcc1d 100644 (file)
@@ -128,7 +128,7 @@ EAPI Elm_Object_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const
  *
  * @ingroup Multibuttonentry
  */
-// XXX: use support selected callback like other item_append apis.
+// XXX: use support selected callback like other item_append APIs.
 // EAPI Elm_Object_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data);
 EAPI Elm_Object_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data);
 
index 3c469e6..4428c97 100644 (file)
@@ -15,7 +15,7 @@
  * but some terms and behavior are common.
  * Currently the X11 window system is widely used, and only X11 functionality is implemented.
  *
- * In X11R6 window sytem, CopyPaste works like a peer-to-peer communication.
+ * In X11R6 window system, CopyPaste works like a peer-to-peer communication.
  * Copying is an operation on an object in an X server.
  * X11 calls those objects 'selections' which have names.
  * Generally, two selection types are needed for copy and paste:
index 6dfb45c..8457773 100644 (file)
@@ -120,7 +120,7 @@ EAPI Eina_Bool            elm_object_focus_get(const Evas_Object *obj);
 EAPI void                 elm_object_focus_set(Evas_Object *obj, Eina_Bool focus);
 
 /**
- * Set the ability for an Elmentary object to be focused
+ * Set the ability for an Elementary object to be focused
  *
  * @param obj The Elementary object to operate on
  * @param enable @c EINA_TRUE if the object can be focused, @c
index e9223f4..bb454f9 100644 (file)
@@ -835,7 +835,7 @@ EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Obj
 //XXX: Let's add
 //EAPI int                           elm_gengrid_item_index_get(const Elm_Object_Item *it);
 //EAPI void                          elm_gengrid_realized_items_update(Evas_Object *obj);
-//EAPI unsigned iint elm_gengrid_items_count(const Evas_Object *obj);
+//EAPI unsigned int elm_gengrid_items_count(const Evas_Object *obj);
 
 #define ELM_GENGRID_ITEM_CLASS_VERSION 2 /* current version number */
 
@@ -846,7 +846,7 @@ EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Obj
  *
  * This adds gengrid item class for the gengrid widget. When adding a item,
  * gengrid_item_{append, prepend, insert} function needs item class of the item.
- * Given callback paramters are used at retrieving {text, content} of
+ * Given callback parameters are used at retrieving {text, content} of
  * added item. Set as NULL if it's not used.
  * If there's no available memory, return can be NULL.
  *
index 4f6fb87..c400615 100644 (file)
@@ -1131,7 +1131,7 @@ EAPI unsigned int elm_genlist_items_count(const Evas_Object *obj);
  *
  * This adds genlist item class for the genlist widget. When adding a item,
  * genlist_item_{append, prepend, insert} function needs item class of the item.
- * Given callback paramters are used at retrieving {text, content} of
+ * Given callback parameters are used at retrieving {text, content} of
  * added item. Set as NULL if it's not used.
  * If there's no available memory, return can be NULL.
  *
@@ -1514,7 +1514,7 @@ EAPI void                          elm_genlist_height_for_width_mode_set(Evas_Ob
  *
  * @ingroup Genlist
  */
-//XXX: API name is ambigious elm_genlist_mode_fixed_width_get() ?????
+//XXX: API name is ambiguous elm_genlist_mode_fixed_width_get() ?????
 EAPI Eina_Bool                     elm_genlist_height_for_width_mode_get(const Evas_Object *obj);
 
 /**
index 994c46a..4fa1327 100644 (file)
@@ -457,7 +457,7 @@ EAPI Eina_Bool                    elm_object_item_cursor_engine_only_get(const E
  *
  * @ingroup General
  */
-//Dont use this APIs
+//Don't use this APIs
 //EAPI void                         elm_object_item_smart_callback_add(Elm_Object_Item *it, const char *event, Elm_Object_Item_Smart_Cb func, const void *data);
 
 /**
@@ -480,5 +480,5 @@ EAPI Eina_Bool                    elm_object_item_cursor_engine_only_get(const E
  *
  * @ingroup General
  */
-//Dont use this APIs
+//Don't use this APIs
 //EAPI void                        *elm_object_item_smart_callback_del(Elm_Object_Item *it, const char *event, Elm_Object_Item_Smart_Cb func);
index d1fd024..3e7a0b1 100644 (file)
@@ -71,7 +71,7 @@ EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj);
  * @param disable If EINA_TRUE, size restrictions are disabled
  * @return EINA_FALSE on failure, EINA_TRUE on success
  *
- * This function allows a tooltip to expand beyond its parant window's canvas.
+ * This function allows a tooltip to expand beyond its parent window's canvas.
  * It will instead be limited only by the size of the display.
  */
 EAPI Eina_Bool   elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable);
@@ -82,7 +82,7 @@ EAPI Eina_Bool   elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool
  * @return If EINA_TRUE, size restrictions are disabled
  *
  * This function returns whether a tooltip is allowed to expand beyond
- * its parant window's canvas.
+ * its parent window's canvas.
  * It will instead be limited only by the size of the display.
  */
 EAPI Eina_Bool   elm_object_tooltip_window_mode_get(const Evas_Object *obj);
index e548597..5b29b24 100644 (file)
@@ -196,7 +196,7 @@ EAPI void                 elm_video_audio_level_set(Evas_Object *video, double v
  * Elm_Video object.
  *
  * @param video The video object.
- * @return the time(in seconds) since the beginnig of the media file.
+ * @return the time(in seconds) since the beginning of the media file.
  *
  * @ingroup Video
  */
@@ -207,7 +207,7 @@ EAPI double               elm_video_play_position_get(const Evas_Object *video);
  * Elm_Video object.
  *
  * @param video The video object.
- * @param position the time(in seconds) since the beginnig of the media file.
+ * @param position the time(in seconds) since the beginning of the media file.
  *
  * @ingroup Video
  */
@@ -248,7 +248,7 @@ EAPI void                 elm_video_remember_position_set(Evas_Object *video, Ei
 EAPI Eina_Bool            elm_video_remember_position_get(const Evas_Object *video);
 
 /**
- * @brief Get the title (for ex. dvd title) from this emotion object.
+ * @brief Get the title (for ex. DVD title) from this emotion object.
  *
  * @param video The Elm_Video object.
  * @return A string containing the title.