[json-glib] docs: Add JsonBuilder to the API reference



commit 66e5f619d55433985460e8c641beb98e85832451
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Wed Jun 16 12:07:41 2010 +0100

    docs: Add JsonBuilder to the API reference
    
    And silence gtk-doc-scanner by removing an undefined argument from
    json_builder_add_null_value().

 doc/reference/json-glib-docs.xml     |    3 ++-
 doc/reference/json-glib-sections.txt |   32 ++++++++++++++++++++++++++++++++
 doc/reference/json-glib.types        |    2 ++
 json-glib/json-builder.c             |    3 ++-
 4 files changed, 38 insertions(+), 2 deletions(-)
---
diff --git a/doc/reference/json-glib-docs.xml b/doc/reference/json-glib-docs.xml
index 6fa1fe6..ed9da0e 100644
--- a/doc/reference/json-glib-docs.xml
+++ b/doc/reference/json-glib-docs.xml
@@ -15,7 +15,7 @@
     </copyright>
 
     <copyright>
-      <year>2009</year>
+      <year>2009, 2010</year>
       <holder>Intel Corporation</holder>
     </copyright>
 
@@ -107,6 +107,7 @@
     <chapter>
       <title>Generator</title>
       <xi:include href="xml/json-generator.xml"/>
+      <xi:include href="xml/json-builder.xml"/>
     </chapter>
 
   </part>
diff --git a/doc/reference/json-glib-sections.txt b/doc/reference/json-glib-sections.txt
index 951a0e4..7ea4679 100644
--- a/doc/reference/json-glib-sections.txt
+++ b/doc/reference/json-glib-sections.txt
@@ -257,3 +257,35 @@ JSON_VERSION_HEX
 <SUBSECTION>
 JSON_CHECK_VERSION
 </SECTION>
+
+<SECTION>
+<FILE>json-builder</FILE>
+JsonBuilder
+JsonBuilderClass
+json_builder_new
+json_builder_get_root
+json_builder_reset
+<SUBSECTION>
+json_builder_begin_array
+json_builder_end_array
+json_builder_begin_object
+json_builder_set_member_name
+json_builder_end_object
+<SUBSECTION>
+json_builder_add_value
+json_builder_add_int_value
+json_builder_add_double_value
+json_builder_add_boolean_value
+json_builder_add_string_value
+json_builder_add_null_value
+<SUBSECTION Standard>
+JSON_TYPE_BUILDER
+JSON_BUILDER
+JSON_BUILDER_CLASS
+JSON_IS_BUILDER
+JSON_IS_BUILDER_CLASS
+JSON_BUILDER_GET_CLASS
+<SUBSECTION Private>
+JsonBuilderPrivate
+json_builder_get_type
+</SECTION>
diff --git a/doc/reference/json-glib.types b/doc/reference/json-glib.types
index 28cf10b..f4c219a 100644
--- a/doc/reference/json-glib.types
+++ b/doc/reference/json-glib.types
@@ -1,2 +1,4 @@
+#include <json-glib/json-glib.h>
+json_builder_get_type
 json_generator_get_type
 json_parser_get_type
diff --git a/json-glib/json-builder.c b/json-glib/json-builder.c
index ea9bc05..7b9d581 100644
--- a/json-glib/json-builder.c
+++ b/json-glib/json-builder.c
@@ -22,7 +22,9 @@
 
 /**
  * SECTION:json-builder
+ * @Title: JsonBuilder
  * @short_description: Generates JSON trees
+ * @See_Also: JsonGenerator
  *
  * #JsonBuilder provides an object for generating a JSON tree.
  * You can generate only one tree with one #JsonBuilder instance.
@@ -640,7 +642,6 @@ json_builder_add_string_value (JsonBuilder *builder, const gchar *value)
 /**
  * json_builder_add_null_value:
  * @builder: a #JsonBuilder
- * @value: the value of the member or element
  *
  * If called after json_builder_set_member_name(), sets null as member of the
  * most recent opened object, otherwise null is added as element of the most



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