The atdoc Reference Manual

This is the atdoc Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 03:21:51 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 atdoc

Dependencies
  • cxml (system).
  • split-sequence (system).
  • swank (system).
  • xuriella (system).
  • closer-mop (system).
  • cl-ppcre (system).
Source

atdoc.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 atdoc/atdoc.asd

Source

atdoc.asd.

Parent Component

atdoc (system).

ASDF Systems

atdoc.

Packages

atdoc-system.

Public Interface

perform (method).

Internals

atdoc-source-file (class).


3.1.2 atdoc/package.lisp

Source

atdoc.asd.

Parent Component

atdoc (system).

Packages

atdoc.


3.1.3 atdoc/atdoc.lisp

Dependency

package.lisp (file).

Source

atdoc.asd.

Parent Component

atdoc (system).

Public Interface
Internals

3.1.4 atdoc/info.lisp

Dependency

atdoc.lisp (file).

Source

atdoc.asd.

Parent Component

atdoc (system).

Public Interface

generate-info-documentation (function).

Internals

4 Packages

Packages are listed by definition order.


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

Use List

common-lisp.

Public Interface
Internals

4.2 atdoc-system

Source

atdoc.asd.

Use List
  • asdf/interface.
  • common-lisp.
Internals

atdoc-source-file (class).


5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary 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.

Function: generate-documentation (&rest args)

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

Package

atdoc.

Source

atdoc.lisp.

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.

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.

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.


5.1.2 Standalone methods

Method: characters ((handler docstring-parser) data)
Package

sax.

Source

atdoc.lisp.

Method: end-element ((handler docstring-parser) uri lname qname)
Package

sax.

Source

atdoc.lisp.

Method: perform :around ((o compile-op) (s atdoc-source-file))
Package

asdf/action.

Source

atdoc.asd.

Method: start-element ((handler docstring-parser) uri lname qname attrs)
Package

sax.

Source

atdoc.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *include-slot-definitions-p*
Package

atdoc.

Source

atdoc.lisp.

Special Variable: *stylesheets*
Package

atdoc.

Source

atdoc.lisp.


5.2.2 Ordinary functions

Function: apply-stylesheet-chain (input stylesheets output)
Package

atdoc.

Source

atdoc.lisp.

Function: characters (handler str)
Package

atdoc.

Source

atdoc.lisp.

Function: copy-file (a b &key if-exists)
Package

atdoc.

Source

atdoc.lisp.

Function: emit-class (class other-packages)
Package

atdoc.

Source

atdoc.lisp.

Function: emit-docstring (package-designator str)
Package

atdoc.

Source

atdoc.lisp.

Function: emit-function (name)
Package

atdoc.

Source

atdoc.lisp.

Function: emit-macro (name)
Package

atdoc.

Source

atdoc.lisp.

Function: emit-package (package other-packages)
Package

atdoc.

Source

atdoc.lisp.

Function: emit-slot (slot-def)
Package

atdoc.

Source

atdoc.lisp.

Function: emit-type (name)
Package

atdoc.

Source

atdoc.lisp.

Function: emit-variable (name)
Package

atdoc.

Source

atdoc.lisp.

Function: find-stylesheet (namestring)
Package

atdoc.

Source

atdoc.lisp.

Function: flush-cache ()
Package

atdoc.

Source

atdoc.lisp.

Function: function-arglist (fun)
Package

atdoc.

Source

atdoc.lisp.

Function: good-symbol-p (symbol other-packages)
Package

atdoc.

Source

atdoc.lisp.

Function: grovel-stylesheet-dependencies (namestring)
Package

atdoc.

Source

atdoc.lisp.

Function: magic-namestring (file)
Package

atdoc.

Source

atdoc.lisp.

Function: munge-name (name kind)
Package

atdoc.

Source

atdoc.lisp.

Function: name (name kind)
Package

atdoc.

Source

atdoc.lisp.

Function: parse-docstring (str handler)
Package

atdoc.

Source

atdoc.lisp.

Function: parse-docstring-1 (stream handler close)
Package

atdoc.

Source

atdoc.lisp.

Function: parse-docstring-element (stream handler name)
Package

atdoc.

Source

atdoc.lisp.

Function: random-name (name other-packages kind)
Package

atdoc.

Source

atdoc.lisp.

Function: read-delimited-string (stream bag &optional eat-limit)
Package

atdoc.

Source

atdoc.lisp.

Function: run-shell-command (directory output command &rest args)
Package

atdoc.

Source

atdoc.lisp.

Function: symbol-status (symbol)
Package

atdoc.

Source

atdoc.lisp.

Function: unexported-name (name)
Package

atdoc.

Source

atdoc.lisp.

Function: xfd-base-uri (thunks-1)
Package

atdoc.

Source

atdoc.lisp.

Function: xfd-date (thunks-1)
Package

atdoc.

Source

info.lisp.

Function: xfd-escape-latex-string (thunks-1)
Package

atdoc.

Source

atdoc.lisp.

Function: xfd-indent (thunks-1)
Package

atdoc.

Source

info.lisp.

Function: xfd-stars (thunks-1)
Package

atdoc.

Source

info.lisp.


5.2.3 Generic functions

Generic Reader: current-attributes (object)
Package

atdoc.

Methods
Reader Method: current-attributes ((docstring-parser docstring-parser))

automatically generated reader method

Source

atdoc.lisp.

Target Slot

current-attributes.

Generic Writer: (setf current-attributes) (object)
Package

atdoc.

Methods
Writer Method: (setf current-attributes) ((docstring-parser docstring-parser))

automatically generated writer method

Source

atdoc.lisp.

Target Slot

current-attributes.

Generic Reader: current-kind (object)
Package

atdoc.

Methods
Reader Method: current-kind ((docstring-parser docstring-parser))

automatically generated reader method

Source

atdoc.lisp.

Target Slot

current-kind.

Generic Writer: (setf current-kind) (object)
Package

atdoc.

Methods
Writer Method: (setf current-kind) ((docstring-parser docstring-parser))

automatically generated writer method

Source

atdoc.lisp.

Target Slot

current-kind.

Generic Reader: current-name (object)
Package

atdoc.

Methods
Reader Method: current-name ((docstring-parser docstring-parser))

automatically generated reader method

Source

atdoc.lisp.

Target Slot

current-name.

Generic Writer: (setf current-name) (object)
Package

atdoc.

Methods
Writer Method: (setf current-name) ((docstring-parser docstring-parser))

automatically generated writer method

Source

atdoc.lisp.

Target Slot

current-name.

Generic Reader: current-text (object)
Package

atdoc.

Methods
Reader Method: current-text ((docstring-parser docstring-parser))

automatically generated reader method

Source

atdoc.lisp.

Target Slot

current-text.

Generic Writer: (setf current-text) (object)
Package

atdoc.

Methods
Writer Method: (setf current-text) ((docstring-parser docstring-parser))

automatically generated writer method

Source

atdoc.lisp.

Target Slot

current-text.

Generic Reader: docstring-package (object)
Package

atdoc.

Methods
Reader Method: docstring-package ((docstring-parser docstring-parser))

automatically generated reader method

Source

atdoc.lisp.

Target Slot

docstring-package.

Generic Writer: (setf docstring-package) (object)
Package

atdoc.

Methods
Writer Method: (setf docstring-package) ((docstring-parser docstring-parser))

automatically generated writer method

Source

atdoc.lisp.

Target Slot

docstring-package.


5.2.4 Classes

Class: atdoc-source-file
Package

atdoc-system.

Source

atdoc.asd.

Direct superclasses

cl-source-file.

Direct methods

perform.

Class: docstring-parser
Package

atdoc.

Source

atdoc.lisp.

Direct superclasses

sax-proxy.

Direct methods
Direct slots
Slot: docstring-package
Initargs

:docstring-package

Readers

docstring-package.

Writers

(setf docstring-package).

Slot: current-name
Readers

current-name.

Writers

(setf current-name).

Slot: current-kind
Readers

current-kind.

Writers

(setf current-kind).

Slot: current-attributes
Readers

current-attributes.

Writers

(setf current-attributes).

Slot: current-text
Readers

current-text.

Writers

(setf current-text).


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

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

A
apply-stylesheet-chain: Private ordinary functions

C
characters: Public standalone methods
characters: Private ordinary functions
copy-file: Private ordinary functions
current-attributes: Private generic functions
current-attributes: Private generic functions
current-kind: Private generic functions
current-kind: Private generic functions
current-name: Private generic functions
current-name: Private generic functions
current-text: Private generic functions
current-text: Private generic functions

D
docstring-package: Private generic functions
docstring-package: Private generic functions

E
emit-class: Private ordinary functions
emit-docstring: Private ordinary functions
emit-function: Private ordinary functions
emit-macro: Private ordinary functions
emit-package: Private ordinary functions
emit-slot: Private ordinary functions
emit-type: Private ordinary functions
emit-variable: Private ordinary functions
end-element: Public standalone methods
extract-documentation: Public ordinary functions

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

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

M
magic-namestring: Private ordinary functions
Method, (setf current-attributes): Private generic functions
Method, (setf current-kind): Private generic functions
Method, (setf current-name): Private generic functions
Method, (setf current-text): Private generic functions
Method, (setf docstring-package): Private generic functions
Method, characters: Public standalone methods
Method, current-attributes: Private generic functions
Method, current-kind: Private generic functions
Method, current-name: Private generic functions
Method, current-text: Private generic functions
Method, docstring-package: Private generic functions
Method, end-element: Public standalone methods
Method, perform: Public standalone methods
Method, start-element: Public standalone methods
munge-name: Private ordinary functions

N
name: Private ordinary functions

P
parse-docstring: Private ordinary functions
parse-docstring-1: Private ordinary functions
parse-docstring-element: Private ordinary functions
perform: Public standalone methods

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

S
start-element: Public standalone methods
symbol-status: Private ordinary functions

U
unexported-name: Private ordinary functions

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