X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2Flib%2Felm_panel.h;h=fabbcc0aee32338a715257f998ed053be90e9fdc;hb=c414ba036271833c1098337494b02d9eb6266d48;hp=0c272121df8bce68debef50001a6f74fd97c4f70;hpb=43e26d706ddcd893642021d6b6df4056581b56b1;p=framework%2Fuifw%2Felementary.git diff --git a/src/lib/elm_panel.h b/src/lib/elm_panel.h index 0c27212..fabbcc0 100644 --- a/src/lib/elm_panel.h +++ b/src/lib/elm_panel.h @@ -1,5 +1,6 @@ /** * @defgroup Panel Panel + * @ingroup Elementary * * @image html img/widget/panel/preview-00.png * @image latex img/widget/panel/preview-00.eps @@ -12,16 +13,16 @@ * @li ELM_PANEL_ORIENT_LEFT * @li ELM_PANEL_ORIENT_RIGHT * - * Default contents parts of the panel widget that you can use for are: + * Default content parts of the panel widget that you can use for are: * @li "default" - A content of the panel * * Supported elm_object common APIs. - * @li elm_object_signal_emit - * @li elm_object_signal_callback_add - * @li elm_object_signal_callback_del - * @li elm_object_part_content_set - * @li elm_object_part_content_get - * @li elm_object_part_content_unset + * @li @ref elm_object_signal_emit + * @li @ref elm_object_signal_callback_add + * @li @ref elm_object_signal_callback_del + * @li @ref elm_object_part_content_set + * @li @ref elm_object_part_content_get + * @li @ref elm_object_part_content_unset * * @ref tutorial_panel shows one way to use this widget. * @{ @@ -40,19 +41,23 @@ typedef enum * @param parent The parent object * * @return The panel object, or NULL on failure + * + * @ingroup Panel */ EAPI Evas_Object *elm_panel_add(Evas_Object *parent); /** * @brief Sets the orientation of the panel * - * @param parent The parent object + * @param obj The panel object * @param orient The panel orientation. Can be one of the following: * @li ELM_PANEL_ORIENT_TOP * @li ELM_PANEL_ORIENT_LEFT * @li ELM_PANEL_ORIENT_RIGHT * * Sets from where the panel will (dis)appear. + * + * @ingroup Panel */ EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient); @@ -61,6 +66,8 @@ EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Pan * * @param obj The panel object * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure. + * + * @ingroup Panel */ EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj); @@ -68,7 +75,9 @@ EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj); * @brief Set the state of the panel. * * @param obj The panel object - * @param hidden If true, the panel will run the animation to contract + * @param hidden If true, the panel will run the animation to disappear. + * + * @ingroup Panel */ EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden); @@ -76,7 +85,9 @@ EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bo * @brief Get the state of the panel. * * @param obj The panel object - * @param hidden If true, the panel is in the "hide" state + * @return EINA_TRUE if it is hidden state + * + * @ingroup Panel */ EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj); @@ -84,6 +95,8 @@ EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj); * @brief Toggle the hidden state of the panel from code * * @param obj The panel object + * + * @ingroup Panel */ EAPI void elm_panel_toggle(Evas_Object *obj);