API for package:
cl-api
Simple API HTML generator.
Variables
*api-css*:
"
.package {background: #efefef; padding: 1.5em 0 1em 0; font-size: bigger:x-large; text-align: center; font-size: x-large;}
.definition {background: #efefef; padding: .3em 1em;}
a.symbolname, a:visited.symbolname {font-weight: bold;}
.initargs {font-size: small;}
.slots {font-size: small;}
div.label {border-bottom: 1px solid #efefef; margin-bottom: .5em}
.symboldecl, .footer {margin: 0 2em 2em 2em;}
.symbolname {font-weight: bold; color: gray;}
.symboltype {font-style: italic;margin-left: 1.5em; font-size: smaller;}
.documentation {color: gray; font-family: Fixed,monospace;margin: 0 0 1.5em 0.5em;}
.packagedocumentation {color: gray; font-family: Fixed,monospace;margin: 0 0 1.5em 0; border: 1px solid #efefef; padding-left: 1.5em;}
.symbolcomments span {font-weight: bold;}
.footer {font-size: x-small; text-align: right; margin-top: 2em; padding-top: 1em; border-top: 1px solid gray;}
.undocumented {color: red; font-weight: bold;}
a, a:visited {font-weight: bold; color: gray; text-decoration: none; font-weight: normal;}
a:hover {border-bottom: 1px solid gray; }
.label {font-weight: bold; font-style: italic;color: gray;}
.labeltitle {font-weight: bold; font-style: italic;color: gray; border: 1px solid #efefef; padding: .25em;margin-bottom: .5em}
.frame {marin-top: 1.5em}
.expander {border: 2px solid #efefef; color: gray; font-weight: bold; font-family: Fixed,monospace; margin-right: .25em; padding: 0 .25em;cursor: pointer;}
"
variable
Default css for generated HTML document
Functions
api-gen
package dir-pathname &key fexclude-const fexclude-var fexclude-class fexclude-cond
fexclude-func fexclude-macro
function
Create an html API document of the given PACKAGE.
The document will be named with [package-name].html
DIR-PATHNAME Is the output directory
:FEXCLUDE-CONST :FEXCLUDE-VAR :FEXCLUDE-CLASS :FEXCLUDE-COND :FEXCLUDE-FUNC :FEXCLUDE-MACRO keys may be
valorized with exclusion functions that take as parameter the symbol name.
For example an exclusion key will be somethink like (lambda (s) (string-equal "foo" (symbol-name s)))
that will exclude FOO symbol.
When one of these functions return true the API is not generated for the current symbol