summaryrefslogtreecommitdiff
path: root/gdk/gdkcolor.c
diff options
context:
space:
mode:
authorBjörn Lindqvist <bjourne@gmail.com>2008-05-24 16:51:38 +0000
committerBjörn Lindqvist <bjornl@src.gnome.org>2008-05-24 16:51:38 +0000
commit4aeca6c61a47625ce6b16930a7c96336fa00d5eb (patch)
tree108d450f270ece52e8bd1800aa39aa8adf31a823 /gdk/gdkcolor.c
parent6b96eae19b8e3a44ba538ed2b1aa791ab89f1753 (diff)
downloadgtk+-4aeca6c61a47625ce6b16930a7c96336fa00d5eb.tar.gz
Update docstring to match pango_color_parse, do not reference XParseColor
2008-05-24 Björn Lindqvist <bjourne@gmail.com> * gdk/gdkcolor.c (gdk_color_parse): Update docstring to match pango_color_parse, do not reference XParseColor forms (#434991). svn path=/trunk/; revision=20135
Diffstat (limited to 'gdk/gdkcolor.c')
-rw-r--r--gdk/gdkcolor.c23
1 files changed, 12 insertions, 11 deletions
diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c
index 4c3d88ebe6..6a513a3e28 100644
--- a/gdk/gdkcolor.c
+++ b/gdk/gdkcolor.c
@@ -316,17 +316,18 @@ gdk_color_get_type (void)
* @spec: the string specifying the color.
* @color: the #GdkColor to fill in
*
- * Parses a textual specification of a color and fill in
- * the <structfield>red</structfield>,
- * <structfield>green</structfield>, and
- * <structfield>blue</structfield> fields of a
- * #GdkColor structure. The color is <emphasis>not</emphasis>
- * allocated, you must call gdk_colormap_alloc_color() yourself.
- * The text string can be in any of the forms accepted
- * by <function>XParseColor</function>; these include
- * name for a color from <filename>rgb.txt</filename>, such as
- * <literal>DarkSlateGray</literal>, or a hex specification
- * such as <literal>&num;3050b2</literal> or <literal>&num;35b</literal>.
+ * Parses a textual specification of a color and fill in the
+ * <structfield>red</structfield>, <structfield>green</structfield>,
+ * and <structfield>blue</structfield> fields of a #GdkColor
+ * structure. The color is <emphasis>not</emphasis> allocated, you
+ * must call gdk_colormap_alloc_color() yourself. The string can
+ * either one of a large set of standard names. (Taken from the X11
+ * <filename>rgb.txt</filename> file), or it can be a hex value in the
+ * form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or
+ * '&num;rrrrggggbbbb' where 'r', 'g' and 'b' are hex digits of the
+ * red, green, and blue components of the color, respectively. (White
+ * in the four forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and
+ * '&num;ffffffffffff')
*
* Return value: %TRUE if the parsing succeeded.
**/