docs/api.lisp @ 2e90748b1555

Stop passing NIL as :hash-function during hash table construction

At least in SBCL 2.0.6, passing :hash-function NIL to make-hash-table causes an
UNDEFINED-FUNCTION error. Since it's unlikely that any other CL implementation
will have useful behavior for an explicit NIL argument that's different from not
passing it at all, it's better to not pass :hash-function if it's set to NIL.
author Jacek TeMPOraL Złydach <temporal.pl@gmail.com>
date Sat, 18 Jul 2020 01:03:54 +0200
parents 412a127b7419
children 7e80eda84170
(ql:quickload "cl-d-api")

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

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
  :cl-digraph
  #p"docs/03-reference.markdown"
  (list "DIGRAPH")
  *header*
  :title "API Reference")

(d-api:generate-documentation
  :cl-digraph.dot
  #p"docs/04-reference-dot.markdown"
  (list "DIGRAPH.DOT")
  "cl-digraph includes support for drawing digraphs with Graphviz using `cl-dot`
  in the `cl-digraphs.dot` system.

  "
  :title "cl-dot Support")