summaryrefslogtreecommitdiff
path: root/json-glib/json-parser.c
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@openedhand.com>2007-10-01 16:16:15 +0100
committerEmmanuele Bassi <ebassi@openedhand.com>2007-10-01 16:16:15 +0100
commit29feafc236f888021b817fdfe0cfe685f5e3b65e (patch)
treebc3931f2746d66cf23c4692a3d56d54c6e8cee0c /json-glib/json-parser.c
parent6eb1a5e94957d3555e7de5f6744a8777cd89efaf (diff)
downloadjson-glib-29feafc236f888021b817fdfe0cfe685f5e3b65e.tar.gz
Add licensing informations to the source code
Diffstat (limited to 'json-glib/json-parser.c')
-rw-r--r--json-glib/json-parser.c28
1 files changed, 26 insertions, 2 deletions
diff --git a/json-glib/json-parser.c b/json-glib/json-parser.c
index 51f23e1..2a4aab6 100644
--- a/json-glib/json-parser.c
+++ b/json-glib/json-parser.c
@@ -1,7 +1,28 @@
+/* json-parser.c - JSON streams parser
+ *
+ * This file is part of JSON-GLib
+ * Copyright (C) 2007 OpenedHand Ltd.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * Author:
+ * Emmanuele Bassi <ebassi@openedhand.com>
+ */
+
/**
* SECTION:json-parser
* @short_description: Parse JSON data streams
*
+ * #JsonParser provides an object for parsing a JSON data stream, either
+ * inside a file or inside a static buffer.
*/
#include "config.h"
@@ -586,7 +607,8 @@ json_parser_new (void)
* @filename: the path for the file to parse
* @error: return location for a #GError, or %NULL
*
- * Loads a JSON stream from the content of @filename and parses it.
+ * Loads a JSON stream from the content of @filename and parses it. See
+ * json_parser_load_from_data().
*
* Return value: %TRUE if the file was successfully loaded and parsed.
* In case of error, @error is set accordingly and %FALSE is returned
@@ -629,7 +651,9 @@ json_parser_load_from_file (JsonParser *parser,
* @length: the length of the buffer, or -1
* @error: return location for a #GError, or %NULL
*
- * Loads a JSON stream from a buffer and parses it.
+ * Loads a JSON stream from a buffer and parses it. You can call this function
+ * multiple times with the same #JsonParser object, but the contents of the
+ * parser will be destroyed each time.
*
* Return value: %TRUE if the buffer was succesfully parser. In case
* of error, @error is set accordingly and %FALSE is returned