docs/api.lisp @ 04933ed07596

Clean up slot option and class option coalescence
author Steve Losh <steve@stevelosh.com>
date Tue, 15 Dec 2020 00:03:48 -0500
parents 37efd8463e96
children (none)
(ql:quickload "cl-d-api")

(defparameter *header*
  "The following is a list of all user-facing parts of Jarl.

If there are backwards-incompatible changes to anything listed here, they will
be noted in the changelog and the author will feel bad.

Anything not listed here is subject to change at any time with no warning, so
don't touch it.

")

(d-api:generate-documentation
  :jarl
  #p"docs/02-reference.markdown"
  (list "JARL")
  *header*
  :title "API Reference")

(d-api:draw-class-hierarchy
  "docs/static/errors.svg"
  '(jarl::json-error
    jarl::json-reading-error
    jarl::malformed-json-error
    jarl::unknown-json-slot-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-reading-error
    jarl::json-limit-exceeded-error))