[Doc] gtk_symbolic_color_resolve()'s props arg can be NULL

Document this behavior and add annotations.
This commit is contained in:
Milan Bouchet-Valat 2011-01-08 17:25:39 +01:00
parent b761cadacc
commit f9e685e5c0

View File

@ -465,7 +465,8 @@ _shade_color (GdkRGBA *color,
/**
* gtk_symbolic_color_resolve:
* @color: a #GtkSymbolicColor
* @props: #GtkStyleProperties to use when resolving named colors
* @props: (allow-none): #GtkStyleProperties to use when resolving
* named colors, or %NULL
* @resolved_color: (out): return location for the resolved color
*
* If @color is resolvable, @resolved_color will be filled in
@ -473,6 +474,9 @@ _shade_color (GdkRGBA *color,
* if @color can't be resolved, it is due to it being defined on
* top of a named color that doesn't exist in @props.
*
* @props must be non-%NULL if @color was created using
* gtk_symbolic_color_named_new(), but can be omitted in other cases.
*
* Returns: %TRUE if the color has been resolved
*
* Since: 3.0