From 51e5cfe68517837f66b802353d89e7d278615c9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Pinot?= Date: Thu, 29 Mar 2012 11:41:22 +0000 Subject: [PATCH] =?UTF-8?q?From:=20J=C3=A9r=C3=B4me=20Pinot=20=20Subject:=20[E-devel]=20[patch]=20evas=20doxygen=20doc?= =?UTF-8?q?=20(1)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit There are a lot of small things to fix in the evas doc. Here is a first batch. Fixes are trivial and obvious. Just a question about the first hunk, I removed the that replaced valid email for companies because it makes doxygen complain about the unknown tag and, well, it doesn't give any information either. Was there an explanation about adding this ? Joined is the patch along with the doc build log diff. SVN revision: 69749 --- legacy/evas/AUTHORS | 7 ++-- legacy/evas/src/lib/Evas.h | 68 +++++++++++++++++------------------ legacy/evas/src/lib/Evas_GL.h | 6 ++-- 3 files changed, 41 insertions(+), 40 deletions(-) diff --git a/legacy/evas/AUTHORS b/legacy/evas/AUTHORS index eee8e16137..b54add5a3e 100644 --- a/legacy/evas/AUTHORS +++ b/legacy/evas/AUTHORS @@ -18,8 +18,8 @@ Tom Hacohen Mathieu Taillefumier Iván Briano Gustavo Lima Chaves -Samsung Electronics -Samsung SAIT +Samsung Electronics +Samsung SAIT Sung W. Park Jiyoun Park Myoungwoon Roy Kim(roy_kim) @@ -32,4 +32,5 @@ Youness Alaoui Jim Kukunas Nicolas Aguirre Rafal Krypa -yoyoung Chang +Yoyoung Chang +Jérôme Pinot diff --git a/legacy/evas/src/lib/Evas.h b/legacy/evas/src/lib/Evas.h index 3ab7d4b07d..3cb4669acf 100644 --- a/legacy/evas/src/lib/Evas.h +++ b/legacy/evas/src/lib/Evas.h @@ -292,8 +292,8 @@ Recommended reading: @author Mathieu Taillefumier @author Iván Briano @author Gustavo Lima Chaves -@author Samsung Electronics -@author Samsung SAIT +@author Samsung Electronics +@author Samsung SAIT @author Sung W. Park @author Jiyoun Park @author Myoungwoon Roy Kim(roy_kim) @@ -1497,7 +1497,7 @@ EAPI void evas_obscured_clear (Evas *e) EINA_ARG_NONN * evas_render_updates_free(). * * This function forces an immediate renderization update of the given - * canvas @e. + * canvas @p e. * * @note This is a very low level function, which most of * Evas' users wouldn't care about. One would use it, for example, to @@ -3252,7 +3252,7 @@ EAPI const char *evas_object_name_get (const Evas_Object *obj * @see evas_object_unref() * @see evas_object_del() * - * @note This is a very simple reference counting mechanism! For + * @note This is a very simple 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 @@ -3487,7 +3487,7 @@ EAPI void evas_object_hide (Evas_Object *obj) EINA * 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() @@ -3740,9 +3740,9 @@ EAPI Evas_Object *evas_object_below_get (const Evas_Object *obj * @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". @@ -4093,7 +4093,7 @@ EAPI void evas_object_repeat_events_set (Evas_Object *obj, Ein * 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 @@ -4145,7 +4145,7 @@ EAPI Eina_Bool evas_object_propagate_events_get (const Evas_Object *ob * 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 @@ -5630,7 +5630,7 @@ EAPI Evas_Object_Pointer_Mode evas_object_pointer_mode_get (const Evas_Obje * 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); @@ -5681,7 +5681,7 @@ EAPI double evas_object_scale_get (const Evas_Obje /** * 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); @@ -5759,7 +5759,7 @@ EAPI Evas_Render_Op evas_object_render_op_get (const Evas_Obje * 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 @@ -5962,7 +5962,7 @@ EAPI Eina_List *evas_objects_at_xy_get (const Evas *e, Evas_Co 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, @@ -5983,7 +5983,7 @@ EAPI Eina_List *evas_objects_at_xy_get (const Evas *e, Evas_Co 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, @@ -7796,7 +7796,7 @@ EAPI void evas_object_text_font_source_set (Evas_Object *obj, cons * 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 */ @@ -8213,7 +8213,7 @@ EAPI Evas_BiDi_Direction evas_object_text_direction_get (const Evas_Object *obj * 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) should NEVER be visible. + * A closing tag (i.e a \ 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 "" format to create links in the text (and pop @@ -8354,7 +8354,7 @@ EAPI char *evas_textblock_text_markup_to_utf8(const Evas_ /** * Return the markup version of the plain text. * - * Replaces \n ->
\t -> and etc. Generally needed before you pass + * Replaces \\n -\> \
\\t -\> \ 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 @@ -8667,8 +8667,8 @@ EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_node_format_next_ge 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 pair. - * Assumes the node is the first part of i.e, this won't work if + * Remove a format node and it's match. i.e, removes a \ \ pair. + * Assumes the node is the first part of \ i.e, this won't work if * n is a closing tag. * * @param obj the Evas object of the textblock - not null. @@ -8697,7 +8697,7 @@ EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_cursor_format_get(c /** * 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); @@ -8861,7 +8861,7 @@ EAPI void evas_textblock_cursor_copy(const Evas_Textbloc * 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() */ @@ -8872,7 +8872,7 @@ EAPI int evas_textblock_cursor_text_append(Evas_Textblo * 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() */ @@ -9135,8 +9135,8 @@ EAPI void evas_object_textblock_clear(Evas_Object *obj) * * * @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 */ @@ -9157,8 +9157,8 @@ EAPI void evas_object_textblock_size_formatted_get(const * 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); @@ -9476,8 +9476,8 @@ struct _Evas_Smart_Cb_Description * the user, after inheriting everything from the parent, which * should take care of setting the right member functions for * the class, 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 @_smart_set() to * get the job done. @@ -10804,7 +10804,7 @@ EAPI void evas_object_box_layout_homogeneous_vertical * \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 @@ -11101,7 +11101,7 @@ EAPI Evas_Object_Box_Option *evas_object_box_insert_before * @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 at a given position, in a given @@ -11311,7 +11311,7 @@ EAPI Eina_Bool evas_object_box_option_property_vset * @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). @@ -12216,7 +12216,7 @@ EAPI void evas_key_modifier_add (Evas *e, const char *k /** * 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. @@ -12262,7 +12262,7 @@ EAPI void evas_key_lock_add (Evas *e, const char *k /** * 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. diff --git a/legacy/evas/src/lib/Evas_GL.h b/legacy/evas/src/lib/Evas_GL.h index 76937ebc5c..fe1bdb7cb7 100644 --- a/legacy/evas/src/lib/Evas_GL.h +++ b/legacy/evas/src/lib/Evas_GL.h @@ -418,9 +418,9 @@ EAPI void evas_gl_config_free (Evas_GL_Config *cfg) E * Creates and returns new Evas_GL_Surface object for GL Rendering. * * @param evas_gl The given Evas_GL object. - * @param config The pixel format and configuration of the rendering surface. - * @param width The width of the surface. - * @param height The height of the surface. + * @param cfg The pixel format and configuration of the rendering surface. + * @param w The width of the surface. + * @param h The height of the surface. * @return The created GL surface object, or NULL on failure. */ EAPI Evas_GL_Surface *evas_gl_surface_create (Evas_GL *evas_gl, Evas_GL_Config *cfg, int w, int h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1,2);