docs/api.lisp @ 8e500ea0d9ff

Add :allow-print and :allow-read

These can be useful to restrict reading/printing to make sure
you don't accidentally serialize the wrong thing and send an
internal data structure out over the wire.
author Steve Losh <steve@stevelosh.com>
date Tue, 18 Aug 2020 21:50:45 -0400
parents a2712b3d3b16
children 6d74e7ab0fc0
(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")