The atdoc Reference Manual

Table of Contents

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

The atdoc Reference Manual

This is the atdoc Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 02:56:27 2018 GMT+0.


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

1 Introduction


   atdoc: HTML documentation generation

   Atdoc generates documentation for Common Lisp packages. It extracts
   documention strings written using a custom markup language and
   generates HTML pages.

   atdoc was written by David Lichteblau and is available under an
   X11-style license.


Installation

   atdoc needs Closure XML, Split sequence, Slime's swank,
   Xuriella XSLT, Closer MOP, and their dependencies.

   ASDF is used for compilation. Register the .asd file, e.g. by
   symlinking it, then compile atdoc using asdf:operate.

$ ln -sf `pwd`/atdoc.asd /path/to/your/registry/
* (asdf:operate 'asdf:load-op :atdoc)


Documentation

   Please refer to the HTML documentation in doc/.


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 atdoc

Dependencies
Source

atdoc.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 atdoc.asd

Location

atdoc.asd

Systems

atdoc (system)

Packages

atdoc-system

Internal Definitions

atdoc-source-file (class)


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

3.1.2 atdoc/package.lisp

Parent

atdoc (system)

Location

package.lisp

Packages

atdoc


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

3.1.3 atdoc/atdoc.lisp

Dependency

package.lisp (file)

Parent

atdoc (system)

Location

atdoc.lisp

Exported Definitions
Internal Definitions

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

3.1.4 atdoc/info.lisp

Dependency

atdoc.lisp (file)

Parent

atdoc (system)

Location

info.lisp

Exported Definitions

generate-info-documentation (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 atdoc-system

Source

atdoc.asd

Use List
Internal Definitions

atdoc-source-file (class)


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

4.2 atdoc

@a[http://www.lichteblau.com/atdoc/]{Atdoc}
generates documentation for Common Lisp packages.

It extracts documention strings
written using a custom markup language and generates HTML pages or TeX documents.

@begin[Generating formatted documentation]{section}
Separate functions are offered for each output format:
HTML pages, LaTeX/PDF output, and .info files. There is also an older function called generate-documentation, which in now an alias for generate-html-documentation.

@aboutfun{generate-html-documentation} @aboutfun{generate-latex-documentation} @aboutfun{generate-info-documentation} @aboutfun{generate-documentation}
@end{section}

@begin[Generating unformatted XML]{section}
Power users might want to extract docstrings into XML and then send that XML through their own XSLT stylesheets. The following function can be used for that purpose.

@aboutfun{extract-documentation}
@end{section}

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


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

5.1.1 Functions

Function: extract-documentation PACKAGES DIRECTORY &rest KEYS &key INCLUDE-SLOT-DEFINITIONS-P &allow-other-keys

@arg[packages]{List of package designators.
Documentation will be generated for these packages.} @arg[directory]{A pathname specifying a directory.
The output file will be written to this directory, which must already exist.}
@arg[include-slot-definitions-p]{A boolean.}
@arg[keys]{Extra parameters for stylesheets.}
Extracts docstrings from @code{packages} and writes them in XML syntax to .atdoc.xml in the specified directory.

With @code{include-slot-definitions-p}, class documentation will include a list of direct slots.

Extra parameters will be inserted as attributes on the root element.

Package

atdoc

Source

atdoc.lisp (file)

Function: generate-documentation &rest ARGS

A deprecated alias for @fun{generate-html-documentation}.

Package

atdoc

Source

atdoc.lisp (file)

Function: generate-html-documentation PACKAGES DIRECTORY &key INDEX-TITLE HEADING CSS LOGO SINGLE-PAGE-P INCLUDE-SLOT-DEFINITIONS-P INCLUDE-INTERNAL-SYMBOLS-P

@arg[packages]{List of package designators.
Documentation will be generated for these packages.} @arg[directory]{A pathname specifying a directory.
All output files and temporary data will be written
to this directory, which must already exist.}
@arg[index-title]{This string will be
used as the title of the main page, index.html.
(Other pages will be named according to the object they are documenting.)}
@arg[heading]{This string will be used as a visible title on top of every page.}
@arg[logo]{Deprecated.}
@arg[css]{A pathname or string pointing to a cascading stylesheet (CSS) file. This file will be copied to the target directory under the name index.css. If this argument is a string and does not start with a dot, it will be taken as namestring relative to the atdoc/css directory.} @arg[single-page-p]{A boolean.}
@arg[include-slot-definitions-p]{A boolean.} @arg[include-internal-symbols-p]{A boolean.}
@return{The pathname of the generated file index.xml.}
Generates HTML documentation for @code{packages}.

With @code{single-page-p}, all documentation is assembled as a single page called index.html. Otherwise, index.html will include only
a symbol index and a summary of each package, with links to other pages.

With include-slot-definitions-p, pages for symbols that are not exported will be included, so that documentation for exported symbols can safely refer to internal pages (but internal symbols will not be included in the symbol index automatically). This option has no effect if single-page-p is enabled.

With @code{include-slot-definition}, class documentation will include
a list of direct slots.

Package

atdoc

Source

atdoc.lisp (file)

Function: generate-info-documentation PACKAGES DIRECTORY &key NAME TITLE INCLUDE-SLOT-DEFINITIONS-P

@arg[packages]{List of package designators.
Documentation will be generated for these packages.} @arg[directory]{A pathname specifying a directory.
All output files and temporary data will be written
to this directory, which must already exist.}
@arg[title]{This string will be used as the document’s title.} @arg[include-slot-definitions-p]{A boolean.}
@return{The pathname of the generated file documentation.pdf, or nil.} Generates TeX documentation for @code{packages}.

With @code{run-tex-p} (the default), pdflatex is run automatically to generate a PDF file.

With @code{include-slot-definition}, class documentation will include a list of direct slots.

Package

atdoc

Source

info.lisp (file)

Function: generate-latex-documentation PACKAGES DIRECTORY &key TITLE RUN-TEX-P INCLUDE-SLOT-DEFINITIONS-P

@arg[packages]{List of package designators.
Documentation will be generated for these packages.} @arg[directory]{A pathname specifying a directory.
All output files and temporary data will be written
to this directory, which must already exist.}
@arg[title]{This string will be used as the document’s title.} @arg[include-slot-definitions-p]{A boolean.}
@arg[run-tex-p]{A boolean.}
@return{The pathname of the generated file documentation.pdf, or nil.} Generates TeX documentation for @code{packages}.

With @code{run-tex-p} (the default), pdflatex is run automatically to generate a PDF file.

With @code{include-slot-definition}, class documentation will include a list of direct slots.

Package

atdoc

Source

atdoc.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: *include-slot-definitions-p*
Package

atdoc

Source

atdoc.lisp (file)

Special Variable: *stylesheets*
Package

atdoc

Source

atdoc.lisp (file)


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

5.2.2 Functions

Function: apply-stylesheet-chain INPUT STYLESHEETS OUTPUT
Package

atdoc

Source

atdoc.lisp (file)

Function: characters HANDLER STR
Package

atdoc

Source

atdoc.lisp (file)

Function: copy-file A B &key IF-EXISTS
Package

atdoc

Source

atdoc.lisp (file)

Function: emit-class CLASS OTHER-PACKAGES
Package

atdoc

Source

atdoc.lisp (file)

Function: emit-docstring PACKAGE-DESIGNATOR STR
Package

atdoc

Source

atdoc.lisp (file)

Function: emit-function NAME
Package

atdoc

Source

atdoc.lisp (file)

Function: emit-macro NAME
Package

atdoc

Source

atdoc.lisp (file)

Function: emit-package PACKAGE OTHER-PACKAGES
Package

atdoc

Source

atdoc.lisp (file)

Function: emit-slot SLOT-DEF
Package

atdoc

Source

atdoc.lisp (file)

Function: emit-type NAME
Package

atdoc

Source

atdoc.lisp (file)

Function: emit-variable NAME
Package

atdoc

Source

atdoc.lisp (file)

Function: find-stylesheet NAMESTRING
Package

atdoc

Source

atdoc.lisp (file)

Function: flush-cache ()
Package

atdoc

Source

atdoc.lisp (file)

Function: function-arglist FUN
Package

atdoc

Source

atdoc.lisp (file)

Function: good-symbol-p SYMBOL OTHER-PACKAGES
Package

atdoc

Source

atdoc.lisp (file)

Function: grovel-stylesheet-dependencies NAMESTRING
Package

atdoc

Source

atdoc.lisp (file)

Function: magic-namestring FILE
Package

atdoc

Source

atdoc.lisp (file)

Function: munge-name NAME KIND
Package

atdoc

Source

atdoc.lisp (file)

Function: name NAME KIND
Package

atdoc

Source

atdoc.lisp (file)

Function: parse-docstring STR HANDLER
Package

atdoc

Source

atdoc.lisp (file)

Function: parse-docstring-1 STREAM HANDLER CLOSE
Package

atdoc

Source

atdoc.lisp (file)

Function: parse-docstring-element STREAM HANDLER NAME
Package

atdoc

Source

atdoc.lisp (file)

Function: random-name NAME OTHER-PACKAGES KIND
Package

atdoc

Source

atdoc.lisp (file)

Function: read-delimited-string STREAM BAG &optional EAT-LIMIT
Package

atdoc

Source

atdoc.lisp (file)

Function: run-shell-command DIRECTORY OUTPUT COMMAND &rest ARGS
Package

atdoc

Source

atdoc.lisp (file)

Function: symbol-status SYMBOL
Package

atdoc

Source

atdoc.lisp (file)

Function: unexported-name NAME
Package

atdoc

Source

atdoc.lisp (file)

Function: xfd-base-uri THUNKS-1
Package

atdoc

Source

atdoc.lisp (file)

Function: xfd-date THUNKS-1
Package

atdoc

Source

info.lisp (file)

Function: xfd-escape-latex-string THUNKS-1
Package

atdoc

Source

atdoc.lisp (file)

Function: xfd-indent THUNKS-1
Package

atdoc

Source

info.lisp (file)

Function: xfd-stars THUNKS-1
Package

atdoc

Source

info.lisp (file)


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

5.2.3 Generic functions

Generic Function: current-attributes OBJECT
Generic Function: (setf current-attributes) NEW-VALUE OBJECT
Package

atdoc

Methods
Method: current-attributes (DOCSTRING-PARSER docstring-parser)

automatically generated reader method

Source

atdoc.lisp (file)

Method: (setf current-attributes) NEW-VALUE (DOCSTRING-PARSER docstring-parser)

automatically generated writer method

Source

atdoc.lisp (file)

Generic Function: current-kind OBJECT
Generic Function: (setf current-kind) NEW-VALUE OBJECT
Package

atdoc

Methods
Method: current-kind (DOCSTRING-PARSER docstring-parser)

automatically generated reader method

Source

atdoc.lisp (file)

Method: (setf current-kind) NEW-VALUE (DOCSTRING-PARSER docstring-parser)

automatically generated writer method

Source

atdoc.lisp (file)

Generic Function: current-name OBJECT
Generic Function: (setf current-name) NEW-VALUE OBJECT
Package

atdoc

Methods
Method: current-name (DOCSTRING-PARSER docstring-parser)

automatically generated reader method

Source

atdoc.lisp (file)

Method: (setf current-name) NEW-VALUE (DOCSTRING-PARSER docstring-parser)

automatically generated writer method

Source

atdoc.lisp (file)

Generic Function: current-text OBJECT
Generic Function: (setf current-text) NEW-VALUE OBJECT
Package

atdoc

Methods
Method: current-text (DOCSTRING-PARSER docstring-parser)

automatically generated reader method

Source

atdoc.lisp (file)

Method: (setf current-text) NEW-VALUE (DOCSTRING-PARSER docstring-parser)

automatically generated writer method

Source

atdoc.lisp (file)

Generic Function: docstring-package OBJECT
Generic Function: (setf docstring-package) NEW-VALUE OBJECT
Package

atdoc

Methods
Method: docstring-package (DOCSTRING-PARSER docstring-parser)

automatically generated reader method

Source

atdoc.lisp (file)

Method: (setf docstring-package) NEW-VALUE (DOCSTRING-PARSER docstring-parser)

automatically generated writer method

Source

atdoc.lisp (file)


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

5.2.4 Classes

Class: atdoc-source-file ()
Package

atdoc-system

Source

atdoc.asd

Direct superclasses

cl-source-file (class)

Direct methods

perform (method)

Class: docstring-parser ()
Package

atdoc

Source

atdoc.lisp (file)

Direct superclasses

sax-proxy (class)

Direct methods
Direct slots
Slot: docstring-package
Initargs

:docstring-package

Readers

docstring-package (generic function)

Writers

(setf docstring-package) (generic function)

Slot: current-name
Readers

current-name (generic function)

Writers

(setf current-name) (generic function)

Slot: current-kind
Readers

current-kind (generic function)

Writers

(setf current-kind) (generic function)

Slot: current-attributes
Readers

current-attributes (generic function)

Writers

(setf current-attributes) (generic function)

Slot: current-text
Readers

current-text (generic function)

Writers

(setf current-text) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   A   F   L  
Index Entry  Section

A
atdoc.asd: The atdoc<dot>asd file
atdoc/atdoc.lisp: The atdoc/atdoc<dot>lisp file
atdoc/info.lisp: The atdoc/info<dot>lisp file
atdoc/package.lisp: The atdoc/package<dot>lisp file

F
File, Lisp, atdoc.asd: The atdoc<dot>asd file
File, Lisp, atdoc/atdoc.lisp: The atdoc/atdoc<dot>lisp file
File, Lisp, atdoc/info.lisp: The atdoc/info<dot>lisp file
File, Lisp, atdoc/package.lisp: The atdoc/package<dot>lisp file

L
Lisp File, atdoc.asd: The atdoc<dot>asd file
Lisp File, atdoc/atdoc.lisp: The atdoc/atdoc<dot>lisp file
Lisp File, atdoc/info.lisp: The atdoc/info<dot>lisp file
Lisp File, atdoc/package.lisp: The atdoc/package<dot>lisp file

Jump to:   A   F   L  

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

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   M   N   P   R   S   U   X  
Index Entry  Section

(
(setf current-attributes): Internal generic functions
(setf current-attributes): Internal generic functions
(setf current-kind): Internal generic functions
(setf current-kind): Internal generic functions
(setf current-name): Internal generic functions
(setf current-name): Internal generic functions
(setf current-text): Internal generic functions
(setf current-text): Internal generic functions
(setf docstring-package): Internal generic functions
(setf docstring-package): Internal generic functions

A
apply-stylesheet-chain: Internal functions

C
characters: Internal functions
copy-file: Internal functions
current-attributes: Internal generic functions
current-attributes: Internal generic functions
current-kind: Internal generic functions
current-kind: Internal generic functions
current-name: Internal generic functions
current-name: Internal generic functions
current-text: Internal generic functions
current-text: Internal generic functions

D
docstring-package: Internal generic functions
docstring-package: Internal generic functions

E
emit-class: Internal functions
emit-docstring: Internal functions
emit-function: Internal functions
emit-macro: Internal functions
emit-package: Internal functions
emit-slot: Internal functions
emit-type: Internal functions
emit-variable: Internal functions
extract-documentation: Exported functions

F
find-stylesheet: Internal functions
flush-cache: Internal functions
Function, apply-stylesheet-chain: Internal functions
Function, characters: Internal functions
Function, copy-file: Internal functions
Function, emit-class: Internal functions
Function, emit-docstring: Internal functions
Function, emit-function: Internal functions
Function, emit-macro: Internal functions
Function, emit-package: Internal functions
Function, emit-slot: Internal functions
Function, emit-type: Internal functions
Function, emit-variable: Internal functions
Function, extract-documentation: Exported functions
Function, find-stylesheet: Internal functions
Function, flush-cache: Internal functions
Function, function-arglist: Internal functions
Function, generate-documentation: Exported functions
Function, generate-html-documentation: Exported functions
Function, generate-info-documentation: Exported functions
Function, generate-latex-documentation: Exported functions
Function, good-symbol-p: Internal functions
Function, grovel-stylesheet-dependencies: Internal functions
Function, magic-namestring: Internal functions
Function, munge-name: Internal functions
Function, name: Internal functions
Function, parse-docstring: Internal functions
Function, parse-docstring-1: Internal functions
Function, parse-docstring-element: Internal functions
Function, random-name: Internal functions
Function, read-delimited-string: Internal functions
Function, run-shell-command: Internal functions
Function, symbol-status: Internal functions
Function, unexported-name: Internal functions
Function, xfd-base-uri: Internal functions
Function, xfd-date: Internal functions
Function, xfd-escape-latex-string: Internal functions
Function, xfd-indent: Internal functions
Function, xfd-stars: Internal functions
function-arglist: Internal functions

G
generate-documentation: Exported functions
generate-html-documentation: Exported functions
generate-info-documentation: Exported functions
generate-latex-documentation: Exported functions
Generic Function, (setf current-attributes): Internal generic functions
Generic Function, (setf current-kind): Internal generic functions
Generic Function, (setf current-name): Internal generic functions
Generic Function, (setf current-text): Internal generic functions
Generic Function, (setf docstring-package): Internal generic functions
Generic Function, current-attributes: Internal generic functions
Generic Function, current-kind: Internal generic functions
Generic Function, current-name: Internal generic functions
Generic Function, current-text: Internal generic functions
Generic Function, docstring-package: Internal generic functions
good-symbol-p: Internal functions
grovel-stylesheet-dependencies: Internal functions

M
magic-namestring: Internal functions
Method, (setf current-attributes): Internal generic functions
Method, (setf current-kind): Internal generic functions
Method, (setf current-name): Internal generic functions
Method, (setf current-text): Internal generic functions
Method, (setf docstring-package): Internal generic functions
Method, current-attributes: Internal generic functions
Method, current-kind: Internal generic functions
Method, current-name: Internal generic functions
Method, current-text: Internal generic functions
Method, docstring-package: Internal generic functions
munge-name: Internal functions

N
name: Internal functions

P
parse-docstring: Internal functions
parse-docstring-1: Internal functions
parse-docstring-element: Internal functions

R
random-name: Internal functions
read-delimited-string: Internal functions
run-shell-command: Internal functions

S
symbol-status: Internal functions

U
unexported-name: Internal functions

X
xfd-base-uri: Internal functions
xfd-date: Internal functions
xfd-escape-latex-string: Internal functions
xfd-indent: Internal functions
xfd-stars: Internal functions

Jump to:   (  
A   C   D   E   F   G   M   N   P   R   S   U   X  

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

A.3 Variables

Jump to:   *  
C   D   S  
Index Entry  Section

*
*include-slot-definitions-p*: Internal special variables
*stylesheets*: Internal special variables

C
current-attributes: Internal classes
current-kind: Internal classes
current-name: Internal classes
current-text: Internal classes

D
docstring-package: Internal classes

S
Slot, current-attributes: Internal classes
Slot, current-kind: Internal classes
Slot, current-name: Internal classes
Slot, current-text: Internal classes
Slot, docstring-package: Internal classes
Special Variable, *include-slot-definitions-p*: Internal special variables
Special Variable, *stylesheets*: Internal special variables

Jump to:   *  
C   D   S  

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

A.4 Data types

Jump to:   A   C   D   P   S  
Index Entry  Section

A
atdoc: The atdoc system
atdoc: The atdoc package
atdoc-source-file: Internal classes
atdoc-system: The atdoc-system package

C
Class, atdoc-source-file: Internal classes
Class, docstring-parser: Internal classes

D
docstring-parser: Internal classes

P
Package, atdoc: The atdoc package
Package, atdoc-system: The atdoc-system package

S
System, atdoc: The atdoc system

Jump to:   A   C   D   P   S