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



commit f9e685e5c082e4d7b0d02bba5a813b9ece97bdad
Author: Milan Bouchet-Valat <nalimilan club fr>
Date:   Sat Jan 8 17:25:39 2011 +0100

    [Doc] gtk_symbolic_color_resolve()'s props arg can be NULL
    
    Document this behavior and add annotations.

 gtk/gtksymboliccolor.c |    6 +++++-
 1 files changed, 5 insertions(+), 1 deletions(-)
---
diff --git a/gtk/gtksymboliccolor.c b/gtk/gtksymboliccolor.c
index 2345cfa..ee7b714 100644
--- a/gtk/gtksymboliccolor.c
+++ b/gtk/gtksymboliccolor.c
@@ -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



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]