Add some comments to make things clearer

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2009-04-18 08:56:46 +02:00 committed by Julien Danjou
parent 708636b5bf
commit 7beda0321a
1 changed files with 7 additions and 0 deletions

View File

@ -74,8 +74,12 @@ color_parse(const char *colstr, ssize_t len,
}
/** Send a request to initialize a color.
* If you are only interested in the color's pixel value or need both, the pixel
* value and the rgba components, use xcolor_init_unchecked() and/or
* xcolor_to_color() instead.
* \param color color_t struct to store color into.
* \param colstr Color specification.
* \param len The length of colstr (which still MUST be NULL terminated).
* \return request informations.
*/
color_init_cookie_t
@ -152,8 +156,11 @@ color_init_reply(color_init_cookie_t req)
}
/** Send a request to initialize a X color.
* If you are only interested in the rgba values and don't need the color's
* pixel value, you should use color_init_unchecked() instead.
* \param color xcolor_t struct to store color into.
* \param colstr Color specification.
* \param len The length of colstr (which still MUST be NULL terminated).
* \return request informations.
*/
xcolor_init_request_t