#:g1: cl-apiの紹介

Posted 2014-04-12 15:00:00 GMT

(LISP Library 365参加エントリ)

 LISP Library 365 の103日目です。

cl-apiとはなにか

 cl-apiは、Common Lispのドキュメント生成システムです。

パッケージ情報

パッケージ名cl-api
Quicklisp
CLiKihttp://cliki.net/cl-api
Quickdocshttp://quickdocs.org/cl-api

インストール方法

(ql:quickload :cl-api)

試してみる

 どんな関数があるかは、Quickdocsで確認できますが、関数はcl-api:api-genのみです。

 使い方は非常にシンプルで、

(cl-api:api-gen :common-lisp "/tmp/")

のように実行すると、common-lispパッケージのドキュメンテーションが/tmp/common-lisp.htmlという一つのHTMLファイルに書き出されます。

cl-api

 ちなみに、cl-api::doc-classがbuilt-in-classをfinalize-inheritanceしてしまいエラーとなる場合があるので、

(unless (class-finalized-p class) (finalize-inheritance class))

などとしておくと良いのかなと思います〈そもそもbuilt-in-classが来ることを想定してないかも〉。

まとめ

 今回は、cl-apiを紹介してみました。
自作のライブラリのドキュメンテーションの充実具合をさっと眺めるのには良いかなと思います。

comments powered by Disqus