From f87a7d374d850581d58b1049df76153f9357155b Mon Sep 17 00:00:00 2001 From: Christopher Michael Date: Tue, 9 Feb 2010 02:46:19 +0000 Subject: [PATCH] Add initial doxy for conformant widget. SVN revision: 46000 --- legacy/elementary/src/lib/elm_conform.c | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/legacy/elementary/src/lib/elm_conform.c b/legacy/elementary/src/lib/elm_conform.c index 18519daf5e..912d083cbb 100644 --- a/legacy/elementary/src/lib/elm_conform.c +++ b/legacy/elementary/src/lib/elm_conform.c @@ -1,6 +1,14 @@ #include #include "elm_priv.h" +/** + * @defgroup Conformant Conformant + * + * The aim is to provide a widget that can be used in elementary apps to + * account for space taken up by the indicator & softkey windows when running + * the illume2 module of E17. + */ + typedef struct _Widget_Data Widget_Data; struct _Widget_Data { @@ -163,6 +171,14 @@ _prop_change(void *data, int type, void *event) return 1; } +/** + * Add a new Conformant object + * + * @param parent The parent object + * @return The new conformant object or NULL if it cannot be created + * + * @ingroup Conformant + */ EAPI Evas_Object * elm_conformant_add(Evas_Object *parent) { @@ -220,6 +236,14 @@ elm_conformant_add(Evas_Object *parent) return obj; } +/** + * Set the content of the conformant widget + * + * @param obj The conformant object + * @param content The content that will be used inside this conformant object + * + * @ingroup Conformant + */ EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) {