From f09acae8e0d6ceba5d13de75551491835a7e71de Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@openedhand.com>
Date: Mon, 1 Oct 2007 19:49:43 +0100
Subject: Document the new public functions

Now that we moved the constructors and setters for the JSON data types into
the public symbols we need to document them to get back to 100% doc coverage.
---
 json-glib/json-array.c | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'json-glib/json-array.c')

diff --git a/json-glib/json-array.c b/json-glib/json-array.c
index 3de3244..4b17825 100644
--- a/json-glib/json-array.c
+++ b/json-glib/json-array.c
@@ -44,6 +44,13 @@ struct _JsonArray
   volatile gint ref_count;
 };
 
+/**
+ * json_array_new:
+ *
+ * Creates a new #JsonArray.
+ *
+ * Return value: the newly created #JsonArray
+ */
 JsonArray *
 json_array_new (void)
 {
@@ -57,6 +64,14 @@ json_array_new (void)
   return array;
 }
 
+/**
+ * json_array_sized_new:
+ * @n_elements: number of slots to pre-allocate
+ *
+ * Creates a new #JsonArray with @n_elements slots already allocated.
+ *
+ * Return value: the newly created #JsonArray
+ */
 JsonArray *
 json_array_sized_new (guint n_elements)
 {
@@ -185,6 +200,13 @@ json_array_get_length (JsonArray *array)
   return array->elements->len;
 }
 
+/**
+ * json_array_add_element:
+ * @array: a #JsonArray
+ * @node: a #JsonNode
+ *
+ * Appends @node inside @array.
+ */
 void
 json_array_add_element (JsonArray *array,
                         JsonNode  *node)
-- 
cgit v1.2.1