Hacky documentation updates
Changes
--- a/.hgignore Tue Aug 25 00:08:28 2020 -0400
+++ b/.hgignore Fri Aug 28 00:24:06 2020 -0400
@@ -2,4 +2,5 @@
scratch.lisp
*.png
+*.svg
docs/build
--- a/README.markdown Tue Aug 25 00:08:28 2020 -0400
+++ b/README.markdown Fri Aug 28 00:24:06 2020 -0400
@@ -1,8 +1,4 @@
-Not ready yet, clone at your own risk
-=====================================
-
-Jarl
-=====
+**Not ready yet, clone at your own risk**
JSON (Another Reimplementation) in Lisp.
--- a/docs/01-usage.markdown Tue Aug 25 00:08:28 2020 -0400
+++ b/docs/01-usage.markdown Fri Aug 28 00:24:06 2020 -0400
@@ -3,5 +3,7 @@
Jarl is yet another JSON library for Common Lisp.
+[![error class hierarchy](../static/errors.svg)](../static/errors.svg)
+
[TOC]
--- a/docs/02-reference.markdown Tue Aug 25 00:08:28 2020 -0400
+++ b/docs/02-reference.markdown Fri Aug 28 00:24:06 2020 -0400
@@ -12,11 +12,13 @@
## Package `JARL`
-### `PRINT-JSON` (function)
+### `JSON-PARSING-ERROR` (class)
- (PRINT-JSON OBJECT &OPTIONAL (STREAM *STANDARD-OUTPUT*))
+### `PRINT` (function)
-### `READ-JSON` (function)
+ (PRINT OBJECT &OPTIONAL (STREAM *STANDARD-OUTPUT*))
- (READ-JSON &OPTIONAL (STREAM-OR-STRING *STANDARD-INPUT*) (EOF-ERROR-P T) EOF-VALUE)
+### `READ` (function)
+ (READ CLASS-DESIGNATOR STREAM-OR-STRING &OPTIONAL (EOF-ERROR-P T) EOF)
+
--- a/docs/api.lisp Tue Aug 25 00:08:28 2020 -0400
+++ b/docs/api.lisp Fri Aug 28 00:24:06 2020 -0400
@@ -18,3 +18,14 @@
*header*
:title "API Reference")
+(d-api:draw-class-hierarchy
+ "docs/static/errors.svg"
+ '(jarl::json-error
+ jarl::json-parsing-error
+ jarl::json-limit-exceeded-error
+ jarl::json-size-limit-exceeded-error
+ jarl::json-depth-limit-exceeded-error)
+ :abstract-classes
+ '(jarl::json-error
+ jarl::json-limit-exceeded-error))
+