The cl-gendoc Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-gendoc Reference Manual

This is the cl-gendoc Reference Manual, version 1.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:17:22 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-gendoc

This is a simple but flexible modular document generator for Common Lisp, because I couldn't find something similar:

(gendoc (:output-filename "docs.html"
         :css "simple.css")
  (:mdf "intro.md")
  (:mdf "details.md")
  (:apiref :some-package :another-package)
  (:mdf "closing.md"))

Of some interest is probably the API reference generator:

(defun some-function (X)
  "=> output-forms

This takes `X` and produces *output-forms*"
  ...)

The docstring is processed as markdown with 3bmd, optionally specifying a return-spec if the first line starts with "=>".

See the generated documentation for cl-gendoc.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-gendoc

Author

Ryan Pavlik

License

LLGPL, BSD

Description

cl-gendoc: Simple component-based documentation generator

Version

1.0

Dependencies
Source

cl-gendoc.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-gendoc.asd

Location

cl-gendoc.asd

Systems

cl-gendoc (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-gendoc/package.lisp

Parent

cl-gendoc (system)

Location

package.lisp

Packages

gendoc


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-gendoc/gendoc.lisp

Dependency

package.lisp (file)

Parent

cl-gendoc (system)

Location

gendoc.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 gendoc

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: define-gendoc-load-op SYSTEM-NAME PACKAGE-NAME FUNCTION-SYMBOL

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.

Package

gendoc

Source

gendoc.lisp (file)

Macro: gendoc (&key STREAM TITLE CSS PATH OUTPUT-SYSTEM OUTPUT-COMPONENT OUTPUT-FILENAME) &body PARTS

=> 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.

Package

gendoc

Source

gendoc.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: add-processor NAME FUNCTION

Call ‘FUNCTION‘ when the component named ‘NAME‘ is encountered in the gendoc spec.

Package

gendoc

Source

gendoc.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *part-processor*
Package

gendoc

Source

gendoc.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: apiref-doc TYPE SYM
Package

gendoc

Source

gendoc.lisp (file)

Function: apiref-lambda TYPE SYM
Package

gendoc

Source

gendoc.lisp (file)

Function: apiref-result TYPE SYM
Package

gendoc

Source

gendoc.lisp (file)

Function: apiref-section-id SYMBOL
Package

gendoc

Source

gendoc.lisp (file)

Function: apiref-section-symbol STREAM TYPE SYMBOL
Package

gendoc

Source

gendoc.lisp (file)

Function: apiref-spec TYPE SYM
Package

gendoc

Source

gendoc.lisp (file)

Function: apiref-symbols TYPE PACKAGE
Package

gendoc

Source

gendoc.lisp (file)

Function: arglist FUNCTION
Package

gendoc

Source

gendoc.lisp (file)

Function: filename-id FILENAME
Package

gendoc

Source

gendoc.lisp (file)

Function: function-p SYMBOL
Package

gendoc

Source

gendoc.lisp (file)

Function: gen-apiref STREAM PACKAGE
Package

gendoc

Source

gendoc.lisp (file)

Function: macro-p SYMBOL
Package

gendoc

Source

gendoc.lisp (file)

Function: markdown-plain INPUT

Runs ‘input‘ through markdown an removes the enclosing <p> tags.

Package

gendoc

Source

gendoc.lisp (file)

Function: package-section-id PACKAGE SUFFIX
Package

gendoc

Source

gendoc.lisp (file)

Function: process-apiref STREAM NAME PACKAGE-LIST
Package

gendoc

Source

gendoc.lisp (file)

Function: process-markdown-file STREAM NAME PART
Package

gendoc

Source

gendoc.lisp (file)

Function: process-text-file STREAM NAME PART
Package

gendoc

Source

gendoc.lisp (file)

Function: read-all FILE-STREAM
Package

gendoc

Source

gendoc.lisp (file)

Function: special-p SYMBOL
Package

gendoc

Source

gendoc.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-gendoc.asd: The cl-gendoc<dot>asd file
cl-gendoc/gendoc.lisp: The cl-gendoc/gendoc<dot>lisp file
cl-gendoc/package.lisp: The cl-gendoc/package<dot>lisp file

F
File, Lisp, cl-gendoc.asd: The cl-gendoc<dot>asd file
File, Lisp, cl-gendoc/gendoc.lisp: The cl-gendoc/gendoc<dot>lisp file
File, Lisp, cl-gendoc/package.lisp: The cl-gendoc/package<dot>lisp file

L
Lisp File, cl-gendoc.asd: The cl-gendoc<dot>asd file
Lisp File, cl-gendoc/gendoc.lisp: The cl-gendoc/gendoc<dot>lisp file
Lisp File, cl-gendoc/package.lisp: The cl-gendoc/package<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   F   G   M   P   R   S  
Index Entry  Section

A
add-processor: Exported functions
apiref-doc: Internal functions
apiref-lambda: Internal functions
apiref-result: Internal functions
apiref-section-id: Internal functions
apiref-section-symbol: Internal functions
apiref-spec: Internal functions
apiref-symbols: Internal functions
arglist: Internal functions

D
define-gendoc-load-op: Exported macros

F
filename-id: Internal functions
Function, add-processor: Exported functions
Function, apiref-doc: Internal functions
Function, apiref-lambda: Internal functions
Function, apiref-result: Internal functions
Function, apiref-section-id: Internal functions
Function, apiref-section-symbol: Internal functions
Function, apiref-spec: Internal functions
Function, apiref-symbols: Internal functions
Function, arglist: Internal functions
Function, filename-id: Internal functions
Function, function-p: Internal functions
Function, gen-apiref: Internal functions
Function, macro-p: Internal functions
Function, markdown-plain: Internal functions
Function, package-section-id: Internal functions
Function, process-apiref: Internal functions
Function, process-markdown-file: Internal functions
Function, process-text-file: Internal functions
Function, read-all: Internal functions
Function, special-p: Internal functions
function-p: Internal functions

G
gen-apiref: Internal functions
gendoc: Exported macros

M
Macro, define-gendoc-load-op: Exported macros
Macro, gendoc: Exported macros
macro-p: Internal functions
markdown-plain: Internal functions

P
package-section-id: Internal functions
process-apiref: Internal functions
process-markdown-file: Internal functions
process-text-file: Internal functions

R
read-all: Internal functions

S
special-p: Internal functions

Jump to:   A   D   F   G   M   P   R   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*part-processor*: Internal special variables

S
Special Variable, *part-processor*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   G   P   S  
Index Entry  Section

C
cl-gendoc: The cl-gendoc system

G
gendoc: The gendoc package

P
Package, gendoc: The gendoc package

S
System, cl-gendoc: The cl-gendoc system

Jump to:   C   G   P   S