JSON: Mention exceptions in docs

[libucw.git] / ucw-json / json.h

diff --git a/ucw-json/json.h b/ucw-json/json.h
index f51dd6a7fe0f506aba60d36ef7b950e0ececa90b..06be568a4003da65366d5dd9d8460888e2d7b4e8 100644 (file)
--- 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. **/