seoz pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=49cad7f61aafcdc8263a4d7f9e7d575a329c3db4
commit 49cad7f61aafcdc8263a4d7f9e7d575a329c3db4 Author: Daniel Juyung Seo <[email protected]> Date: Mon Sep 1 00:28:07 2014 +0900 panel: added more documentations to panel. --- src/lib/elm_panel.eo | 8 ++++---- src/lib/elm_panel.h | 8 ++++---- src/lib/elm_panel_common.h | 11 +++++++++++ 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/src/lib/elm_panel.eo b/src/lib/elm_panel.eo index e239615..3f37a3f 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, /*@ @brief Get the orientation of the panel. - @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure. + @return The Elm_Panel_Orient, or #ELM_PANEL_ORIENT_LEFT on failure. @ingroup Panel */ } values { Elm_Panel_Orient 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 */ + @li #ELM_PANEL_ORIENT_TOP + @li #ELM_PANEL_ORIENT_LEFT + @li #ELM_PANEL_ORIENT_RIGHT */ } } hidden { diff --git a/src/lib/elm_panel.h b/src/lib/elm_panel.h index 9089830..175fcc1 100644 --- a/src/lib/elm_panel.h +++ b/src/lib/elm_panel.h @@ -13,10 +13,10 @@ * button on its edge. * * Orientations are as follows: - * @li @c ELM_PANEL_ORIENT_TOP - * @li @c ELM_PANEL_ORIENT_LEFT - * @li @c ELM_PANEL_ORIENT_RIGHT - * @li @c ELM_PANEL_ORIENT_BOTTOM + * @li #ELM_PANEL_ORIENT_TOP + * @li #ELM_PANEL_ORIENT_LEFT + * @li #ELM_PANEL_ORIENT_RIGHT + * @li #ELM_PANEL_ORIENT_BOTTOM * * This widget inherits from the @ref Layout one, so that all the * 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 9993b22..fee289a 100644 --- a/src/lib/elm_panel_common.h +++ b/src/lib/elm_panel_common.h @@ -1,3 +1,8 @@ +/** + * Panel orientation mode + * + * @ingroup Panel + */ typedef enum { ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */ @@ -6,6 +11,12 @@ typedef enum ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */ } Elm_Panel_Orient; +/** + * Panel scroll information + * + * @since 1.11 + * @ingroup Panel + */ typedef struct _Elm_Panel_Scroll_Info { double rel_x; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/ --
