From: Martin Mares <mj@ucw.cz>
Date: Fri, 17 Jul 2015 13:29:55 +0000 (+0200)
Subject: JSON: Mention exceptions in docs
X-Git-Tag: v6.5~9
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=b925cf2d18ece6ef329c6b735c2bfe52bd0e5f94;p=libucw.git

JSON: Mention exceptions in docs
---

diff --git a/ucw-json/json.h b/ucw-json/json.h
index f51dd6a7..06be568a 100644
--- a/ucw-json/json.h
+++ b/ucw-json/json.h
@@ -246,6 +246,10 @@ struct json_node *json_object_get(struct json_node *n, const char *key);
  * and then repeat json_next_token(). If you are parsing huge JSON files,
  * you probably want to do json_push() first, then scan and process some
  * tokens, and then json_pop().
+ *
+ * All parsing functions throw LibUCW exceptions of class `ucw.json.parse`
+ * upon errors. If you want to catch them, call the parser inside
+ * a transaction.
  ***/
 
 /** Parses a JSON file from the given fastbuf stream. **/