From: Mike McCormack Date: Fri, 25 Nov 2011 09:15:21 +0000 (+0900) Subject: [colorpalette] Move docs to header X-Git-Tag: REL_F_I9500_20111128_2~10 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=16d452df54488e58ba6742294f440981cb3fe53c;p=framework%2Fuifw%2Felementary.git [colorpalette] Move docs to header --- diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in index 5f72e0e..83198ed 100644 --- a/src/lib/Elementary.h.in +++ b/src/lib/Elementary.h.in @@ -29580,19 +29580,53 @@ extern "C" { * @} */ - /* colorpalette */ + /** + * @defgroup Colorpalette Colorpalette + * @ingroup Elementary + * @addtogroup Colorpalette + * @{ + * + * Using colorpalette, you can select a color by clicking + * a color rectangle on the colorpalette. + * + * Smart callbacks that you can add are: + * + * clicked - This signal is sent when a color rectangle is clicked. + */ typedef struct _Colorpalette_Color Elm_Colorpalette_Color; - struct _Colorpalette_Color { unsigned int r, g, b; }; + /** + * Add a new colorpalette to the parent. + * + * @param parent The parent object + * @return The new object or NULL if it cannot be created + * + * @ingroup Colorpalette + */ EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent); + /** + * Set colors to the colorpalette. + * + * @param obj Colorpalette object + * @param color_num number of the colors on the colorpalette + * @param color Color lists + */ EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color); + /** + * Set row/column value for the colorpalette. + * + * @param obj Colorpalette object + * @param row row value for the colorpalette + * @param col column value for the colorpalette + */ EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col); - /* smart callbacks called: - * "clicked" - when image clicked + + /** + * @} */ /* editfield */ diff --git a/src/lib/elm_colorpalette.c b/src/lib/elm_colorpalette.c index b1f417d..3294c5b 100644 --- a/src/lib/elm_colorpalette.c +++ b/src/lib/elm_colorpalette.c @@ -2,19 +2,6 @@ #include "elm_priv.h" #include -/** - * @defgroup Colorpalette Colorpalette - * @ingroup Elementary - * - * Using colorpalette, you can select a color by clicking - * a color rectangle on the colorpalette. - * - * Smart callbacks that you can add are: - * - * clicked - This signal is sent when a color rectangle is clicked. - * - */ - #define MAX_NUM_COLORS 30 typedef struct _Colorpalette_Item Colorpalette_Item; @@ -233,14 +220,6 @@ _color_parse(const char *str, unsigned char *r, unsigned char *g, unsigned char *b = (*b * 0xff) / 255; } -/** - * Add a new colorpalette to the parent. - * - * @param parent The parent object - * @return The new object or NULL if it cannot be created - * - * @ingroup Colorpalette - */ EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent) { Evas_Object *obj = NULL; @@ -296,15 +275,6 @@ EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent) } -/** - * Set colors to the colorpalette. - * - * @param obj Colorpalette object - * @param color_num number of the colors on the colorpalette - * @param color Color lists - * - * @ingroup Colorpalette - */ EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color) { ELM_CHECK_WIDTYPE(obj, widtype); @@ -330,15 +300,6 @@ EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorp _sizing_eval(obj); } -/** - * Set row/column value for the colorpalette. - * - * @param obj Colorpalette object - * @param row row value for the colorpalette - * @param col column value for the colorpalette - * - * @ingroup Colorpalette - */ EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col) { ELM_CHECK_WIDTYPE(obj, widtype);