From f548a938b3af727c78c1763c7b73ac933cbbe5b8 Mon Sep 17 00:00:00 2001
From: Rajeev Ranjan <rajeev.r@samsung.com>
Date: Mon, 13 Sep 2010 22:10:32 +0900
Subject: [PATCH] [src/lib/elm_panes.c] Doxygen comments for the interfaces

---
 src/lib/elm_panes.c | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 81 insertions(+), 3 deletions(-)

diff --git a/src/lib/elm_panes.c b/src/lib/elm_panes.c
index 8ef58be..74b86d5 100644
--- a/src/lib/elm_panes.c
+++ b/src/lib/elm_panes.c
@@ -141,7 +141,7 @@ _unpress(void *data, Evas_Object *obj __UNUSED__ , const char *emission __UNUSED
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
  *
- * @ingroup Panel
+ * @ingroup Panes
  */
 EAPI Evas_Object *
 elm_panes_add(Evas_Object *parent)
@@ -184,6 +184,14 @@ elm_panes_add(Evas_Object *parent)
    return obj;
 }
 
+/**
+ * Set a control as a left/top content of the pane
+ *
+ * @param obj The pane object
+ * @param content The object to be set as content
+ *
+ * @ingroup Panes
+ */
 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content)
 {
    Widget_Data *wd = elm_widget_data_get(obj);
@@ -202,7 +210,14 @@ EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content)
      }
 }
 
-
+/**
+ * Set a control as a right/bottom content of the pane
+ *
+ * @param obj The pane object
+ * @param content The object to be set as content
+ *
+ * @ingroup Panes
+ */
 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content)
 {
    Widget_Data *wd = elm_widget_data_get(obj);
@@ -221,7 +236,14 @@ EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content)
      }
 }
 
-
+/**
+ * Get the left/top content of the pane
+ *
+ * @param obj The pane object
+ * @return The Evas Object set as a left/top content of the pane
+ *
+ * @ingroup Panes
+ */
 EAPI Evas_Object
 *elm_panes_content_left_get(const Evas_Object *obj)
 {
@@ -229,6 +251,14 @@ EAPI Evas_Object
    return wd->contents.left;
 }
 
+/**
+ * Get the right/bottom content of the pane
+ *
+ * @param obj The pane object
+ * @return The Evas Object set as a right/bottom content of the pane
+ *
+ * @ingroup Panes
+ */
 EAPI Evas_Object
 *elm_panes_content_right_get(const Evas_Object *obj)
 {
@@ -236,6 +266,14 @@ EAPI Evas_Object
    return wd->contents.right;
 }
 
+/**
+ * Get the relative normalized size of left/top content of the pane
+ *
+ * @param obj The pane object
+ * @return The value of type double in the range [0.0,1.0]
+ *
+ * @ingroup Panes
+ */
 EAPI double 
 elm_panes_content_left_size_get(const Evas_Object *obj)
 {
@@ -250,6 +288,14 @@ elm_panes_content_left_size_get(const Evas_Object *obj)
      return w;
 }
 
+/**
+ * Set a size of the left content with a relative normalized double value
+ *
+ * @param obj The pane object
+ * @param size The value of type double in the range [0.0,1.0]
+ *
+ * @ingroup Panes
+ */
 EAPI void 
 elm_panes_content_left_size_set(Evas_Object *obj, double size)
 {
@@ -261,6 +307,14 @@ elm_panes_content_left_size_set(Evas_Object *obj, double size)
      edje_object_part_drag_value_set(wd->panes, "elm.bar", size, 0.0);
 }
 
+/**
+ * Set the type of an existing pane object to horizontal
+ *
+ * @param obj The pane object
+ * @param horizontal Boolean value. If true, then the type is set to horizontal else vertical
+ *
+ * @ingroup Panes
+ */
 EAPI void 
 elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
 {
@@ -271,6 +325,14 @@ elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
    elm_panes_content_left_size_set(obj, 0.5);
 }
 
+/**
+ * Indicate if the type of pane object is horizontal or not
+ *
+ * @param obj The pane object
+ * @return true if it is of horizontal type else false
+ *
+ * @ingroup Panes
+ */
 EAPI Eina_Bool 
 elm_panes_horizontal_is(const Evas_Object *obj)
 {
@@ -279,6 +341,14 @@ elm_panes_horizontal_is(const Evas_Object *obj)
    return wd->horizontal;
 }
 
+/**
+ * Set a handler of the pane object non-movable or movable
+ *
+ * @param obj The pane object
+ * @param fixed If set to true then the views size can't be changed using handler otherwise using handler they can be resized
+ *
+ * @ingroup Panes
+ */
 EAPI void
 elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed)
 {
@@ -290,6 +360,14 @@ elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed)
       edje_object_signal_emit(wd->panes, "elm.unfixed", "movement.decider");
 }
 
+/**
+ * Indicate if the handler of the pane object can be moved with user interaction
+ *
+ * @param obj The pane object
+ * @return false if the views can be resized using handler else true
+ *
+ * @ingroup Panes
+ */
 EAPI Eina_Bool
 elm_panes_fixed_is(const Evas_Object *obj)
 {
-- 
2.7.4