From 3b2b5e3c54a1030b79c1c657ba0ec459c6fe347f Mon Sep 17 00:00:00 2001 From: Vincent Torri Date: Mon, 2 Apr 2012 16:39:08 +0000 Subject: [PATCH] Elm: second doc patch MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Patch by Jérôme Pinot SVN revision: 69866 --- legacy/elementary/doc/examples.dox | 6 +++--- legacy/elementary/src/lib/elm_bg.h | 4 +++- legacy/elementary/src/lib/elm_entry.h | 2 +- legacy/elementary/src/lib/elm_frame.h | 2 +- legacy/elementary/src/lib/elm_glview.h | 2 +- legacy/elementary/src/lib/elm_index.h | 1 + legacy/elementary/src/lib/elm_map.h | 7 +++++-- legacy/elementary/src/lib/elm_route.h | 4 ++++ legacy/elementary/src/lib/elm_web.h | 4 ++-- 9 files changed, 21 insertions(+), 11 deletions(-) diff --git a/legacy/elementary/doc/examples.dox b/legacy/elementary/doc/examples.dox index 0a6524b1c0..af803e0419 100644 --- a/legacy/elementary/doc/examples.dox +++ b/legacy/elementary/doc/examples.dox @@ -140,7 +140,7 @@ * @skip size_hint_weight_set * @until resize_object_add * - * See @ref evas_object_size_hint_weight_set and elm_win_resize_object_add() + * See evas_object_size_hint_weight_set() and elm_win_resize_object_add() * for more detailed info about these functions. * * The end of the example is quite simple, just setting the minimum and @@ -3469,7 +3469,7 @@ */ /** - * @page glview_01_example_page - GLView Example + * @page glview_example_01_page - GLView Example * @include glview_example_01.c */ @@ -3983,7 +3983,7 @@ * @image html screenshots/index_example_03.png * @image latex screenshots/index_example_03.eps * - * See the full @ref index_example.c "source code" for + * See the full @ref index_example_02.c "source code" for * this example. * * @example index_example_02.c diff --git a/legacy/elementary/src/lib/elm_bg.h b/legacy/elementary/src/lib/elm_bg.h index cb1b7f54d9..1a869d4067 100644 --- a/legacy/elementary/src/lib/elm_bg.h +++ b/legacy/elementary/src/lib/elm_bg.h @@ -29,10 +29,12 @@ /** * Identifiers on how a background widget is to display its image -- - * if it was tset to use an image file. + * if it was set to use an image file. * * @see elm_bg_option_set() * @see elm_bg_option_get() + * + * @ingroup Bg */ typedef enum { diff --git a/legacy/elementary/src/lib/elm_entry.h b/legacy/elementary/src/lib/elm_entry.h index b29a284885..d290580ad7 100644 --- a/legacy/elementary/src/lib/elm_entry.h +++ b/legacy/elementary/src/lib/elm_entry.h @@ -234,7 +234,7 @@ * * @section entry-examples * - * An overview of the Entry API can be seen in @ref entry_example_01 + * An overview of the Entry API can be seen in @ref entry_example * * @{ */ diff --git a/legacy/elementary/src/lib/elm_frame.h b/legacy/elementary/src/lib/elm_frame.h index 285f767169..b963e778c3 100644 --- a/legacy/elementary/src/lib/elm_frame.h +++ b/legacy/elementary/src/lib/elm_frame.h @@ -96,6 +96,6 @@ EAPI Eina_Bool elm_frame_collapse_get(const Evas_Object *obj); */ EAPI void elm_frame_collapse_go(Evas_Object *obj, Eina_Bool collapse); -/* +/** * @} */ diff --git a/legacy/elementary/src/lib/elm_glview.h b/legacy/elementary/src/lib/elm_glview.h index 43aaa7b7c2..636e9e1d9d 100644 --- a/legacy/elementary/src/lib/elm_glview.h +++ b/legacy/elementary/src/lib/elm_glview.h @@ -8,7 +8,7 @@ * * Below is an illustrative example of how to use GLView and and OpenGL * to render in elementary environment. - * @ref glview_01_example_page + * @ref glview_example_01_page * */ diff --git a/legacy/elementary/src/lib/elm_index.h b/legacy/elementary/src/lib/elm_index.h index f8be044b01..82793a7ae6 100644 --- a/legacy/elementary/src/lib/elm_index.h +++ b/legacy/elementary/src/lib/elm_index.h @@ -135,6 +135,7 @@ EAPI void elm_index_item_selected_set(Elm_Object_Item *it, Eina * Returns the last selected item, for a given index widget. * * @param obj The index object. + * @param level @c 0 or @c 1, the currently implemented levels. * @return The last item @b selected on @p obj (or @c NULL, on errors). * * @ingroup Index diff --git a/legacy/elementary/src/lib/elm_map.h b/legacy/elementary/src/lib/elm_map.h index b0b89dc41c..c7b58df068 100644 --- a/legacy/elementary/src/lib/elm_map.h +++ b/legacy/elementary/src/lib/elm_map.h @@ -1035,9 +1035,9 @@ EAPI int elm_map_overlay_class_zoom_max_get(const Elm_Map_Over /** * Get the overlay members of the group overlay. * - * @param clas The group overlay has overlay members. + * @param grp The group overlay has overlay members. * - * @return The list of group overlay memebers. + * @return The list of group overlay members. * * The group overlays are virtualy overlays. Those are shown and hidden dynamically. * You can add callback to the class overlay. If one of the group overlays in this class @@ -1498,3 +1498,6 @@ EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, void *emap); */ EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route); +/** + * @} + */ diff --git a/legacy/elementary/src/lib/elm_route.h b/legacy/elementary/src/lib/elm_route.h index 01757e8a30..f2425912b0 100644 --- a/legacy/elementary/src/lib/elm_route.h +++ b/legacy/elementary/src/lib/elm_route.h @@ -46,3 +46,7 @@ EAPI void elm_route_longitude_min_max_get(const Evas_Object *obj, double * @ingroup Route */ EAPI void elm_route_latitude_min_max_get(const Evas_Object *obj, double *min, double *max); + +/** + * @} + */ diff --git a/legacy/elementary/src/lib/elm_web.h b/legacy/elementary/src/lib/elm_web.h index 33645eb3c3..6df12e95ad 100644 --- a/legacy/elementary/src/lib/elm_web.h +++ b/legacy/elementary/src/lib/elm_web.h @@ -930,7 +930,7 @@ EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf * Gets boolean properties from Elm_Web_Window_Features * (such as statusbar, menubar, etc) that are on a window. * - * @param obj The web window features object + * @param wf The web window features object * @param flag The web window feature flag whose value is required. * * @return EINA_TRUE if the flag is set, EINA_FALSE otherwise @@ -941,7 +941,7 @@ EAPI Eina_Bool elm_web_window_features_property_get(const Elm_Web_W * * TODO : Add documentation. * - * @param obj The web window features object + * @param wf The web window features object * @param x, y, w, h - the co-ordinates of the web view window. * */