This is the atdoc Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:38:34 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
atdoccxml (system).
split-sequence (system).
swank (system).
xuriella (system).
closer-mop (system).
cl-ppcre (system).
package.lisp (file).
atdoc.lisp (file).
info.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
atdoc/atdoc.asdatdoc (system).
perform (method).
atdoc-source-file (class).
atdoc/atdoc.lisppackage.lisp (file).
atdoc (system).
characters (method).
end-element (method).
extract-documentation (function).
generate-documentation (function).
generate-html-documentation (function).
generate-latex-documentation (function).
start-element (method).
*include-slot-definitions-p* (special variable).
*stylesheets* (special variable).
apply-stylesheet-chain (function).
characters (function).
copy-file (function).
current-attributes (reader method).
(setf current-attributes) (writer method).
current-kind (reader method).
(setf current-kind) (writer method).
current-name (reader method).
(setf current-name) (writer method).
current-text (reader method).
(setf current-text) (writer method).
docstring-package (reader method).
(setf docstring-package) (writer method).
docstring-parser (class).
emit-class (function).
emit-docstring (function).
emit-function (function).
emit-macro (function).
emit-package (function).
emit-slot (function).
emit-type (function).
emit-variable (function).
find-stylesheet (function).
flush-cache (function).
function-arglist (function).
good-symbol-p (function).
grovel-stylesheet-dependencies (function).
magic-namestring (function).
munge-name (function).
name (function).
parse-docstring (function).
parse-docstring-1 (function).
parse-docstring-element (function).
random-name (function).
read-delimited-string (function).
run-shell-command (function).
symbol-status (function).
unexported-name (function).
xfd-base-uri (function).
xfd-escape-latex-string (function).
atdoc/info.lispatdoc.lisp (file).
atdoc (system).
generate-info-documentation (function).
xfd-date (function).
xfd-indent (function).
xfd-stars (function).
Packages are listed by definition order.
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}
common-lisp.
extract-documentation (function).
generate-documentation (function).
generate-html-documentation (function).
generate-info-documentation (function).
generate-latex-documentation (function).
*include-slot-definitions-p* (special variable).
*stylesheets* (special variable).
apply-stylesheet-chain (function).
characters (function).
copy-file (function).
current-attributes (generic reader).
(setf current-attributes) (generic writer).
current-kind (generic reader).
(setf current-kind) (generic writer).
current-name (generic reader).
(setf current-name) (generic writer).
current-text (generic reader).
(setf current-text) (generic writer).
docstring-package (generic reader).
(setf docstring-package) (generic writer).
docstring-parser (class).
emit-class (function).
emit-docstring (function).
emit-function (function).
emit-macro (function).
emit-package (function).
emit-slot (function).
emit-type (function).
emit-variable (function).
find-stylesheet (function).
flush-cache (function).
function-arglist (function).
good-symbol-p (function).
grovel-stylesheet-dependencies (function).
magic-namestring (function).
munge-name (function).
name (function).
parse-docstring (function).
parse-docstring-1 (function).
parse-docstring-element (function).
random-name (function).
read-delimited-string (function).
run-shell-command (function).
symbol-status (function).
unexported-name (function).
xfd-base-uri (function).
xfd-date (function).
xfd-escape-latex-string (function).
xfd-indent (function).
xfd-stars (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
@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.
A deprecated alias for @fun{generate-html-documentation}.
@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.
@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.
@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.
docstring-parser) data) ¶sax.
docstring-parser) uri lname qname) ¶sax.
compile-op) (s atdoc-source-file)) ¶asdf/action.
docstring-parser) uri lname qname attrs) ¶sax.
docstring-parser)) ¶automatically generated reader method
docstring-parser)) ¶automatically generated writer method
docstring-parser)) ¶automatically generated reader method
docstring-parser)) ¶automatically generated writer method
docstring-parser)) ¶automatically generated reader method
docstring-parser)) ¶automatically generated writer method
docstring-parser)) ¶automatically generated reader method
docstring-parser)) ¶automatically generated writer method
docstring-parser)) ¶automatically generated reader method
docstring-parser)) ¶automatically generated writer method
cl-source-file.
| Jump to: | (
A C D E F G M N P R S U X |
|---|
| Jump to: | (
A C D E F G M N P R S U X |
|---|
| Jump to: | *
C D S |
|---|
| Jump to: | *
C D S |
|---|
| Jump to: | A C D F I P S |
|---|
| Jump to: | A C D F I P S |
|---|