summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorDaniel Juyung Seo <seojuyung2@gmail.com>2014-09-01 00:28:07 +0900
committerDaniel Juyung Seo <seojuyung2@gmail.com>2014-09-01 00:28:07 +0900
commit49cad7f61aafcdc8263a4d7f9e7d575a329c3db4 (patch)
treebe7005b5a7d090334a2ad9227f90a3f614dc1b17 /src/lib
parent73469fbd8ea4f3740e6e5f30cedfc29d361e34c6 (diff)
panel: added more documentations to panel.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/elm_panel.eo8
-rw-r--r--src/lib/elm_panel.h8
-rw-r--r--src/lib/elm_panel_common.h11
3 files changed, 19 insertions, 8 deletions
diff --git a/src/lib/elm_panel.eo b/src/lib/elm_panel.eo
index e2396154d..3f37a3f38 100644
--- a/src/lib/elm_panel.eo
+++ b/src/lib/elm_panel.eo
@@ -16,15 +16,15 @@ class Elm_Panel (Elm_Layout, Elm_Interface_Scrollable,
16 /*@ 16 /*@
17 @brief Get the orientation of the panel. 17 @brief Get the orientation of the panel.
18 18
19 @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure. 19 @return The Elm_Panel_Orient, or #ELM_PANEL_ORIENT_LEFT on failure.
20 20
21 @ingroup Panel */ 21 @ingroup Panel */
22 } 22 }
23 values { 23 values {
24 Elm_Panel_Orient orient; /*@ The panel orientation. Can be one of the following: 24 Elm_Panel_Orient orient; /*@ The panel orientation. Can be one of the following:
25 @li ELM_PANEL_ORIENT_TOP 25 @li #ELM_PANEL_ORIENT_TOP
26 @li ELM_PANEL_ORIENT_LEFT 26 @li #ELM_PANEL_ORIENT_LEFT
27 @li ELM_PANEL_ORIENT_RIGHT */ 27 @li #ELM_PANEL_ORIENT_RIGHT */
28 } 28 }
29 } 29 }
30 hidden { 30 hidden {
diff --git a/src/lib/elm_panel.h b/src/lib/elm_panel.h
index 908983001..175fcc132 100644
--- a/src/lib/elm_panel.h
+++ b/src/lib/elm_panel.h
@@ -13,10 +13,10 @@
13 * button on its edge. 13 * button on its edge.
14 * 14 *
15 * Orientations are as follows: 15 * Orientations are as follows:
16 * @li @c ELM_PANEL_ORIENT_TOP 16 * @li #ELM_PANEL_ORIENT_TOP
17 * @li @c ELM_PANEL_ORIENT_LEFT 17 * @li #ELM_PANEL_ORIENT_LEFT
18 * @li @c ELM_PANEL_ORIENT_RIGHT 18 * @li #ELM_PANEL_ORIENT_RIGHT
19 * @li @c ELM_PANEL_ORIENT_BOTTOM 19 * @li #ELM_PANEL_ORIENT_BOTTOM
20 * 20 *
21 * This widget inherits from the @ref Layout one, so that all the 21 * This widget inherits from the @ref Layout one, so that all the
22 * functions acting on it also work for panel objects (since 1.8). 22 * functions acting on it also work for panel objects (since 1.8).
diff --git a/src/lib/elm_panel_common.h b/src/lib/elm_panel_common.h
index 9993b2208..fee289a33 100644
--- a/src/lib/elm_panel_common.h
+++ b/src/lib/elm_panel_common.h
@@ -1,3 +1,8 @@
1/**
2 * Panel orientation mode
3 *
4 * @ingroup Panel
5 */
1typedef enum 6typedef enum
2{ 7{
3 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */ 8 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
@@ -6,6 +11,12 @@ typedef enum
6 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */ 11 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
7} Elm_Panel_Orient; 12} Elm_Panel_Orient;
8 13
14/**
15 * Panel scroll information
16 *
17 * @since 1.11
18 * @ingroup Panel
19 */
9typedef struct _Elm_Panel_Scroll_Info 20typedef struct _Elm_Panel_Scroll_Info
10{ 21{
11 double rel_x; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/ 22 double rel_x; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/