This is the adp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 03:13:38 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
adp
Add Documentation, Please. A Common Lisp semi-automatic documentation generator and literate programming tool with Scribble files and @-syntax support.
Héctor Galbis Sanchis
MIT
scribble
(system).
alexandria
(system).
package.lisp
(file).
adp.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
adp/adp.lisp
adp
(system).
*adp*
(special variable).
define-adp-file
(macro).
define-adp-operation
(macro).
export-content
(generic function).
file-component
(reader method).
file-elements
(reader method).
operation-done-p
(method).
operation-done-p
(method).
perform
(method).
perform
(method).
perform
(method).
perform
(method).
perform
(method).
perform
(method).
perform
(method).
perform
(method).
post-process-file
(generic function).
post-process-system
(generic function).
pre-process-file
(generic function).
pre-process-system
(generic function).
scribble
(class).
*current-content-file*
(special variable).
*files*
(special variable).
add-element
(macro).
add-file
(function).
adp-op
(class).
current-file-add-element
(function).
destroy-files-container
(function).
file
(class).
file-add-element
(function).
get-load-operation
(generic function).
get-package-and-stream
(function).
make-files-container
(function).
prepare-adp-op
(class).
read-sheat-syntax
(function).
reexport
(function).
scribble-package
(generic function).
scribble-source-file
(class).
with-package-and-stream
(macro).
Packages are listed by definition order.
adp
common-lisp
.
*adp*
(special variable).
define-adp-file
(macro).
define-adp-operation
(macro).
export-content
(generic function).
file-component
(generic reader).
file-elements
(generic reader).
post-process-file
(generic function).
post-process-system
(generic function).
pre-process-file
(generic function).
pre-process-system
(generic function).
scribble
(class).
*current-content-file*
(special variable).
*files*
(special variable).
add-element
(macro).
add-file
(function).
adp-op
(class).
current-file-add-element
(function).
destroy-files-container
(function).
file
(class).
file-add-element
(function).
get-load-operation
(generic function).
get-package-and-stream
(function).
make-files-container
(function).
prepare-adp-op
(class).
read-sheat-syntax
(function).
reexport
(function).
scribble-package
(generic function).
scribble-source-file
(class).
with-package-and-stream
(macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Indicates whether adp is generating documentation.
Exports the files gathered by ADP.
prepare-adp-op
) (c component
)) ¶We can’t know if output files has been modified or removed. So, operation must always be done.
asdf/action
.
adp-op
) (c component
)) ¶We can’t know if output files has been modified or removed. So, operation must always be done.
asdf/action
.
prepare-adp-op
) (s system
)) ¶asdf/action
.
prepare-adp-op
) (c component
)) ¶asdf/action
.
adp-op
) (c scribble-source-file
)) ¶asdf/action
.
load-op
) (c scribble-source-file
)) ¶asdf/action
.
compile-op
) (c scribble-source-file
)) ¶asdf/action
.
The current content file where the elements must be added. Used while loading a common lisp source file.
A container with all the content files. The keys are the pathnames of the file relative to the asdf root file.
Adds an element to the current selected content file.
adp
.
prepare-adp-op
)) ¶Returns the package to be used while loading scribble files.
Operation for loading and generating documentation.
Represents a unit of documentation that groups several elements.
Operation for loading and generating the documentation of dependencies.
Component class for a Scribble source file (using type "scrbl")
Jump to: | A C D E F G M O P R S W |
---|
Jump to: | A C D E F G M O P R S W |
---|
Jump to: | *
C E S T |
---|
Jump to: | *
C E S T |
---|
Jump to: | A C F P S |
---|
Jump to: | A C F P S |
---|