[aravis/dom] introspection: warning fixes.



commit 6a7773131091eefdbd0978bba02910082ba4efc3
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Fri Mar 2 17:44:47 2012 +0100

    introspection: warning fixes.

 src/arvdomdocument.c       |   62 ++++++++++++++++++++++++++++++++++++++-----
 src/arvdomimplementation.c |   10 +++++++
 src/arvdomnamednodemap.c   |   37 ++++++++++++++++++++++++-
 src/arvdomnode.c           |   52 ++++++++++++++++++++++++++++++++++++
 src/arvdomnodelist.c       |   10 +++++++
 src/arvgcpropertynode.c    |    7 +++++
 6 files changed, 168 insertions(+), 10 deletions(-)
---
diff --git a/src/arvdomdocument.c b/src/arvdomdocument.c
index 215a23e..426f010 100644
--- a/src/arvdomdocument.c
+++ b/src/arvdomdocument.c
@@ -52,6 +52,13 @@ arv_dom_document_get_node_type (ArvDomNode *node)
 
 /* ArvDomDocument implementation */
 
+/**
+ * arv_dom_document_get_document_element:
+ * @self: a #ArvDomDocument
+ *
+ * Returns: (transfer none): the top element of @self.
+ */
+
 ArvDomElement *
 arv_dom_document_get_document_element (ArvDomDocument *self)
 {
@@ -60,34 +67,62 @@ arv_dom_document_get_document_element (ArvDomDocument *self)
 	return ARV_DOM_ELEMENT (arv_dom_node_get_first_child (ARV_DOM_NODE (self)));
 }
 
+/**
+ * arv_dom_document_create_element:
+ * @self: a #ArvDomDocument
+ * @tag_name: node name of the element to create
+ *
+ * Create a new element.
+ *
+ * Returns: (transfer full): a new orphan #ArvDomElement, NULL on error.
+ */
+
 ArvDomElement *
-arv_dom_document_create_element (ArvDomDocument *document, const char *tag_name)
+arv_dom_document_create_element (ArvDomDocument *self, const char *tag_name)
 {
 	ArvDomDocumentClass *document_class;
 
-	g_return_val_if_fail (ARV_IS_DOM_DOCUMENT (document), NULL);
+	g_return_val_if_fail (ARV_IS_DOM_DOCUMENT (self), NULL);
 
-	document_class = ARV_DOM_DOCUMENT_GET_CLASS (document);
+	document_class = ARV_DOM_DOCUMENT_GET_CLASS (self);
 	if (document_class->create_element != NULL)
-		return document_class->create_element (document, tag_name);
+		return document_class->create_element (self, tag_name);
 
 	return NULL;
 }
 
-ArvDomText *
+static ArvDomText *
 arv_dom_document_create_text_node_base (ArvDomDocument *document, const char *data)
 {
 	return ARV_DOM_TEXT (arv_dom_text_new (data));
 }
 
+/**
+ * arv_dom_document_create_text_node:
+ * @self: a #ArvDomDocument
+ * @data: initial content
+ *
+ * Create a new text element.
+ *
+ * Returns: (transfer full): a new orphan #ArvDomText, NULL on error.
+ */
+
 ArvDomText *
-arv_dom_document_create_text_node (ArvDomDocument *document, const char *data)
+arv_dom_document_create_text_node (ArvDomDocument *self, const char *data)
 {
-	g_return_val_if_fail (ARV_IS_DOM_DOCUMENT (document), NULL);
+	g_return_val_if_fail (ARV_IS_DOM_DOCUMENT (self), NULL);
 
-	return ARV_DOM_DOCUMENT_GET_CLASS (document)->create_text_node (document, data);
+	return ARV_DOM_DOCUMENT_GET_CLASS (self)->create_text_node (self, data);
 }
 
+/**
+ * arv_dom_document_get_element_by_id:
+ * @self: a #ArvDomDocument
+ * @id: xml:id of the wanted element
+ *
+ * Returns: (transfer none): the element wich has id as xml:id attribute.
+ */
+
 ArvDomElement *
 arv_dom_document_get_element_by_id (ArvDomDocument *self, const char *id)
 {
@@ -157,6 +192,17 @@ arv_dom_document_set_url (ArvDomDocument *self, const char *url)
 	self->url = g_strdup (url);
 }
 
+/**
+ * arv_dom_document_get_href_data:
+ * @self: a #ArvDomDocument
+ * @href: document reference
+ * @size: data size placeholder
+ *
+ * Load the content referenced by @href.
+ *
+ * Returns: (transfer full): a newly allocated data buffer.
+ */
+
 void *
 arv_dom_document_get_href_data (ArvDomDocument *self, const char *href, gsize *size)
 {
diff --git a/src/arvdomimplementation.c b/src/arvdomimplementation.c
index d8dcc48..772600f 100644
--- a/src/arvdomimplementation.c
+++ b/src/arvdomimplementation.c
@@ -43,6 +43,16 @@ arv_dom_implementation_add_document_type (const char *qualified_name,
 	g_hash_table_insert (document_types, g_strdup (qualified_name), document_type_ptr);
 }
 
+/**
+ * arv_dom_implementation_create_document:
+ * @namespace_uri: namespace URI
+ * @qualified_name: qualified name
+ *
+ * Create a new DOM document. Currently, only @qualified_name is used.
+ *
+ * Returns: (transfer full): a new #ArvDomDocument, NULL on error:
+ */
+
 ArvDomDocument *
 arv_dom_implementation_create_document (const char *namespace_uri,
 					const char *qualified_name)
diff --git a/src/arvdomnamednodemap.c b/src/arvdomnamednodemap.c
index 179ec1d..b688b7e 100644
--- a/src/arvdomnamednodemap.c
+++ b/src/arvdomnamednodemap.c
@@ -26,6 +26,15 @@
 
 /* ArvDomNamedNodeMap implementation */
 
+
+/**
+ * arv_dom_named_node_map_get_named_item:
+ * @map: a #ArvDomNamedNodeMap
+ * @name: name of the element to look for.
+ *
+ * Returns: (transfer none): a #ArvDomElement.
+ */
+
 ArvDomNode *
 arv_dom_named_node_map_get_named_item (ArvDomNamedNodeMap *map, const char *name)
 {
@@ -34,14 +43,30 @@ arv_dom_named_node_map_get_named_item (ArvDomNamedNodeMap *map, const char *name
 	return ARV_DOM_NAMED_NODE_MAP_GET_CLASS (map)->get (map, name);
 }
 
+/**
+ * arv_dom_named_node_map_set_named_item:
+ * @map: a #ArvDomNamedNodeMap
+ * @item: a node to insert
+ *
+ * Returns: (transfer none): same as @node on success.
+ */
+
 ArvDomNode *
-arv_dom_named_node_map_set_named_item (ArvDomNamedNodeMap *map, ArvDomNode *node)
+arv_dom_named_node_map_set_named_item (ArvDomNamedNodeMap *map, ArvDomNode *item)
 {
 	g_return_val_if_fail (ARV_IS_DOM_NAMED_NODE_MAP (map), NULL);
 
-	return ARV_DOM_NAMED_NODE_MAP_GET_CLASS (map)->set (map, node);
+	return ARV_DOM_NAMED_NODE_MAP_GET_CLASS (map)->set (map, item);
 }
 
+/**
+ * arv_dom_named_node_map_remove_named_item:
+ * @map: a #ArvDomNamedNodeMap
+ * @name: name of the node to remove
+ *
+ * Returns: (transfer none): the removed node.
+ */
+
 ArvDomNode *
 arv_dom_named_node_map_remove_named_item (ArvDomNamedNodeMap *map, const char *name)
 {
@@ -50,6 +75,14 @@ arv_dom_named_node_map_remove_named_item (ArvDomNamedNodeMap *map, const char *n
 	return ARV_DOM_NAMED_NODE_MAP_GET_CLASS (map)->remove (map, name);
 }
 
+/**
+ * arv_dom_named_node_map_get_item:
+ * @map: a #ArvDomNamedNodeMap
+ * @index: an index
+ *
+ * Returns: (transfer none): the @ArvDomNode corresponding to @index.
+ */
+
 ArvDomNode *
 arv_dom_named_node_map_get_item (ArvDomNamedNodeMap *map, unsigned int index)
 {
diff --git a/src/arvdomnode.c b/src/arvdomnode.c
index 64fbe39..ef02193 100644
--- a/src/arvdomnode.c
+++ b/src/arvdomnode.c
@@ -222,6 +222,15 @@ ArvDomNodeType arv_dom_node_get_node_type (ArvDomNode* self)
 	return 0;
 }
 
+/**
+ * arv_dom_node_get_parent_node:
+ * @self: a #ArvDomNode
+ *
+ * Get the parent node of @self.
+ *
+ * Returns: (transfer none): @self parent.
+ */
+
 ArvDomNode*
 arv_dom_node_get_parent_node (ArvDomNode* self)
 {
@@ -230,6 +239,13 @@ arv_dom_node_get_parent_node (ArvDomNode* self)
 	return self->parent_node;
 }
 
+/**
+ * arv_dom_node_get_child_nodes:
+ * @self: a #ArvDomNode
+ *
+ * Returns: (transfer none): a #ArvDomNodeList, NULL on error.
+ */
+
 ArvDomNodeList*
 arv_dom_node_get_child_nodes (ArvDomNode* self)
 {
@@ -247,6 +263,13 @@ arv_dom_node_get_child_nodes (ArvDomNode* self)
 	return list;
 }
 
+/**
+ * arv_dom_node_get_first_child:
+ * @self: a #ArvDomNode
+ *
+ * Returns: (transfer none): @self first child.
+ */
+
 ArvDomNode*
 arv_dom_node_get_first_child (ArvDomNode* self)
 {
@@ -255,6 +278,13 @@ arv_dom_node_get_first_child (ArvDomNode* self)
 	return self->first_child;
 }
 
+/**
+ * arv_dom_node_get_last_child:
+ * @self: a #ArvDomNode
+ *
+ * Returns: (transfer none): @self last child.
+ */
+
 ArvDomNode*
 arv_dom_node_get_last_child (ArvDomNode* self)
 {
@@ -263,6 +293,13 @@ arv_dom_node_get_last_child (ArvDomNode* self)
 	return self->last_child;
 }
 
+/**
+ * arv_dom_node_get_previous_sibling:
+ * @self: a #ArvDomNode
+ *
+ * Returns: (transfer none): @self previous sibling.
+ */
+
 ArvDomNode*
 arv_dom_node_get_previous_sibling (ArvDomNode* self)
 {
@@ -271,6 +308,13 @@ arv_dom_node_get_previous_sibling (ArvDomNode* self)
 	return self->previous_sibling;
 }
 
+/**
+ * arv_dom_node_get_next_sibling:
+ * @self: a #ArvDomNode
+ *
+ * Returns: (transfer none): @self next sibling.
+ */
+
 ArvDomNode*
 arv_dom_node_get_next_sibling (ArvDomNode* self)
 {
@@ -285,6 +329,14 @@ arv_dom_node_get_next_sibling (ArvDomNode* self)
 /*        return ARV_DOM_NODE_GET_CLASS (self)->get_attributes (self);*/
 /*}*/
 
+
+/**
+ * arv_dom_node_get_owner_document:
+ * @self: a #ArvDomNode
+ *
+ * Returns: (transfer none): @self owner document.
+ */
+
 ArvDomDocument*
 arv_dom_node_get_owner_document (ArvDomNode* self)
 {
diff --git a/src/arvdomnodelist.c b/src/arvdomnodelist.c
index 59da58c..3968f72 100644
--- a/src/arvdomnodelist.c
+++ b/src/arvdomnodelist.c
@@ -26,6 +26,16 @@
 
 /* ArvDomNodeList implementation */
 
+/**
+ * arv_dom_node_list_get_item:
+ * @list: a #ArvDomNodeList
+ * @index: item index
+ *
+ * Get one of the item of @list.
+ *
+ * Returns: (transfer none): item corresponding to index, NULL on error.
+ */
+
 ArvDomNode *
 arv_dom_node_list_get_item (ArvDomNodeList *list, unsigned int index)
 {
diff --git a/src/arvgcpropertynode.c b/src/arvgcpropertynode.c
index 0a1714b..7b105aa 100644
--- a/src/arvgcpropertynode.c
+++ b/src/arvgcpropertynode.c
@@ -356,6 +356,13 @@ arv_gc_property_node_get_node_type (ArvGcPropertyNode *node)
 	return node->type;
 }
 
+/**
+ * arv_gc_property_node_get_linked_node:
+ * @node: a #ArvGcPropertyNode
+ *
+ * Returns: (transfer none): the #ArvGcNode which @node points to.
+ */
+
 ArvGcNode *
 arv_gc_property_node_get_linked_node (ArvGcPropertyNode *node)
 {



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