This is the cl-gendoc Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:14:22 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-gendoccl-gendoc: Simple component-based documentation generator
Ryan Pavlik
LLGPL, BSD
1.0
sb-introspect (system).
cl-who (system).
3bmd (system).
3bmd-ext-code-blocks (system).
package.lisp (file).
gendoc.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-gendoc/gendoc.lisppackage.lisp (file).
cl-gendoc (system).
add-processor (function).
define-gendoc-load-op (macro).
gendoc (macro).
*part-processor* (special variable).
apiref-doc (function).
apiref-lambda (function).
apiref-result (function).
apiref-section-id (function).
apiref-section-symbol (function).
apiref-spec (function).
apiref-symbols (function).
arglist (function).
filename-id (function).
function-p (function).
gen-apiref (function).
generic-function-p (function).
macro-p (function).
markdown-plain (function).
package-section-id (function).
process-apiref (function).
process-markdown-file (function).
process-text-file (function).
read-all (function).
special-p (function).
Packages are listed by definition order.
gendoccommon-lisp.
add-processor (function).
define-gendoc-load-op (macro).
gendoc (macro).
*part-processor* (special variable).
apiref-doc (function).
apiref-lambda (function).
apiref-result (function).
apiref-section-id (function).
apiref-section-symbol (function).
apiref-spec (function).
apiref-symbols (function).
arglist (function).
filename-id (function).
function-p (function).
gen-apiref (function).
generic-function-p (function).
macro-p (function).
markdown-plain (function).
package-section-id (function).
process-apiref (function).
process-markdown-file (function).
process-text-file (function).
read-all (function).
special-p (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define ‘PERFORM‘ and ‘OPERATION-DONE-P‘ for ‘ASDF:LOAD-OP‘ for the system
‘SYSTEM-NAME‘, causing ‘LOAD-OP‘ to always call ‘FUNCTION-SYMBOL‘ in the
package ‘PACKAGE-NAME‘.
For this to be useful, the specified function should call ‘GENDOC‘ to actually generate documentation.
=> string or no values
Generate documentation based on ‘PARTS‘. Each part is processed in order
and the output is written to ‘STREAM‘, or, if specified, ‘OUTPUT-FILE‘ is
overwritten (‘:if-exists :supersede‘).
‘TITLE‘ and ‘CSS‘ specify their HTML counterparts.
‘OUTPUT-SYSTEM‘ and ‘OUTPUT-COMPONENT‘ may be specified; if so, they are
consulted to set ‘*DEFAULT-PATHNAME-DEFAULTS*‘, and files are read from
and written to this location.
‘PATH‘ may be specified instead or along with ‘OUTPUT-SYSTEM‘ and ‘OUTPUT-COMPONENT‘; if both are specified, ‘PATH‘ overrides.
Call ‘FUNCTION‘ when the component named ‘NAME‘ is encountered in the gendoc spec.
Runs ‘input‘ through markdown an removes the enclosing <p> tags.
| Jump to: | A D F G M P R S |
|---|
| Jump to: | A D F G M P R S |
|---|
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*part-processor*: | Private special variables | ||
| | |||
| S | |||
Special Variable, *part-processor*: | Private special variables | ||
| | |||
| Jump to: | *
S |
|---|
| Jump to: | C F G P S |
|---|
| Jump to: | C F G P S |
|---|