From 1b687a57d4318c2474bd1952009f402dffa4606e Mon Sep 17 00:00:00 2001 From: hermet Date: Thu, 6 Oct 2011 12:58:39 +0000 Subject: [PATCH] elementary/naviframe - +ingroup in doxy git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@63879 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- src/lib/Elementary.h.in | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in index 2a1007c..a3ed7b9 100644 --- a/src/lib/Elementary.h.in +++ b/src/lib/Elementary.h.in @@ -27751,6 +27751,7 @@ extern "C" { /** * @defgroup Naviframe Naviframe + * @ingroup Elementary * * @brief Naviframe is a kind of view manager for the applications. * @@ -27782,13 +27783,20 @@ extern "C" { * @li "elm.text.title" - The title label in the title area * * @ref tutorial_naviframe gives a good overview of the usage of the API. + */ + + /** + * @addtogroup Naviframe * @{ */ + /** * @brief Add a new Naviframe object to the parent. * * @param parent Parent object * @return New object or @c NULL, if it cannot be created + * + * @ingroup Naviframe */ EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1); /** @@ -27815,6 +27823,8 @@ extern "C" { * * The following styles are available for this item: * @li @c "default" + * + * @ingroup Naviframe */ EAPI Elm_Object_Item *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5); /** @@ -27829,12 +27839,16 @@ extern "C" { * stack will become visible. * * @see also elm_naviframe_content_preserve_on_pop_get() + * + * @ingroup Naviframe */ EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1); /** * @brief Pop the items between the top and the above one on the given item. * * @param it The naviframe item + * + * @ingroup Naviframe */ EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1); /** @@ -27846,6 +27860,7 @@ extern "C" { * So this would not emit any signals for view transitions but just change * the current view if the given item is a top one. * + * @ingroup Naviframe */ EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1); /** @@ -27855,6 +27870,8 @@ extern "C" { * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise * * @see also elm_naviframe_content_preserve_on_pop_get() + * + * @ingroup Naviframe */ EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1); /** @@ -27864,6 +27881,8 @@ extern "C" { * @return If @c EINA_TRUE, preserve mode is enabled * * @see also elm_naviframe_content_preserve_on_pop_set() + * + * @ingroup Naviframe */ EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /** @@ -27872,6 +27891,8 @@ extern "C" { * @param obj The naviframe object * @return The top item on the naviframe stack or @c NULL, if the stack is * empty + * + * @ingroup Naviframe */ EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /** @@ -27880,6 +27901,8 @@ extern "C" { * @param obj The naviframe object * @return The bottom item on the naviframe stack or @c NULL, if the stack is * empty + * + * @ingroup Naviframe */ EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /** @@ -27892,6 +27915,8 @@ extern "C" { * @li @c "default" * * @see also elm_naviframe_item_style_get() + * + * @ingroup Naviframe */ EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1); /** @@ -27901,6 +27926,8 @@ extern "C" { * @return The current item style name * * @see also elm_naviframe_item_style_set() + * + * @ingroup Naviframe */ EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1); /** @@ -27913,6 +27940,8 @@ extern "C" { * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size. * * @see also elm_naviframe_item_title_visible_get() + * + * @ingroup Naviframe */ EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1); /** @@ -27922,6 +27951,8 @@ extern "C" { * @return If @c EINA_TRUE, title area is visible * * @see also elm_naviframe_item_title_visible_set() + * + * @ingroup Naviframe */ EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1); -- 2.7.4