dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

corrected documentation. 

2007-08-01  Sven Neumann  <sven@gimp.org>

	* libgimpcolor/gimprgb-parse.c: corrected documentation.

svn path=/trunk/; revision=23095
This commit is contained in:
Sven Neumann 2007-08-01 12:03:13 +00:00 committed by Sven Neumann
parent 521ae969b3
commit da2a79fe42
2 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
2007-08-01 Sven Neumann <sven@gimp.org>
* libgimpcolor/gimprgb-parse.c: corrected documentation.
2007-07-31 Sven Neumann <sven@gimp.org> 2007-07-31 Sven Neumann <sven@gimp.org>
* app/tools/gimprectangleselecttool.c * app/tools/gimprectangleselecttool.c

25
libgimpcolor/gimprgb-parse.c
View File

@ -216,16 +216,13 @@ static const ColorEntry named_colors[] =
* @name: a color name (in UTF-8 encoding) * @name: a color name (in UTF-8 encoding)
* @len: the length of @name, in bytes. or -1 if @name is nul-terminated * @len: the length of @name, in bytes. or -1 if @name is nul-terminated
* *
* Attempts to parse a color name. This function accepts RGB hex * Attempts to parse a color name. This function accepts <ulink
* values or <ulink url="http://www.w3.org/TR/SVG/types.html">SVG 1.0 * url="http://www.w3.org/TR/SVG/types.html">SVG 1.0 color keywords</ulink>.
* color keywords</ulink>. The format of an RGB value in hexadecimal
* notation is a '#' immediately followed by either three or six
* hexadecimal characters.
* *
* This function does not touch the alpha component of @rgb. * This function does not touch the alpha component of @rgb.
* *
* Return value: %TRUE if @name was parsed successfully and @rgb has been * Return value: %TRUE if @name was parsed successfully and @rgb has
* set, %FALSE otherwise * been set, %FALSE otherwise
* *
* Since: GIMP 2.2 * Since: GIMP 2.2
**/ **/
@ -255,13 +252,13 @@ gimp_rgb_parse_name (GimpRGB *rgb,
* @hex: a string describing a color in hexadecimal notation * @hex: a string describing a color in hexadecimal notation
* @len: the length of @hex, in bytes. or -1 if @hex is nul-terminated * @len: the length of @hex, in bytes. or -1 if @hex is nul-terminated
* *
* Attempts to parse a string describing a color in RGB value in * Attempts to parse a string describing an RGB color in hexadecimal
* hexadecimal notation (optionally prefixed with a '#'). * notation (optionally prefixed with a '#').
* *
* This function does not touch the alpha component of @rgb. * This function does not touch the alpha component of @rgb.
* *
* Return value: %TRUE if @hex was parsed successfully and @rgb has been * Return value: %TRUE if @hex was parsed successfully and @rgb has
* set, %FALSE otherwise * been set, %FALSE otherwise
* *
* Since: GIMP 2.2 * Since: GIMP 2.2
**/ **/
@ -291,10 +288,10 @@ gimp_rgb_parse_hex (GimpRGB *rgb,
* @css: a string describing a color in CSS notation * @css: a string describing a color in CSS notation
* @len: the length of @hex, in bytes. or -1 if @hex is nul-terminated * @len: the length of @hex, in bytes. or -1 if @hex is nul-terminated
* *
* Attempts to parse a string describing a color in RGB value in CSS * Attempts to parse a string describing an RGB color in CSS
* notation. This can be either a numerical representation * notation. This can be either a numerical representation
* (<code>rgb(255,0,0)</code> or <code>rgb(100%,0%,0%)</code>) or * (<code>rgb(255,0,0)</code> or <code>rgb(100%,0%,0%)</code>)
* a hexadecimal notation as parsed by gimp_rgb_parse_hex() * or a hexadecimal notation as parsed by gimp_rgb_parse_hex()
* (<code>##ff0000</code>) or a color name as parsed by * (<code>##ff0000</code>) or a color name as parsed by
* gimp_rgb_parse_name() (<code>red</code>). * gimp_rgb_parse_name() (<code>red</code>).
* *