revert to the migration tempoary
[framework/uifw/elementary.git] / src / lib / elm_colorpalette.c
index 3294c5b..b1f417d 100644 (file)
@@ -2,6 +2,19 @@
 #include "elm_priv.h"
 #include <Ecore.h>
 
+/**
+ * @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;
@@ -220,6 +233,14 @@ _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;
@@ -275,6 +296,15 @@ 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);
@@ -300,6 +330,15 @@ 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);