Add APIs for floating mode (app-in-app)

[framework/uifw/elementary.git] / src / lib / elm_panel.h

diff --git a/src/lib/elm_panel.h b/src/lib/elm_panel.h
index c41fae8..fabbcc0 100644 (file)
--- 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
@@ -16,12 +17,12 @@
  * @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,6 +41,8 @@ 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);
 
@@ -53,6 +56,8 @@ EAPI Evas_Object                 *elm_panel_add(Evas_Object *parent);
  * @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);
 
@@ -69,6 +76,8 @@ EAPI Elm_Panel_Orient             elm_panel_orient_get(const Evas_Object *obj);
  *
  * @param obj The panel object
  * @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);
 
@@ -77,6 +86,8 @@ EAPI void                         elm_panel_hidden_set(Evas_Object *obj, Eina_Bo
  *
  * @param obj The panel object
  * @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);