docs/api.lisp @ c76d55908e2e

Optimize circles a bit

After reviewing some disassembly elsewhere I realized that declaring a function
to return `(values)` and adding that form actually prevents last-call
optimization, at least in SBCL.  It's a cleaner API, but it wastes lots of stack
frames.

Save the frames, kill the `(values)`.
author Steve Losh <steve@stevelosh.com>
date Mon, 11 Jul 2016 19:56:43 +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*)