Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the bytecurry.asdf-ext Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:51:19 2018 GMT+0.
| • Introduction: | What bytecurry.asdf-ext is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
ASDF extensions
Some ASDF extensions. At the moment there are two packages:
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The bytecurry.asdf-ext system: | ||
| • The bytecurry.asdf-ext/interface system: | ||
| • The bytecurry.asdf-ext/atdoc system: | ||
| • The bytecurry.asdf-ext/doc-op system: |
Next: The bytecurry<dot>asdf-ext/interface system, Previous: Systems, Up: Systems [Contents][Index]
Thayne McCombs
Thayne McCombs
MIT
ASDF extension(s) for generating atdoc documentation.
asdf-package-system
bytecurry.asdf-ext/interface (system)
bytecurry.asdf-ext.asd (file)
Next: The bytecurry<dot>asdf-ext/atdoc system, Previous: The bytecurry<dot>asdf-ext system, Up: Systems [Contents][Index]
bytecurry.asdf-ext.asd (file)
lisp.lisp (file)
Next: The bytecurry<dot>asdf-ext/doc-op system, Previous: The bytecurry<dot>asdf-ext/interface system, Up: Systems [Contents][Index]
bytecurry.asdf-ext.asd (file)
lisp.lisp (file)
Previous: The bytecurry<dot>asdf-ext/atdoc system, Up: Systems [Contents][Index]
asdf
bytecurry.asdf-ext.asd (file)
lisp.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The bytecurry.asdf-ext.asd file: | ||
| • The bytecurry.asdf-ext/interface/lisp.lisp file: | ||
| • The bytecurry.asdf-ext/atdoc/lisp.lisp file: | ||
| • The bytecurry.asdf-ext/doc-op/lisp.lisp file: |
Next: The bytecurry<dot>asdf-ext/interface/lisp<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
bytecurry.asdf-ext.asd
Next: The bytecurry<dot>asdf-ext/atdoc/lisp<dot>lisp file, Previous: The bytecurry<dot>asdf-ext<dot>asd file, Up: Lisp files [Contents][Index]
bytecurry.asdf-ext/interface (system)
interface.lisp
Next: The bytecurry<dot>asdf-ext/doc-op/lisp<dot>lisp file, Previous: The bytecurry<dot>asdf-ext/interface/lisp<dot>lisp file, Up: Lisp files [Contents][Index]
bytecurry.asdf-ext/atdoc (system)
atdoc.lisp
Previous: The bytecurry<dot>asdf-ext/atdoc/lisp<dot>lisp file, Up: Lisp files [Contents][Index]
bytecurry.asdf-ext/doc-op (system)
doc-op.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The bytecurry.asdf-ext/interface package: | ||
| • The bytecurry.asdf-ext/atdoc package: | ||
| • The bytecurry.asdf-ext/doc-op package: |
Next: The bytecurry<dot>asdf-ext/atdoc package, Previous: Packages, Up: Packages [Contents][Index]
lisp.lisp (file)
bytecurry.asdf-ext
Next: The bytecurry<dot>asdf-ext/doc-op package, Previous: The bytecurry<dot>asdf-ext/interface package, Up: Packages [Contents][Index]
lisp.lisp (file)
Previous: The bytecurry<dot>asdf-ext/atdoc package, Up: Packages [Contents][Index]
lisp.lisp (file)
asdf-doc-op
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions: | ||
| • Exported classes: |
Next: Exported classes, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Shorthand for ‘(asdf:operate ’asdf:doc-op system)’ see OPERATE for details.
lisp.lisp (file)
Previous: Exported functions, Up: Exported definitions [Contents][Index]
Operation to create atdoc documentation for a system.
lisp.lisp (file)
child-component (class)
atdoc-html (class)
:packages
atdoc-packages (generic function)
(setf atdoc-packages) (generic function)
:title
Component to generate HTML documentation with atdoc.
lisp.lisp (file)
atdoc-docs (class)
boolean
:single-page-p
This is used for the css argument to @code{generate-html-documentation}.
It can be a symbol, string, or pathname.
If it is a symbol, then the downcased name of symbol will name be used as the name of a
stylesheet in the css directory of the atdoc installation. Otherwise, the the path is resolved
relative to the path of the parent component (usually the system) with a type of "css".
In the latter case path resolution works the same way as for other source files.
(or symbol string pathname)
:css
:default
boolean
:include-slot-definitions
boolean
:include-internal-symbols-p
t
lisp.lisp (file)
:class
(quote asdf/lisp-action:load-op)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions: | ||
| • Internal generic functions: |
Next: Internal generic functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Get the title to use for the atdoc documentations.
lisp.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | B F L |
|---|
| Jump to: | B F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
A D F G M |
|---|
| Jump to: | (
A D F G M |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | C I P S T |
|---|
| Jump to: | C I P S T |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | A B C D P S |
|---|
| Jump to: | A B C D P S |
|---|