Common Lisp Package: CLACK.UTIL.DOC

# Clack.Util.Doc - For writing Clack documentations. ## SYNOPSIS ;; Clear documentation of `*package*'. (doc:start) (doc:NAME " Clack - Web Application Environment for Common Lisp ") (doc:DESCRIPTION " Clack is a Web Application Environment for Common Lisp inspired by Python's WSGI and Ruby's Rack. Your awesome framework should base on this. ") ;; I recommend to use with cl-annot (https://github.com/arielnetworks/cl-annot). ;; It allows you to write docs by annotation-style. (cl-annot:enable-annot-syntax) (doc:start) @doc:NAME " Clack - Web Application Environment for Common Lisp " ## DESCRIPTION Clack.Util.Doc enables easy writing package documentations with Markdown. ## AUTHOR * Eitarow Fukamachi (e.arrows@gmail.com) ## SEE ALSO * [cl-annot](https://github.com/arielnetworks/cl-annot)

README:

FUNCTION

Public

DOC (HEADER &OPTIONAL (STRING ) (LEVEL 1))

Set documentation to current package

START

Clear the docstring of `*package*'. I recommend you to put `(doc:start)' before calling doc functions, because they append sections duplicately when the packaged is reloaded.

Undocumented

AUTHOR (STRING)

CONTRIBUTORS (STRING)

DEPENDENCIES (STRING)

DESCRIPTION (STRING)

EXAMPLE (STRING)

EXPLANATION (STRING)

LICENSE (STRING)

NAME (STRING)

SECTION (HEADER &OPTIONAL (STRING ) (LEVEL 1))

SEE (STRING)

SYNOPSIS (STRING)