[couchdb-glib] Add CouchdbDocumentInfo API documentation

[Rodrigo Moya <rodrigo src gnome org>]

commit 83680f52004015d983f0446849475ea68290abea
Author: Rodrigo Moya <rodrigo gnome-db org>
Date:   Wed Feb 10 16:31:12 2010 +0100

    Add CouchdbDocumentInfo API documentation

 couchdb-glib/couchdb-document-info.c |   40 ++++++++++++++++++++++++++++++++++
 1 files changed, 40 insertions(+), 0 deletions(-)
---
diff --git a/couchdb-glib/couchdb-document-info.c b/couchdb-glib/couchdb-document-info.c
index 961dc40..c0e284e 100644
--- a/couchdb-glib/couchdb-document-info.c
+++ b/couchdb-glib/couchdb-document-info.c
@@ -47,6 +47,17 @@ couchdb_document_info_get_type (void)
 	return object_type;
 }
 
+/**
+ * couchdb_document_info_new:
+ * @docid: Unique ID of the document
+ * @revision: Current revision of the document
+ *
+ * Create a new #CouchdbDocumentInfo object, which is used to store information
+ * about a document on a CouchDB database. It contains information like the
+ * Unique ID and revision of the document.
+ *
+ * Return value: A newly-created #CouchDocumentInfo object.
+ */
 CouchdbDocumentInfo *
 couchdb_document_info_new (const char *docid, const char *revision)
 {
@@ -60,6 +71,12 @@ couchdb_document_info_new (const char *docid, const char *revision)
 	return doc_info;
 }
 
+/**
+ * couchdb_document_info_ref:
+ * @doc_info: A #CouchdbDocumentInfo object
+ *
+ * Increments reference counting of the given #CouchdbDocument object.
+ */
 CouchdbDocumentInfo *
 couchdb_document_info_ref (CouchdbDocumentInfo *doc_info)
 {
@@ -71,6 +88,13 @@ couchdb_document_info_ref (CouchdbDocumentInfo *doc_info)
 	return doc_info;
 }
 
+/**
+ * couchdb_document_info_unref:
+ * @doc_info: A #CouchdbDocumentInfo object
+ *
+ * Decrements reference counting of the given #CouchdbDocument object.
+ * When the reference count is equal to 0, the object will be destroyed.
+ */
 void
 couchdb_document_info_unref (CouchdbDocumentInfo *doc_info)
 {
@@ -89,6 +113,14 @@ couchdb_document_info_unref (CouchdbDocumentInfo *doc_info)
 	}
 }
 
+/**
+ * couchdb_document_info_get_docid:
+ * @doc_info: A #CouchdbDocumentInfo object
+ *
+ * Get the unique ID stored in the #CouchdbDocumentInfo object.
+ *
+ * Return value: Unique ID stored in the #CouchdbDocumentInfo object.
+ */
 const char *
 couchdb_document_info_get_docid (CouchdbDocumentInfo *doc_info)
 {
@@ -97,6 +129,14 @@ couchdb_document_info_get_docid (CouchdbDocumentInfo *doc_info)
 	return (const char *) doc_info->docid;
 }
 
+/**
+ * couchdb_document_info_get_revision:
+ * @doc_info: A #CouchdbDocumentInfo object
+ *
+ * Get the revision stored in the #CouchdbDocumentInfo object.
+ *
+ * Return value: Revision stored in the #CouchdbDocumentInfo object.
+ */
 const char *
 couchdb_document_info_get_revision (CouchdbDocumentInfo *doc_info)
 {