Common Lisp Package: CL-API

Simple API HTML generator.

README:

FUNCTION

Public

API-GEN (PACKAGE DIR-PATHNAME &KEY EXCLUDE-CONST EXCLUDE-VAR EXCLUDE-CLASS EXCLUDE-COND EXCLUDE-FUNC EXCLUDE-MACRO)

Create an html API document of the given PACKAGE. The document will be named with [package-name].html DIR-PATHNAME Is the output directory :EXCLUDE-CONST :EXCLUDE-VAR :EXCLUDE-CLASS :EXCLUDE-COND :EXCLUDE-FUNC :EXCLUDE-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

Private

HT< (NAME ATTRIBUTES &OPTIONAL (STREAM *HTML-OUTPUT*))

- NAME tag name - ATTRIBUTES plist of html tag attributes

HT> (NAME ATTRIBUTES BODY &OPTIONAL (STREAM *HTML-OUTPUT*))

- NAME tag name - ATTRIBUTES plist of html tag attributes - BODY tag body (string or lambda)

Undocumented

DOC-CLASS (SYMBOL CONDITION-P)

DOC-CLASSES (SYMBOLS &OPTIONAL CONDITION-P EXCLUDE-FUNCTION)

DOC-CONSTANTS (SYMBOLS &OPTIONAL EXCLUDE-FUNCTION)

DOC-FUNCTION (SYMBOL &OPTIONAL (SETF-P NIL))

DOC-FUNCTIONS (SYMBOLS &OPTIONAL EXCLUDE-FUNCTION)

DOC-MACRO (SYMBOL)

DOC-MACROS (SYMBOLS &OPTIONAL EXCLUDE-FUNCTION)

DOC-VARIBLES (SYMBOLS &OPTIONAL EXCLUDE-FUNCTION)

DOCUMENT (PACKAGE &KEY EXCLUDE-CONST EXCLUDE-VAR EXCLUDE-CLASS EXCLUDE-COND EXCLUDE-FUNC EXCLUDE-MACRO)

EXTERNAL-P (SYMBOL &OPTIONAL (PACKAGE *CURRENT-PACKAGE*))

HTML-RENDER-CLASSES (ITEMS)

HTML-RENDER-FUNCTIONS (ITEMS)

HTML-RENDER-MACROS (ITEMS)

HTML-RENDER-PACKAGE (PACKAGE)

HTML-RENDER-VARS-AND-CONST (ITEMS &OPTIONAL (TYPE 'VARS))

LAMBDALIST (FUNCTION)

PACKAGE-EXTERNAL-SYMBOLS (PACKAGE)

RENDER-HTML (PACKAGE CONSTANTS VARS CLASSES CONDITIONS FUNCTIONS MACROS)

RENDER-HTML-DOCUMENTATION (ITEM)

RENDER-HTML-SYMBOLNAME (ITEM &OPTIONAL (SYMBOLTYPE NIL))

RENDER-HTML-SYMBOLTYPE (ITEM)

REPLACE<> (STRING)

VARIABLEP (SYMBOL)

MACRO

Private

Undocumented

DEFGENERIC (&WHOLE FORM NAME (&REST ARGS) &BODY OPTIONS)

DEFMETHOD (&WHOLE FORM NAME &BODY BODY &ENVIRONMENT ENV)

VARIABLE

Public

*API-CSS*

Default css for generated HTML document

Private

*CURRENT-PACKAGE*

Current package used during elaboration

Undocumented

*HTML-OUTPUT*

CLASS

Private

Undocumented

STANDARD-GENERIC-FUNCTION