docs/api.lisp @ 859a6c1314d3

Add a few comments and a pair of utility functions for the WAM heap
author Steve Losh <steve@stevelosh.com>
date Sat, 26 Mar 2016 12:21:56 +0000
parents 9d90efbd8787
children 19200659513a
(ql:quickload "cl-d-api")

(defparameter *document-packages*
  (list "BONES.PAIP"))

(defparameter *output-path*
  #p"docs/03-reference.markdown" )

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

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
  :bones
  *output-path*
  *document-packages*
  *header*)