[gtk+/wip/css: 13/143] css: Add some docs to GtkCssLookup



commit 2d000b9405cf63b000bdb72b9dc56874e77642d8
Author: Benjamin Otte <otte redhat com>
Date:   Thu Dec 29 00:28:56 2011 +0100

    css: Add some docs to GtkCssLookup
    
    In particular, document which parts of the CSS value querying we're
    doing here.

 gtk/gtkcsslookup.c |   22 ++++++++++++++++++++++
 1 files changed, 22 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkcsslookup.c b/gtk/gtkcsslookup.c
index a1e4247..5badd7b 100644
--- a/gtk/gtkcsslookup.c
+++ b/gtk/gtkcsslookup.c
@@ -68,6 +68,16 @@ _gtk_css_lookup_is_missing (const GtkCssLookup *lookup,
   return lookup->values[id] == NULL;
 }
 
+/**
+ * _gtk_css_lookup_set:
+ * @lookup: the lookup
+ * @id: id of the property to set, see _gtk_style_property_get_id()
+ * @value: the "cascading value" to use
+ *
+ * Sets the @value for a given @id. No value may have been set for @id
+ * before. See _gtk_css_lookup_is_missing(). This function is used to
+ * set the "winning declaration" of a lookup.
+ **/
 void
 _gtk_css_lookup_set (GtkCssLookup *lookup,
                      guint         id,
@@ -81,6 +91,18 @@ _gtk_css_lookup_set (GtkCssLookup *lookup,
   lookup->values[id] = value;
 }
 
+/**
+ * _gtk_css_lookup_resolve:
+ * @lookup: the lookup
+ *
+ * Resolves the current lookup into a styleproperties object. This is done
+ * by converting from the "winning declaration" to the "computed value".
+ *
+ * XXX: This bypasses the notion of "specified value". If this ever becomes
+ * an issue, go fix it.
+ *
+ * Returns: a new #GtkStyleProperties
+ **/
 GtkStyleProperties *
 _gtk_css_lookup_resolve (GtkCssLookup *lookup)
 {



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