Clack.Util.Doc

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 "

EXTERNAL SYMBOLS

Variable: *section-plist*

Function: 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.

Function: doc [header &optional (string ) (level 1)]
```
  Set documentation to current package
```
Function: section [header &optional (string ) (level 1)]
Function: name [string]
Function: synopsis [string]
Function: explanation [string]
Function: dependencies [string]
Function: description [string]
Function: example [string]
Function: see [string]
Function: author [string]
Function: contributors [string]
Function: copyright [string]
Function: license [string]

Clack.Util.Doc - For writing Clack documentations.

SYNOPSIS

DESCRIPTION

AUTHOR

SEE ALSO

EXTERNAL SYMBOLS