This is the adp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 19:21:48 2022 GMT+0.
The main system appears first, followed by any subsystem dependency.
adpAdd Documentation, Please. A documentation generator.
Héctor Galbis Sanchis
The Unlicense
alexandria (system).
hyperspec (system).
package.lisp (file).
adp-core.lisp (file).
adp.lisp (file).
adp-writers.lisp (file).
helper-style-functions.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
adp/adp.asdadp/package.lispadp/adp-core.lispadp/adp.lispadp/adp-writers.lispadp/helper-style-functions.lispadp/adp-core.lispadp (system).
*add-documentation* (special variable).
*file-adp-elements* (special variable).
*function-tags* (special variable).
*header-tags* (special variable).
*symbol-tags* (special variable).
*type-tags* (special variable).
add-code-tag (function).
add-function-tag (function).
add-header-tag (function).
add-symbol-tag (function).
add-type-tag (function).
check-current-procs (function).
check-style-parameters (function).
create-bold-italic-text (function).
create-bold-text (function).
create-code-block-tag (function).
create-code-inline-text (function).
create-function-ref-text (function).
create-header-ref-text (function).
create-italic-text (function).
create-symbol-ref-text (function).
create-type-ref-text (function).
create-web-link-text (function).
emplace-adp-element (function).
empty-function-tags (function).
empty-header-tags (function).
empty-symbol-tags (function).
empty-type-tags (function).
get-code-tag (function).
hide-symbolp (function).
process-code-tag (function).
push-adp-file (function).
remove-code-tag-exprs (function).
remove-current-data (function).
remove-current-procs (function).
remove-own-code-hide-exprs (function).
set-parameter-value (function).
write-system-files (function).
*bold-italic-proc* (special variable).
*bold-italic-symbol* (special variable).
*bold-proc* (special variable).
*bold-symbol* (special variable).
*code-block-proc* (special variable).
*code-block-tag-symbol* (special variable).
*code-example-proc* (special variable).
*code-inline-proc* (special variable).
*code-inline-symbol* (special variable).
*code-tags* (special variable).
*current-adp-file* (special variable).
*current-adp-file-contents* (special variable).
*defclass-proc* (special variable).
*defconstant-proc* (special variable).
*defgeneric-proc* (special variable).
*define-compiler-macro-proc* (special variable).
*define-condition-proc* (special variable).
*define-method-combination-proc* (special variable).
*define-modify-macro-proc* (special variable).
*define-setf-expander-proc* (special variable).
*define-symbol-macro-proc* (special variable).
*defmacro-proc* (special variable).
*defmethod-proc* (special variable).
*defpackage-proc* (special variable).
*defparameter-proc* (special variable).
*defsetf-proc* (special variable).
*defstruct-proc* (special variable).
*deftype-proc* (special variable).
*defun-proc* (special variable).
*defvar-proc* (special variable).
*file-foot-proc* (special variable).
*file-header-proc* (special variable).
*function-ref-proc* (special variable).
*function-ref-symbol* (special variable).
*get-file-extension-proc* (special variable).
*header-proc* (special variable).
*header-ref-proc* (special variable).
*header-ref-symbol* (special variable).
*hide-symbol* (special variable).
*image-proc* (special variable).
*italic-proc* (special variable).
*italic-symbol* (special variable).
*itemize-proc* (special variable).
*never-used-code-tags* (special variable).
*never-used-header-tags* (special variable).
*project-adp-files* (special variable).
*style-parameters* (special variable).
*subheader-proc* (special variable).
*subsubheader-proc* (special variable).
*symbol-ref-proc* (special variable).
*symbol-ref-symbol* (special variable).
*system-files-proc* (special variable).
*table-proc* (special variable).
*text-proc* (special variable).
*type-ref-proc* (special variable).
*type-ref-symbol* (special variable).
*web-link-proc* (special variable).
*web-link-symbol* (special variable).
add-never-used-code-tag (function).
add-never-used-header-tag (function).
add-style-parameter (function).
adp-element (type).
adp-element-contents (function).
adp-element-key-type (function).
adp-file (type).
adp-file-contents (function).
adp-file-path (function).
adp-files-file-headers (function).
adp-files-headers (function).
bold-italic-textp (function).
bold-textp (function).
check-space-at-boundaries (function).
code-block-tagp (function).
code-inline-textp (function).
code-tagp (function).
create-adp-element (function).
create-adp-file (function).
create-headers-toc-list (function).
create-mini-toc-list (function).
create-table-of-functions (function).
create-table-of-symbols (function).
create-table-of-types (function).
create-toc-deep-levels (function).
create-toc-list (function).
empty-adp-files (function).
empty-code-tags (function).
empty-never-used-code-tags (function).
empty-never-used-header-tags (function).
empty-style-parameters (function).
function-ref-textp (function).
get-function-tag-info (function).
get-header-tag-info (function).
get-project-adp-file-contents (function).
get-symbol-tag-info (function).
get-type-tag-info (function).
header-contents-tag (function).
header-deep-level (function).
header-ref-textp (function).
italic-textp (function).
plistp (function).
push-adp-element (function).
remove-never-used-code-tag (function).
remove-never-used-header-tag (function).
simple-slice-format (function).
slice-format (function).
style-parameter-requiredp (function).
style-parameterp (function).
style-required-parameters (function).
symbol-ref-textp (function).
type-ref-textp (function).
web-link-textp (function).
write-file (function).
write-file-contents (function).
adp/adp.lispadp (system).
bold (macro).
bold-italic (macro).
cl-ref (macro).
code-block (macro).
code-example (macro).
code-inline (macro).
code-tag (macro).
defclass (macro).
defconstant (macro).
defgeneric (macro).
define-compiler-macro (macro).
define-condition (macro).
define-method-combination (macro).
define-modify-macro (macro).
define-setf-expander (macro).
define-symbol-macro (macro).
defmacro (macro).
defmethod (macro).
defpackage (macro).
defparameter (macro).
defsetf (macro).
defstruct (macro).
deftype (macro).
defun (macro).
defvar (macro).
function-ref (macro).
header (macro).
header-ref (macro).
image (macro).
italic (macro).
itemize (macro).
load-documentation-system (function).
mini-table-of-contents (macro).
subheader (macro).
subsubheader (macro).
symbol-ref (macro).
table (macro).
table-of-contents (macro).
table-of-functions (macro).
table-of-symbols (macro).
table-of-types (macro).
text (macro).
type-ref (macro).
web-link (macro).
write-in-file (macro).
adp-reader-macro-dispatch (function).
adv-defmacro (macro).
adv-defun (macro).
adv-header (macro).
adv-subheader (macro).
adv-write-in-file (macro).
adp/adp-writers.lispadp (system).
def-bold-italic-writer (macro).
def-bold-writer (macro).
def-code-block-writer (macro).
def-code-example-writer (macro).
def-code-inline-writer (macro).
def-defclass-writer (macro).
def-defconstant-writer (macro).
def-defgeneric-writer (macro).
def-define-compiler-macro-writer (macro).
def-define-condition-writer (macro).
def-define-method-combination-writer (macro).
def-define-modify-macro-writer (macro).
def-define-setf-expander-writer (macro).
def-define-symbol-macro-writer (macro).
def-defmacro-writer (macro).
def-defmethod-writer (macro).
def-defpackage-writer (macro).
def-defparameter-writer (macro).
def-defsetf-writer (macro).
def-defstruct-writer (macro).
def-deftype-writer (macro).
def-defun-writer (macro).
def-defvar-writer (macro).
def-file-foot-writer (macro).
def-file-header-writer (macro).
def-function-ref-writer (macro).
def-get-file-extension-writer (macro).
def-header-ref-writer (macro).
def-header-writer (macro).
def-image-writer (macro).
def-italic-writer (macro).
def-itemize-writer (macro).
def-style-parameter (macro).
def-subheader-writer (macro).
def-subsubheader-writer (macro).
def-symbol-ref-writer (macro).
def-system-files-writer (macro).
def-table-writer (macro).
def-text-writer (macro).
def-type-ref-writer (macro).
def-web-link-writer (macro).
def-customizable-writer (macro).
adp/helper-style-functions.lispadp (system).
*custom-pprint-dispatch* (special variable).
custom-prin1 (function).
defclass-accessor-function-names (function).
defclass-allocation-types (function).
defclass-class-name (function).
defclass-class-options (function).
defclass-default-initargs (function).
defclass-documentation (function).
defclass-initarg-names (function).
defclass-initforms (function).
defclass-metaclass (function).
defclass-reader-function-names (function).
defclass-slot-documentations (function).
defclass-slot-names (function).
defclass-slot-options (function).
defclass-slot-specifiers (function).
defclass-superclass-names (function).
defclass-type-specifiers (function).
defclass-writer-function-names (function).
defconstant-documentation (function).
defconstant-initial-value (function).
defconstant-name (function).
defgeneric-argument-precedence-order (function).
defgeneric-documentation (function).
defgeneric-function-name (function).
defgeneric-generic-function-class (function).
defgeneric-gf-declarations (function).
defgeneric-gf-lambda-list (function).
defgeneric-method-class (function).
defgeneric-method-combination (function).
defgeneric-method-descriptions (function).
defgeneric-options (function).
define-compiler-macro-declarations (function).
define-compiler-macro-documentation (function).
define-compiler-macro-forms (function).
define-compiler-macro-lambda-list (function).
define-compiler-macro-name (function).
define-condition-default-initargs (function).
define-condition-documentation (function).
define-condition-name (function).
define-condition-options (function).
define-condition-parent-types (function).
define-condition-report-name (function).
define-condition-slot-accessors (function).
define-condition-slot-allocations (function).
define-condition-slot-initargs (function).
define-condition-slot-initforms (function).
define-condition-slot-names (function).
define-condition-slot-options (function).
define-condition-slot-readers (function).
define-condition-slot-specs (function).
define-condition-slot-types (function).
define-condition-slot-writers (function).
define-method-combination-arguments (function).
define-method-combination-declarations (function).
define-method-combination-descriptions (function).
define-method-combination-documentation (function).
define-method-combination-forms (function).
define-method-combination-generic-function (function).
define-method-combination-identity-with-one-argument (function).
define-method-combination-lambda-list (function).
define-method-combination-long-form-options (function).
define-method-combination-method-group-specifier-names (function).
define-method-combination-method-group-specifiers (function).
define-method-combination-name (function).
define-method-combination-operator (function).
define-method-combination-orders (function).
define-method-combination-predicates (function).
define-method-combination-qualifier-patterns (function).
define-method-combination-requireds (function).
define-method-combination-short-form-options (function).
define-modify-macro-documentation (function).
define-modify-macro-function (function).
define-modify-macro-lambda-list (function).
define-modify-macro-name (function).
define-setf-expander-access-fn (function).
define-setf-expander-declarations (function).
define-setf-expander-documentation (function).
define-setf-expander-forms (function).
define-setf-expander-lambda-list (function).
define-symbol-macro-expansion (function).
define-symbol-macro-symbol (function).
defmacro-declarations (function).
defmacro-documentation (function).
defmacro-forms (function).
defmacro-lambda-list (function).
defmacro-name (function).
defmethod-declarations (function).
defmethod-documentation (function).
defmethod-forms (function).
defmethod-function-name (function).
defmethod-method-qualifiers (function).
defmethod-specialized-lambda-list (function).
defpackage-defined-package-name (function).
defpackage-export-symbol-names (function).
defpackage-import-from-package-names (function).
defpackage-import-from-symbol-names (function).
defpackage-import-symbol-names (function).
defpackage-nicknames (function).
defpackage-options (function).
defpackage-shadow-symbol-names (function).
defpackage-shadowing-import-from-package-names (function).
defpackage-shadowing-import-from-symbol-names (function).
defpackage-size (function).
defpackage-use-package-names (function).
defparameter-documentation (function).
defparameter-initial-value (function).
defparameter-name (function).
defsetf-access-fn (function).
defsetf-documentation (function).
defsetf-update-fn (function).
defstruct-conc-name (function).
defstruct-conc-name-option (function).
defstruct-constructor-arglists (function).
defstruct-constructor-names (function).
defstruct-constructor-options (function).
defstruct-copier-name (function).
defstruct-copier-option (function).
defstruct-documentation (function).
defstruct-include-option (function).
defstruct-include-option-slot-descriptors (function).
defstruct-included-structure-name (function).
defstruct-initial-offset (function).
defstruct-initial-offset-option (function).
defstruct-name-and-options (function).
defstruct-named-option (function).
defstruct-options (function).
defstruct-predicate-name (function).
defstruct-predicate-option (function).
defstruct-print-function-option (function).
defstruct-print-object-option (function).
defstruct-printer-name (function).
defstruct-printer-option (function).
defstruct-slot-descriptions (function).
defstruct-slot-initforms (function).
defstruct-slot-names (function).
defstruct-slot-options (function).
defstruct-slot-read-only-ps (function).
defstruct-slot-types (function).
defstruct-type (function).
defstruct-type-option (function).
deftype-declarations (function).
deftype-documentation (function).
deftype-forms (function).
deftype-lambda-list (function).
deftype-name (function).
defun-declarations (function).
defun-documentation (function).
defun-forms (function).
defun-function-name (function).
defun-lambda-list (function).
defvar-documentation (function).
defvar-initial-value (function).
defvar-name (function).
with-defclass-components (macro).
with-defconstant-components (macro).
with-defgeneric-components (macro).
with-define-compiler-macro-components (macro).
with-define-condition-components (macro).
with-define-method-combination-components (macro).
with-define-modify-macro-components (macro).
with-define-setf-expander-components (macro).
with-define-symbol-macro-components (macro).
with-defmacro-components (macro).
with-defmethod-components (macro).
with-defpackage-components (macro).
with-defparameter-components (macro).
with-defsetf-components (macro).
with-defstruct-components (macro).
with-deftype-components (macro).
with-defun-components (macro).
with-defvar-components (macro).
*normal-pprint-dispatch* (special variable).
check-component-symbols (function).
declarationp (function).
def-with-components (macro).
defpackage-documentation (function).
defstruct-structure-name (function).
documentationp (function).
find-shortest-string (function).
Packages are listed by definition order.
adp-privateadppvt
alexandria.
common-lisp.
*add-documentation* (special variable).
*custom-pprint-dispatch* (special variable).
*file-adp-elements* (special variable).
*function-tags* (special variable).
*header-tags* (special variable).
*symbol-tags* (special variable).
*type-tags* (special variable).
add-code-tag (function).
add-function-tag (function).
add-header-tag (function).
add-symbol-tag (function).
add-type-tag (function).
check-current-procs (function).
check-style-parameters (function).
create-bold-italic-text (function).
create-bold-text (function).
create-code-block-tag (function).
create-code-inline-text (function).
create-function-ref-text (function).
create-header-ref-text (function).
create-italic-text (function).
create-symbol-ref-text (function).
create-type-ref-text (function).
create-web-link-text (function).
custom-prin1 (function).
def-bold-italic-writer (macro).
def-bold-writer (macro).
def-code-block-writer (macro).
def-code-example-writer (macro).
def-code-inline-writer (macro).
def-defclass-writer (macro).
def-defconstant-writer (macro).
def-defgeneric-writer (macro).
def-define-compiler-macro-writer (macro).
def-define-condition-writer (macro).
def-define-method-combination-writer (macro).
def-define-modify-macro-writer (macro).
def-define-setf-expander-writer (macro).
def-define-symbol-macro-writer (macro).
def-defmacro-writer (macro).
def-defmethod-writer (macro).
def-defpackage-writer (macro).
def-defparameter-writer (macro).
def-defsetf-writer (macro).
def-defstruct-writer (macro).
def-deftype-writer (macro).
def-defun-writer (macro).
def-defvar-writer (macro).
def-file-foot-writer (macro).
def-file-header-writer (macro).
def-function-ref-writer (macro).
def-get-file-extension-writer (macro).
def-header-ref-writer (macro).
def-header-writer (macro).
def-image-writer (macro).
def-italic-writer (macro).
def-itemize-writer (macro).
def-style-parameter (macro).
def-subheader-writer (macro).
def-subsubheader-writer (macro).
def-symbol-ref-writer (macro).
def-system-files-writer (macro).
def-table-writer (macro).
def-text-writer (macro).
def-type-ref-writer (macro).
def-web-link-writer (macro).
defclass-accessor-function-names (function).
defclass-allocation-types (function).
defclass-class-name (function).
defclass-class-options (function).
defclass-default-initargs (function).
defclass-documentation (function).
defclass-initarg-names (function).
defclass-initforms (function).
defclass-metaclass (function).
defclass-reader-function-names (function).
defclass-slot-documentations (function).
defclass-slot-names (function).
defclass-slot-options (function).
defclass-slot-specifiers (function).
defclass-superclass-names (function).
defclass-type-specifiers (function).
defclass-writer-function-names (function).
defconstant-documentation (function).
defconstant-initial-value (function).
defconstant-name (function).
defgeneric-argument-precedence-order (function).
defgeneric-documentation (function).
defgeneric-function-name (function).
defgeneric-generic-function-class (function).
defgeneric-gf-declarations (function).
defgeneric-gf-lambda-list (function).
defgeneric-method-class (function).
defgeneric-method-combination (function).
defgeneric-method-descriptions (function).
defgeneric-options (function).
define-compiler-macro-declarations (function).
define-compiler-macro-documentation (function).
define-compiler-macro-forms (function).
define-compiler-macro-lambda-list (function).
define-compiler-macro-name (function).
define-condition-default-initargs (function).
define-condition-documentation (function).
define-condition-name (function).
define-condition-options (function).
define-condition-parent-types (function).
define-condition-report-name (function).
define-condition-slot-accessors (function).
define-condition-slot-allocations (function).
define-condition-slot-initargs (function).
define-condition-slot-initforms (function).
define-condition-slot-names (function).
define-condition-slot-options (function).
define-condition-slot-readers (function).
define-condition-slot-specs (function).
define-condition-slot-types (function).
define-condition-slot-writers (function).
define-method-combination-arguments (function).
define-method-combination-declarations (function).
define-method-combination-descriptions (function).
define-method-combination-documentation (function).
define-method-combination-forms (function).
define-method-combination-generic-function (function).
define-method-combination-identity-with-one-argument (function).
define-method-combination-lambda-list (function).
define-method-combination-long-form-options (function).
define-method-combination-method-group-specifier-names (function).
define-method-combination-method-group-specifiers (function).
define-method-combination-name (function).
define-method-combination-operator (function).
define-method-combination-orders (function).
define-method-combination-predicates (function).
define-method-combination-qualifier-patterns (function).
define-method-combination-requireds (function).
define-method-combination-short-form-options (function).
define-modify-macro-documentation (function).
define-modify-macro-function (function).
define-modify-macro-lambda-list (function).
define-modify-macro-name (function).
define-setf-expander-access-fn (function).
define-setf-expander-declarations (function).
define-setf-expander-documentation (function).
define-setf-expander-forms (function).
define-setf-expander-lambda-list (function).
define-symbol-macro-expansion (function).
define-symbol-macro-symbol (function).
defmacro-declarations (function).
defmacro-documentation (function).
defmacro-forms (function).
defmacro-lambda-list (function).
defmacro-name (function).
defmethod-declarations (function).
defmethod-documentation (function).
defmethod-forms (function).
defmethod-function-name (function).
defmethod-method-qualifiers (function).
defmethod-specialized-lambda-list (function).
defpackage-defined-package-name (function).
defpackage-export-symbol-names (function).
defpackage-import-from-package-names (function).
defpackage-import-from-symbol-names (function).
defpackage-import-symbol-names (function).
defpackage-nicknames (function).
defpackage-options (function).
defpackage-shadow-symbol-names (function).
defpackage-shadowing-import-from-package-names (function).
defpackage-shadowing-import-from-symbol-names (function).
defpackage-size (function).
defpackage-use-package-names (function).
defparameter-documentation (function).
defparameter-initial-value (function).
defparameter-name (function).
defsetf-access-fn (function).
defsetf-documentation (function).
defsetf-update-fn (function).
defstruct-conc-name (function).
defstruct-conc-name-option (function).
defstruct-constructor-arglists (function).
defstruct-constructor-names (function).
defstruct-constructor-options (function).
defstruct-copier-name (function).
defstruct-copier-option (function).
defstruct-documentation (function).
defstruct-include-option (function).
defstruct-include-option-slot-descriptors (function).
defstruct-included-structure-name (function).
defstruct-initial-offset (function).
defstruct-initial-offset-option (function).
defstruct-name-and-options (function).
defstruct-named-option (function).
defstruct-options (function).
defstruct-predicate-name (function).
defstruct-predicate-option (function).
defstruct-print-function-option (function).
defstruct-print-object-option (function).
defstruct-printer-name (function).
defstruct-printer-option (function).
defstruct-slot-descriptions (function).
defstruct-slot-initforms (function).
defstruct-slot-names (function).
defstruct-slot-options (function).
defstruct-slot-read-only-ps (function).
defstruct-slot-types (function).
defstruct-type (function).
defstruct-type-option (function).
deftype-declarations (function).
deftype-documentation (function).
deftype-forms (function).
deftype-lambda-list (function).
deftype-name (function).
defun-declarations (function).
defun-documentation (function).
defun-forms (function).
defun-function-name (function).
defun-lambda-list (function).
defvar-documentation (function).
defvar-initial-value (function).
defvar-name (function).
emplace-adp-element (function).
empty-function-tags (function).
empty-header-tags (function).
empty-symbol-tags (function).
empty-type-tags (function).
get-code-tag (function).
hide-symbolp (function).
process-code-tag (function).
push-adp-file (function).
remove-code-tag-exprs (function).
remove-current-data (function).
remove-current-procs (function).
remove-own-code-hide-exprs (function).
set-parameter-value (function).
with-defclass-components (macro).
with-defconstant-components (macro).
with-defgeneric-components (macro).
with-define-compiler-macro-components (macro).
with-define-condition-components (macro).
with-define-method-combination-components (macro).
with-define-modify-macro-components (macro).
with-define-setf-expander-components (macro).
with-define-symbol-macro-components (macro).
with-defmacro-components (macro).
with-defmethod-components (macro).
with-defpackage-components (macro).
with-defparameter-components (macro).
with-defsetf-components (macro).
with-defstruct-components (macro).
with-deftype-components (macro).
with-defun-components (macro).
with-defvar-components (macro).
write-system-files (function).
*bold-italic-proc* (special variable).
*bold-italic-symbol* (special variable).
*bold-proc* (special variable).
*bold-symbol* (special variable).
*code-block-proc* (special variable).
*code-block-tag-symbol* (special variable).
*code-example-proc* (special variable).
*code-inline-proc* (special variable).
*code-inline-symbol* (special variable).
*code-tags* (special variable).
*current-adp-file* (special variable).
*current-adp-file-contents* (special variable).
*defclass-proc* (special variable).
*defconstant-proc* (special variable).
*defgeneric-proc* (special variable).
*define-compiler-macro-proc* (special variable).
*define-condition-proc* (special variable).
*define-method-combination-proc* (special variable).
*define-modify-macro-proc* (special variable).
*define-setf-expander-proc* (special variable).
*define-symbol-macro-proc* (special variable).
*defmacro-proc* (special variable).
*defmethod-proc* (special variable).
*defpackage-proc* (special variable).
*defparameter-proc* (special variable).
*defsetf-proc* (special variable).
*defstruct-proc* (special variable).
*deftype-proc* (special variable).
*defun-proc* (special variable).
*defvar-proc* (special variable).
*file-foot-proc* (special variable).
*file-header-proc* (special variable).
*function-ref-proc* (special variable).
*function-ref-symbol* (special variable).
*get-file-extension-proc* (special variable).
*header-proc* (special variable).
*header-ref-proc* (special variable).
*header-ref-symbol* (special variable).
*hide-symbol* (special variable).
*image-proc* (special variable).
*italic-proc* (special variable).
*italic-symbol* (special variable).
*itemize-proc* (special variable).
*never-used-code-tags* (special variable).
*never-used-header-tags* (special variable).
*normal-pprint-dispatch* (special variable).
*project-adp-files* (special variable).
*style-parameters* (special variable).
*subheader-proc* (special variable).
*subsubheader-proc* (special variable).
*symbol-ref-proc* (special variable).
*symbol-ref-symbol* (special variable).
*system-files-proc* (special variable).
*table-proc* (special variable).
*text-proc* (special variable).
*type-ref-proc* (special variable).
*type-ref-symbol* (special variable).
*web-link-proc* (special variable).
*web-link-symbol* (special variable).
add-never-used-code-tag (function).
add-never-used-header-tag (function).
add-style-parameter (function).
adp-element (type).
adp-element-contents (function).
adp-element-key-type (function).
adp-file (type).
adp-file-contents (function).
adp-file-path (function).
adp-files-file-headers (function).
adp-files-headers (function).
bold-italic-textp (function).
bold-textp (function).
check-component-symbols (function).
check-space-at-boundaries (function).
code-block-tagp (function).
code-inline-textp (function).
code-tagp (function).
create-adp-element (function).
create-adp-file (function).
create-headers-toc-list (function).
create-mini-toc-list (function).
create-table-of-functions (function).
create-table-of-symbols (function).
create-table-of-types (function).
create-toc-deep-levels (function).
create-toc-list (function).
declarationp (function).
def-customizable-writer (macro).
def-with-components (macro).
defpackage-documentation (function).
defstruct-structure-name (function).
documentationp (function).
empty-adp-files (function).
empty-code-tags (function).
empty-never-used-code-tags (function).
empty-never-used-header-tags (function).
empty-style-parameters (function).
find-shortest-string (function).
function-ref-textp (function).
get-function-tag-info (function).
get-header-tag-info (function).
get-project-adp-file-contents (function).
get-symbol-tag-info (function).
get-type-tag-info (function).
header-contents-tag (function).
header-deep-level (function).
header-ref-textp (function).
italic-textp (function).
plistp (function).
push-adp-element (function).
remove-never-used-code-tag (function).
remove-never-used-header-tag (function).
simple-slice-format (function).
slice-format (function).
style-parameter-requiredp (function).
style-parameterp (function).
style-required-parameters (function).
symbol-ref-textp (function).
type-ref-textp (function).
web-link-textp (function).
write-file (function).
write-file-contents (function).
adpalexandria.
common-lisp.
bold (macro).
bold-italic (macro).
cl-ref (macro).
code-block (macro).
code-example (macro).
code-inline (macro).
code-tag (macro).
defclass (macro).
defconstant (macro).
defgeneric (macro).
define-compiler-macro (macro).
define-condition (macro).
define-method-combination (macro).
define-modify-macro (macro).
define-setf-expander (macro).
define-symbol-macro (macro).
defmacro (macro).
defmethod (macro).
defpackage (macro).
defparameter (macro).
defsetf (macro).
defstruct (macro).
deftype (macro).
defun (macro).
defvar (macro).
function-ref (macro).
header (macro).
header-ref (macro).
image (macro).
italic (macro).
itemize (macro).
load-documentation-system (function).
mini-table-of-contents (macro).
subheader (macro).
subsubheader (macro).
symbol-ref (macro).
table (macro).
table-of-contents (macro).
table-of-functions (macro).
table-of-symbols (macro).
table-of-types (macro).
text (macro).
type-ref (macro).
web-link (macro).
write-in-file (macro).
adp-reader-macro-dispatch (function).
adv-defmacro (macro).
adv-defun (macro).
adv-header (macro).
adv-subheader (macro).
adv-write-in-file (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
An extension of *print-pprint-dispatch*. The define functions (like defun) from adp will be printed with pretty indentation as if they were from cl. Internal symbols will be printed without the package extension even if *print-escape* is true. Besides, the shortest package nickname will be printed as the package extension of a symbol.
Add bold style to text when using the macros text, table or itemize. Each argument is princ-ed and concatenated into a string.
Add bold and italic style to text when using the macros text, table or itemize. Each argument is princ-ed and concatenated into a string.
Add a reference to a Common Lisp symbol when using the macros text, table or itemize.
Add a block of code. Each element of code will be prin1-ed but not evaluated. If a symbol is used and that symbol appears as a tag in tags, then the code assigned to that tag is prin1-ed instead of the symbol.
Same as code-block, but tags cannot be used and the code is evaluated. The standard output and the last-form’s results are also printed.
Add inlined style to text when using the macros text, table or itemize. Each argument is princ-ed and concatenated into a string.
Assign several tags to a piece of code. The code is placed into a progn form. The argument tags must be a list
of symbols. If no tags are provided, then code-tag will do nothing. Each symbol in tags will be a code-tag assigned to code.
Inside the code-tag form it is correct to use a (code-hide tags &rest forms) form. It only indicates to code-tag
which parts of code can be hidden when using the tag in the macro code-block. code-hide accepts also a list of tags. If a tag
used in code-tag also appears in code-hide, that piece of code will be hidden when using the macro code-block. If the list of
tags in code-hide is empty, the that piece of code will be hidden for every tag used in code-tag.
Add a defclass declaration. The macro expands to cl:defclass. Also, the class name is used to create a type-tag.
Add a defconstant declaration. The macro expands to cl:defconstant. Also, the constant name is used to create a symbol-tag.
Add a defgeneric declaration. The macro expands to cl:defgeneric. Also, the generic function name is used to create a function-tag.
Add a define-compiler-macro declaration. The macro expands to cl:define-compiler-macro.
Add a define-condition declaration. The macro expands to cl:define-condition. Also, the condition name is used to create a type-tag.
Add a define-method-combination declaration. The macro expands to cl:define-method-combination.
Add a define-modify-macro declaration. The macro expands to cl:define-modify-macro. Also, the macro name is used to create a function-tag.
Add a define-setf-expander declaration. The macro expands to cl:define-setf-expander.
Add a define-symbol-macro declaration. The macro expands to cl:define-symbol-macro. Also, the symbol name is used to create a symbol-tag.
Add a defmacro declaration. The macro expands to cl:defmacro. Also, the macro name is used to create a function-tag.
Add a defmethod declaration. The macro expands to cl:defmethod.
Add a defpackage declaration. The macro expands to cl:defpackage.
Add a defparameter declaration. The macro expands to cl:defparameter. Also, the parameter name is used to create a symbol-tag.
Add a defsetf declaration. The macro expands to cl:defsetf.
Add a defstruct declaration. The macro expands to cl:defstruct. Also, the struct name is used to create a type-tag.
Add a deftype declaration. The macro expands to cl:deftype. Also, the type name is used to create a type-tag.
Add a defun declaration. The macro expands to cl:defun. Also, the function name is used to create a function-tag.
Add a defvar declaration. The macro expands to cl:defvar. Also, the variable name is used to create a symbol-tag.
Add a reference to a function symbol when using the macros text, table or itemize. The argument is a symbol denoting a function defined with adp:defgeneric, adp:define-modify-macro, adp:defmacro or adp:defun.
Add a header with name str. Also, if tag is not nil but a symbol, a new header-tag is created.
Add a reference to a header when using the macros text, table or itemize. The argument is a symbol denoting a header-tag. Only the symbols used with the macros header, subheader and subsubheader are valid.
Add an image with alt-text as the alternative text and path must be the pathname, relative to the system’s root directory, where the image is located.
Add italic style to text when using the macros text, table or itemize. Each argument is princ-ed and concatenated into a string.
Add a list of items. Each argument must be a list. Each list must have as first argument the keyword :item or :itemize. If :item is used, the rest of the elements in that list will be treated as if using the macro text. If :itemize is used the rest of elements must be lists where its first elements are the keywords :item or :itemize. In other words, when :itemize is used a nested list is added.
Add a list of all headers, subheaders and subsubheaders used in the current documentation file.
Same as header, but add a subheader.
Same as header, but add a subsubheader.
Add a reference to a variable when using the macros text, table or itemize. The argument is a symbol denoting a variable defined with adp:deconstant, adp:define-symbol-macro, adp:defparameter or adp:defvar.
Add a table. Each argument must be a list of lists. Each inner list must have as first element the keyword :cell and the rest are treated as if using the macro text.
Add a list of all headers and subheaders used in the system. The headers from different files are shown in the same order the files are loaded.
Add an ordered list of all functions and macros defined using ADP.
Add an ordered list of all variables defined using ADP.
Add an ordered list of all types defined using ADP.
Add plain text. The arguments in objects can be any lisp object. They will be princ-ed and concatenated into a single string.
You can use the following macros to enrich your text: bold, italic, bold-italic, code-inline, web-link, header-ref, symbol-ref, function-ref and type-ref.
Add a reference to a type symbol when using the macros text, table or itemize. The argument is a symbol denoting a type defined with adp:defclass, adp:define-condition, adp:defstruct or adp:deftype.
Add a hyperlink. The text showed is name and link must be a valid web URL. Both arguments must be strings.
Associate all the information gathered so far with the pathname file-path. This will cause the creation of a file where all the information will be printed in. The pathname will be considered relative to the system’s root directory. Only the directory and name parts of file-path are considered. The rest are ignored (including the extension). This macro can be used multiple times.
It is like prin1, but uses *custom-pprint-dispatch* instead. Also, if hidden code is found, then hide-str is princ-ed.
Load a system with documentation generation activated. The style must be a keyword denoting a valid style.
Each style will create different files. The style-args are style-dependent. In other words, each style can have its own
arguments to let the user customize briefly how documentation is printed.
| Jump to: | A B C D E F G H I L M P R S T W |
|---|
| Jump to: | A B C D E F G H I L M P R S T W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | A F H P S T |
|---|
| Jump to: | A F H P S T |
|---|