Complete API reference of JSON-GLib

With this commit, we reach 100% coverage.

2 files changed, 39 insertions, 0 deletions

diff --git a/json-glib/json-parser.h b/json-glib/json-parser.h
index 9c9afb7..5dfc9e1 100644
--- a/json-glib/json-parser.h
+++ b/json-glib/json-parser.h
@@ -37,6 +37,13 @@ typedef struct _JsonParser              JsonParser;
 typedef struct _JsonParserPrivate       JsonParserPrivate;
 typedef struct _JsonParserClass         JsonParserClass;
 
+/**
+ * JsonParserError:
+ * @JSON_PARSER_ERROR_PARSE: parse error
+ * @JSON_PARSER_ERROR_UNKNOWN: unknown error
+ *
+ * Error enumeration for #JsonParser
+ */
 typedef enum {
   JSON_PARSER_ERROR_PARSE,
   
@@ -51,6 +58,12 @@ typedef enum {
   JSON_TOKEN_LAST
 } JsonTokenType;
 
+/**
+ * JsonParser:
+ * 
+ * JSON data streams parser. The contents of the #JsonParser structure are
+ * private and should only be accessed via the provided API.
+ */
 struct _JsonParser
 {
   /*< private >*/
@@ -59,6 +72,12 @@ struct _JsonParser
   JsonParserPrivate *priv;
 };
 
+/**
+ * JsonParserClass:
+ * @error: signal class handler for the JsonParser::error signal
+ *
+ * #JsonParser class.
+ */
 struct _JsonParserClass
 {
   /*< private >*/
diff --git a/json-glib/json-types.h b/json-glib/json-types.h
index 9578b1c..4663967 100644
--- a/json-glib/json-types.h
+++ b/json-glib/json-types.h
@@ -24,12 +24,32 @@
 
 G_BEGIN_DECLS
 
+/**
+ * JSON_NODE_TYPE:
+ * @node: a #JsonNode
+ *
+ * Evaluates to the #JsonNodeType contained by @node
+ */
 #define JSON_NODE_TYPE(node)    (((JsonNode *) (node))->type)
 #define JSON_TYPE_OBJECT        (json_object_get_type ())
 #define JSON_TYPE_ARRAY         (json_array_get_type ())
 
+/**
+ * JsonObject:
+ *
+ * A JSON object type. The contents of the #JsonObject structure are private
+ * and should only be accessed by the provided API
+ */
 typedef struct _JsonObject      JsonObject;
+
+/**
+ * JsonArray:
+ *
+ * A JSON array type. The contents of the #JsonArray structure are private
+ * and should only be accessed by the provided API
+ */
 typedef struct _JsonArray       JsonArray;
+
 typedef struct _JsonNode        JsonNode;
 
 /**