summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Staudinger <robertx.staudinger@intel.com>2009-05-07 10:12:57 +0200
committerRobert Staudinger <robertx.staudinger@intel.com>2009-05-07 10:12:57 +0200
commit3b3c9529f227d3d9fb5935f938979a8db066ee00 (patch)
tree37cf6b8973b171db3542db5c86b9040969ceae95
parent151dfc70e50ad662ae0ca7ebd623bbde702689a2 (diff)
[ccss] Update documentation.
-rw-r--r--ccss-doc/tmpl/block.sgml2
-rw-r--r--ccss-doc/tmpl/style.sgml4
-rw-r--r--ccss/ccss-block.c4
-rw-r--r--ccss/ccss-block.h2
-rw-r--r--ccss/ccss-grammar-function.c4
-rw-r--r--ccss/ccss-grammar.c3
-rw-r--r--ccss/ccss-node.h11
-rw-r--r--ccss/ccss-property-generic.h6
-rw-r--r--ccss/ccss-selector-group.c8
-rw-r--r--ccss/ccss-style.h4
10 files changed, 23 insertions, 25 deletions
diff --git a/ccss-doc/tmpl/block.sgml b/ccss-doc/tmpl/block.sgml
index 1060128..114c0e9 100644
--- a/ccss-doc/tmpl/block.sgml
+++ b/ccss-doc/tmpl/block.sgml
@@ -30,6 +30,6 @@ ccss_block_t
@self:
@property_name:
-@value:
+@property:
diff --git a/ccss-doc/tmpl/style.sgml b/ccss-doc/tmpl/style.sgml
index fb1eb2c..32b36cc 100644
--- a/ccss-doc/tmpl/style.sgml
+++ b/ccss-doc/tmpl/style.sgml
@@ -49,7 +49,7 @@ ccss_style_t
@self:
@property_name:
-@property:
+@value:
@Returns:
@@ -60,7 +60,7 @@ ccss_style_t
@self:
@property_name:
-@property:
+@value:
<!-- ##### FUNCTION ccss_style_get_string ##### -->
diff --git a/ccss/ccss-block.c b/ccss/ccss-block.c
index 82076b8..e52e7ed 100644
--- a/ccss/ccss-block.c
+++ b/ccss/ccss-block.c
@@ -50,8 +50,8 @@ ccss_block_destroy (ccss_block_t *self)
/**
* ccss_block_add_property:
* @self: a #ccss_block_t.
- * @property_name: the property's name, e.g. `background-color'.
- * @property pointer to the property instance.
+ * @property_name: the property name, e.g. %background-color.
+ * @property: pointer to the property instance.
*
* Adds a property to a CSS block.
**/
diff --git a/ccss/ccss-block.h b/ccss/ccss-block.h
index abc4c4d..1d45d3e 100644
--- a/ccss/ccss-block.h
+++ b/ccss/ccss-block.h
@@ -32,7 +32,7 @@ typedef struct ccss_block_ ccss_block_t;
void
ccss_block_add_property (ccss_block_t *self,
char const *property_name,
- ccss_property_base_t *value);
+ ccss_property_base_t *property);
CCSS_END_DECLS
diff --git a/ccss/ccss-grammar-function.c b/ccss/ccss-grammar-function.c
index b2b2f0f..ed958ec 100644
--- a/ccss/ccss-grammar-function.c
+++ b/ccss/ccss-grammar-function.c
@@ -120,8 +120,8 @@ parse_args_r (GSList *args,
/**
* ccss_grammar_invoke_function:
* @self: a #ccss_grammar_t.
- * @function_name: name of the function to invoke, e.g. `url'.
- * @args: arguments passed to the function handler.
+ * @function_name: name of the function to invoke, e.g. %url.
+ * @values: arguments passed to the function handler.
* @user_data: user-data passed to the function handler.
* Overrides the user-data assigned in the function handler's definition.
*
diff --git a/ccss/ccss-grammar.c b/ccss/ccss-grammar.c
index 3c6e579..2d5a185 100644
--- a/ccss/ccss-grammar.c
+++ b/ccss/ccss-grammar.c
@@ -141,7 +141,7 @@ ccss_grammar_get_reference_count (ccss_grammar_t const *self)
/**
* ccss_grammar_add_properties:
- * @self: a #ccss_grammar_t.
+ * @self: a #ccss_grammar_t.
* @properties: Null-terminated array of #ccss_property_class_t to register.
*
* Register a set of custom CSS properties with the grammar.
@@ -186,6 +186,7 @@ ccss_grammar_lookup_property (ccss_grammar_t const *self,
/**
* ccss_grammar_add_functions:
+ * @self: a #ccss_grammar_t.
* @functions: Null-terminated array of #ccss_function_t to register.
*
* Register a set of custom css function handlers with the grammar.
diff --git a/ccss/ccss-node.h b/ccss/ccss-node.h
index 51f83ca..46b2de0 100644
--- a/ccss/ccss-node.h
+++ b/ccss/ccss-node.h
@@ -33,14 +33,15 @@ typedef struct ccss_node_ ccss_node_t;
/**
* ccss_node_is_a_f:
- * @self: a #ccss_node_t.
+ * @self: a #ccss_node_t.
+ * @type_name: name to match against, e.g. %div.
*
* Hook function to query whether a #ccss_node_t is of a certain type.
*
* Returns: %TRUE if matches.
**/
-typedef bool (*ccss_node_is_a_f) (ccss_node_t const *self,
- char const *type_name);
+typedef bool (*ccss_node_is_a_f) (ccss_node_t const *self,
+ char const *type_name);
/**
* ccss_node_get_container_f:
@@ -145,8 +146,12 @@ typedef const char * (*ccss_node_get_style_f) (ccss_node_t const *self);
* @self: a #ccss_node_t.
* @x: horizontal position.
* @y: vertical position.
+ * @width: width of viewport.
+ * @height: height of viewport.
*
* Hook function to determine the position of a node in the viewport.
+ *
+ * Returns: %TRUE if a valid viewport position has been assigned to the out parameters.
**/
typedef bool (*ccss_node_get_viewport_f) (ccss_node_t const *self,
uint32_t *x, uint32_t *y,
diff --git a/ccss/ccss-property-generic.h b/ccss/ccss-property-generic.h
index 9319b9e..b7b7b2c 100644
--- a/ccss/ccss-property-generic.h
+++ b/ccss/ccss-property-generic.h
@@ -31,9 +31,9 @@ CCSS_BEGIN_DECLS
/**
* ccss_property_generic_t:
- * @state: see #ccss_property_state_t.
- * @type: see #ccss_property_type_t.
- * @content: container for the actual property value.
+ * @base: base property.
+ * @name: name of the property, e.g. %color.
+ * @values: linked list of values.
*
* Implementation of a generic, single-value property.
**/
diff --git a/ccss/ccss-selector-group.c b/ccss/ccss-selector-group.c
index b40d165..31da670 100644
--- a/ccss/ccss-selector-group.c
+++ b/ccss/ccss-selector-group.c
@@ -28,14 +28,6 @@ typedef struct {
GSList *selectors;
} ccss_selector_set_t;
-/**
- * ccss_selector_group_t:
- * @sets:
- * @min_specificity_e:
- * @dangling_selectors:
- *
- * Represents a set of associated styling information.
- **/
struct ccss_selector_group_ {
GTree *sets;
unsigned int n_selectors;
diff --git a/ccss/ccss-style.h b/ccss/ccss-style.h
index 1ea6950..af97a7c 100644
--- a/ccss/ccss-style.h
+++ b/ccss/ccss-style.h
@@ -58,12 +58,12 @@ ccss_style_get_string (ccss_style_t const *self,
bool
ccss_style_get_property (ccss_style_t const *self,
char const *property_name,
- ccss_property_base_t const **property);
+ ccss_property_base_t const **value);
void
ccss_style_set_property (ccss_style_t *self,
char const *property_name,
- ccss_property_base_t const *property);
+ ccss_property_base_t const *value);
bool
ccss_style_interpret_property (ccss_style_t const *self,