[GRASS-SVN] r29903 - grass/trunk/display/d.paint.labels

[svn_grass at osgeo.org]

Author: hamish
Date: 2008-01-30 17:36:14 -0500 (Wed, 30 Jan 2008)
New Revision: 29903

Modified:
   grass/trunk/display/d.paint.labels/color.c
Log:
doxygen comments


Modified: grass/trunk/display/d.paint.labels/color.c
===================================================================
--- grass/trunk/display/d.paint.labels/color.c	2008-01-30 21:52:43 UTC (rev 29902)
+++ grass/trunk/display/d.paint.labels/color.c	2008-01-30 22:36:14 UTC (rev 29903)
@@ -32,10 +32,21 @@
     color->b = b;
 }
 
-/* Parses color string and fills RGBA array
+
+/* 
+ * \brief Parses color string and fill RGBA array
+ *
+ * If the color is valid the color's alpha value is set to RGBA_COLOR_OPAQUE.
+ * The 'none' case is handed by setting the alpha channel to RGBA_COLOR_NONE.
+ *
  *  Returns: 1 - OK
- *           2 - NONE 
+ *           2 - NONE
  *           0 - Error 
+ *
+ *  \param color_string
+ *  \param RGBA_Color struct to be populated
+ *  \return int
+ * 
  */
 int set_RGBA_from_str(RGBA_Color *color, const char *clr_str)
 {