@author Mathieu Taillefumier <mathieu.taillefumier@@free.fr>
@author Iván Briano <ivan@@profusion.mobi>
@author Gustavo Lima Chaves <glima@@profusion.mobi>
-@author Samsung Electronics <tbd>
-@author Samsung SAIT <tbd>
+@author Samsung Electronics
+@author Samsung SAIT
@author Sung W. Park <sungwoo@@gmail.com>
@author Jiyoun Park <jy0703.park@@samsung.com>
@author Myoungwoon Roy Kim(roy_kim) <myoungwoon.kim@@samsung.com> <myoungwoon@@gmail.com>
* evas_render_updates_free().
*
* This function forces an immediate renderization update of the given
- * canvas @e.
+ * canvas @p e.
*
* @note This is a <b>very low level function</b>, which most of
* Evas' users wouldn't care about. One would use it, for example, to
* @see evas_object_unref()
* @see evas_object_del()
*
- * @note This is a <b>very simple<b> reference counting mechanism! For
+ * @note This is a <b>very simple</b> reference counting mechanism! For
* instance, Evas is not ready to check for pending references on a
* canvas deletion, or things like that. This is useful on scenarios
* where, inside a code block, callbacks exist which would possibly
* evas_object_show() and evas_object_hide().
*
* @note The value returned isn't, by any means, influenced by
- * clippers covering @obj, it being out of its canvas' viewport or
+ * clippers covering @p obj, it being out of its canvas' viewport or
* stacked below other object.
*
* @see evas_object_show()
* @image rtf evas-callbacks.png
* @image latex evas-callbacks.eps
*
- * Thees events have their values in the #Evas_Callback_Type
- * enumeration, which has also ones happening on the canvas level (se
- * #Evas_Canvas_Events).
+ * These events have their values in the #Evas_Callback_Type
+ * enumeration, which has also ones happening on the canvas level (see
+ * #Evas_Canvas_Events ).
*
* Examples on this group of functions can be found @ref
* Example_Evas_Stacking "here" and @ref Example_Evas_Events "here".
* Determine whether an object is set to repeat events.
*
* @param obj the given Evas object pointer
- * @retrieve whether @p obj is set to repeat events (@c EINA_TRUE)
+ * @return whether @p obj is set to repeat events (@c EINA_TRUE)
* or not (@c EINA_FALSE)
*
* @see evas_object_repeat_events_set() for an example
* Set whether an Evas object is to freeze (discard) events.
*
* @param obj the Evas object to operate on
- * @param pass whether @p obj is to freeze events (@c EINA_TRUE) or not
+ * @param freeze pass whether @p obj is to freeze events (@c EINA_TRUE) or not
* (@c EINA_FALSE)
*
* If @p freeze is @c EINA_TRUE, it will make events on @p obj to be @b
* Sets whether or not the given Evas object is to be drawn anti-aliased.
*
* @param obj The given Evas object.
- * @param anti_alias 1 if the object is to be anti_aliased, 0 otherwise.
+ * @param antialias 1 if the object is to be anti_aliased, 0 otherwise.
* @ingroup Evas_Object_Group_Extras
*/
EAPI void evas_object_anti_alias_set (Evas_Object *obj, Eina_Bool antialias) EINA_ARG_NONNULL(1);
/**
* Sets the render_op to be used for rendering the Evas object.
* @param obj The given Evas object.
- * @param render_op one of the Evas_Render_Op values.
+ * @param op one of the Evas_Render_Op values.
* @ingroup Evas_Object_Group_Extras
*/
EAPI void evas_object_render_op_set (Evas_Object *obj, Evas_Render_Op op) EINA_ARG_NONNULL(1);
* Get the "static clipper" hint flag for a given Evas object.
*
* @param obj The given object.
- * @returrn @c EINA_TRUE if it's set as a static clipper, @c
+ * @return @c EINA_TRUE if it's set as a static clipper, @c
* EINA_FALSE otherwise
*
* @see evas_object_static_clip_set() for more details
EAPI Eina_List *evas_objects_in_rectangle_get (const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
- * Get the lowest (stacked) Evas object on the canvas @p
+ * Get the lowest (stacked) Evas object on the canvas @p e.
*
* @param e a valid canvas pointer
* @return a pointer to the lowest object on it, if any, or @c NULL,
EAPI Evas_Object *evas_object_bottom_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
- * Get the highest (stacked) Evas object on the canvas @p
+ * Get the highest (stacked) Evas object on the canvas @p e.
*
* @param e a valid canvas pointer
* @return a pointer to the highest object on it, if any, or @c NULL,
* object.
*
* @param obj The text object to set font for.
- * @param font The font file's path.
+ * @return The font file's path.
*
* @see evas_object_text_font_get() for more details
*/
* Visible: formats that a cursor can point to, i.e formats that
* occupy space, for example: newlines, tabs, items and etc. Some visible items
* are made of two parts, in this case, only the opening tag is visible.
- * A closing tag (i.e a </tag> tag) should NEVER be visible.
+ * A closing tag (i.e a \</tag\> tag) should NEVER be visible.
* Invisible: formats that don't occupy space, for example: bold and underline.
* Being able to access format nodes is very important for some uses. For
* example, edje uses the "<a>" format to create links in the text (and pop
/**
* Return the markup version of the plain text.
*
- * Replaces \n -> <br/> \t -> <tab/> and etc. Generally needed before you pass
+ * Replaces \\n -\> \<br/\> \\t -\> \<tab/\> and etc. Generally needed before you pass
* plain text to be set in a textblock.
*
* @param obj the textblock object to work with (if NULL, it just does the
EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_node_format_prev_get(const Evas_Object_Textblock_Node_Format *n) EINA_ARG_NONNULL(1);
/**
- * Remove a format node and it's match. i.e, removes a <tag> </tag> pair.
- * Assumes the node is the first part of <tag> i.e, this won't work if
+ * Remove a format node and it's match. i.e, removes a \<tag\> \</tag\> pair.
+ * Assumes the node is the first part of \<tag\> i.e, this won't work if
* n is a closing tag.
*
* @param obj the Evas object of the textblock - not null.
/**
* Get the text format representation of the format node.
*
- * @param fmt the format node.
+ * @param fnode the format node.
* @return the textual format of the format node.
*/
EAPI const char *evas_textblock_node_format_text_get(const Evas_Object_Textblock_Node_Format *fnode) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
* the start of the text just added.
*
* @param cur the cursor to where to add text at.
- * @param _text the text to add.
+ * @param text the text to add.
* @return Returns the len of the text added.
* @see evas_textblock_cursor_text_prepend()
*/
* the start of the text just added.
*
* @param cur the cursor to where to add text at.
- * @param _text the text to add.
+ * @param text the text to add.
* @return Returns the len of the text added.
* @see evas_textblock_cursor_text_append()
*/
*
*
* @param obj the Evas object.
- * @param w[out] the width of the object.
- * @param h[out] the height of the object
+ * @param w the width of the object.
+ * @param h the height of the object
* @return Returns no value.
* @see evas_object_textblock_size_native_get
*/
* and a formatted size of 5x4.
*
* @param obj the Evas object of the textblock
- * @param w[out] the width returned
- * @param h[out] the height returned
+ * @param w the width returned
+ * @param h the height returned
* @return Returns no value.
*/
EAPI void evas_object_textblock_size_native_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
* the user, after inheriting everything from the parent, which
* should <b>take care of setting the right member functions for
* the class</b>, both overrides and extensions, if any.
- * - If this new class should be subclassable as well, a @b public @c
- * _smart_set() function is desirable to fill in the class used as
+ * - If this new class should be subclassable as well, a @b public
+ * @c _smart_set() function is desirable to fill in the class used as
* parent by the children. It's up to the user to provide this
* interface, which will most likely call @<prefix@>_smart_set() to
* get the job done.
* \par Child element's properties:
* @c padding_l and @c padding_r sum up to the required width of the
* child element. The @c align_x property tells the relative position
- * of this overall child width in its allocated cell (@r 0.0 to
+ * of this overall child width in its allocated cell (@c 0.0 to
* extreme left, @c 1.0 to extreme right). A value of @c -1.0 to
* @c align_x makes the box try to resize this child element to the exact
* width of its cell (respecting the minimum and maximum size hints on
* @note This call will trigger the box's
* _Evas_Object_Box_Api::insert_after smart function.
*/
-EAPI Evas_Object_Box_Option *evas_object_box_insert_after (Evas_Object *o, Evas_Object *child, const Evas_Object *referente) EINA_ARG_NONNULL(1, 2, 3);
+EAPI Evas_Object_Box_Option *evas_object_box_insert_after (Evas_Object *o, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1, 2, 3);
/**
* Insert a new @a child object <b>at a given position</b>, in a given
* @param o The box parenting the child element
* @param opt The box option structure bound to the child box element
* to get a property from
- * @param id The numerical ID of the given property
+ * @param property The numerical ID of the given property
* @param ... (List of) pointer(s) where to store the value(s) set for
* this property. It (they) @b must point to variable(s) of the same
* type the user has defined for it (them).
/**
* Removes the @p keyname key from the current list of modifier keys
- * on canvas @e.
+ * on canvas @p e.
*
* @param e The pointer to the Evas canvas
* @param keyname The name of the key to remove from the modifiers list.
/**
* Removes the @p keyname key from the current list of lock keys on
- * canvas @e.
+ * canvas @p e.
*
* @param e The pointer to the Evas canvas
* @param keyname The name of the key to remove from the locks list.
projects / profile / ivi / evas.git / blobdiff