The adp Reference Manual

This is the adp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 03:13:29 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 adp

Add Documentation, Please. A Common Lisp literate programming tool.

Author

Héctor Galbis Sanchis

License

The Unlicense

Dependencies
  • alexandria (system).
  • hyperspec (system).
Source

adp.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 adp/src

Source

adp.asd.

Parent Component

adp (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 adp/adp.asd

Source

adp.asd.

Parent Component

adp (system).

ASDF Systems

adp.


4.1.2 adp/package.lisp

Source

adp.asd.

Parent Component

adp (system).

Packages

4.1.3 adp/src/error.lisp

Source

adp.asd.

Parent Component

src (module).

Internals

4.1.4 adp/src/element.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 adp/src/file.lisp

Source

adp.asd.

Parent Component

src (module).

Internals

file (class).


4.1.6 adp/src/project.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

project (class).


4.1.7 adp/src/tag-table.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

with-tag-tables (macro).

Internals

4.1.8 adp/src/pprint-dispatch.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

*adp-pprint-dispatch* (special variable).

Internals

4.1.9 adp/src/writer.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.10 adp/src/parameter.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.11 adp/src/core.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.12 adp/src/adp.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.13 adp/src/style-maker.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 adp-private

Source

package.lisp.

Nickname

adppvt

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

5.2 adp

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

5.3 adp-style-maker

Source

package.lisp.

Nickname

adpsm

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *adp-pprint-dispatch*
Package

adp-private.

Source

pprint-dispatch.lisp.

Special Variable: *adp-pprint-dispatch*

ADP custom pprint dispatch table to make the code printing look better. The main difference is when the package extension of a symbol is printed. It will only print the extension package when a symbol is exported.

Package

adp-style-maker.

Source

style-maker.lisp.

Special Variable: *begin-file-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *begin-project-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *bold-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *code-block-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *code-example-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defclass-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defconstant-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defgeneric-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *define-compiler-macro-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *define-condition-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *define-method-combination-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *define-modify-macro-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *define-setf-expander-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *define-symbol-macro-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defmacro-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defmethod-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defpackage-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defparameter-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defsetf-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defstruct-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *deftype-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defun-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *defvar-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *emphasis-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *end-file-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *end-project-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *escape-text*
Package

adp-private.

Source

writer.lisp.

Special Variable: *file-extension*
Package

adp-private.

Source

writer.lisp.

Special Variable: *function-ref-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *header-ref-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *header-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *image-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *inline-code-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *italic-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *itemize-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *subheader-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *subsubheader-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *symbol-ref-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *table-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *text-writer*
Package

adp-private.

Source

writer.lisp.

Special Variable: *type-ref-writer*
Package

adp-private.

Source

writer.lisp.

Package

adp-private.

Source

writer.lisp.


6.1.2 Macros

Macro: bold (&rest args)

Add bold style to text. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: cell (&rest objects)

Create a cell to place into a table. 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 cell text: bold, italic, emphasis, inline-code, web-link, header-ref, symbol-ref, function-ref and type-ref.

Package

adp.

Source

adp.lisp.

Macro: check-writers ()
Package

adp-private.

Source

writer.lisp.

Macro: cl-ref (sym)

Add a reference to a Common Lisp symbol when using the macros text, cell or item.

Package

adp.

Source

adp.lisp.

Macro: code-block ((&rest tags) &body code)

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 printed instead of the symbol.

Package

adp.

Source

adp.lisp.

Macro: code-comment (comment &body body)

Form recognized by code-tag that prints a comment before the body expressions when using the tag defined by code-tag inside a code-block.

Package

adp.

Source

adp.lisp.

Macro: code-example (&body code)

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.

Package

adp.

Source

adp.lisp.

Macro: code-hide ((&rest tags) &body body)

Form recognized by code-tag that will hide the code printing ’...’. The printing will be done when using the tag defined by code-tag inside a code-block.

Package

adp.

Source

adp.lisp.

Macro: code-quote (&body body)

Form recognized by code-tag that prevents the expressions from being evaluated.

Package

adp.

Source

adp.lisp.

Macro: code-remove ((&rest tags) &body body)

Form recognized by code-tag that will remove the code printing. This will be done when using the tag defined by code-tag inside a code-block.

Package

adp.

Source

adp.lisp.

Macro: code-tag (tags &body exprs)

Assign several tags to several forms. The forms are placed into a progn form. The argument tags must be a list
of symbols. If no tags are provided, an error is raised. Each symbol in tags will be a code-tag assigned to code.
The same tag can be used several times in different calls to code-tag. Inside the code-tag form it is correct to use
the next forms: code-hide, code-remove, code-show and code-comment.
- code-hide: It has the syntax (code-hide (&rest tags) &rest forms). code-hide receives a list of tags. If a tag
used in code-tag also appears in code-hide, the rest of forms will be hidden when using the macro code-block. If the list of tags in code-hide is empty, the forms will be hidden for every tag used in code-tag. Hidding the code means printing "..." instead of the forms.
- code-remove: Same as code-hide, but removes the code instead of printing "..."
- code-quote: Every expression placed inside code-quote will have its evaluation disabled.
- code-comment: Receive a string and the forms to be commented. This string will be printed as a comment (printing ’;;’).

Package

adp.

Source

adp.lisp.

Macro: defclass (&body body)

Add a defclass declaration. The macro expands to cl:defclass. Also, the class name is used to create a type-tag.

Package

adp.

Source

adp.lisp.

Macro: defconstant (&body body)

Add a defconstant declaration. The macro expands to cl:defconstant. Also, the constant name is used to create a symbol-tag.

Package

adp.

Source

adp.lisp.

Macro: defgeneric (&body body)

Add a defgeneric declaration. The macro expands to cl:defgeneric. Also, the generic function name is used to create a function-tag.

Package

adp.

Source

adp.lisp.

Macro: define-bold-writer ((stream text) &body body)

Define a function to print a bold text element. It receives the stream to be written in, and a string with the text.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-code-block-writer ((stream lang text) &body body)

Define a function to print a code block element. It receives the stream, a string with the used programming language, and another string with the text to be placed in the block of code.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-code-example-writer ((stream text output results) &body body)

Define a function to print an example block. It receives the stream, a string with the code to be placed in a block of code, a string with the standard output of the code, and a list of elements returned by the code.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-compiler-macro (&body body)

Add a define-compiler-macro declaration. The macro expands to cl:define-compiler-macro.

Package

adp.

Source

adp.lisp.

Macro: define-condition (&body body)

Add a define-condition declaration. The macro expands to cl:define-condition. Also, the condition name is used to create a type-tag.

Package

adp.

Source

adp.lisp.

Macro: define-defclass-writer ((stream expr tag) &body body)

Define a function to print a defclass definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defconstant-writer ((stream expr tag) &body body)

Define a function to print a defconstant definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defgeneric-writer ((stream expr tag) &body body)

Define a function to print a defgeneric definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-compiler-macro-writer ((stream expr) &body body)

Define a function to print a define-compiler-macro definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-condition-writer ((stream expr tag) &body body)

Define a function to print a define-condition definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-method-combination-writer ((stream expr) &body body)

Define a function to print a define-method-combination definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-modify-macro-writer ((stream expr tag) &body body)

Define a function to print a define-modify-macro definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-setf-expander-writer ((stream expr) &body body)

Define a function to print a define-setf-expander definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-symbol-macro-writer ((stream expr tag) &body body)

Define a function to print a define-symbol-macro definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defmacro-writer ((stream expr tag) &body body)

Define a function to print a defmacro definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defmethod-writer ((stream expr) &body body)

Define a function to print a defmethod definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defpackage-writer ((stream expr) &body body)

Define a function to print a defpackage definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defparameter-writer ((stream expr tag) &body body)

Define a function to print a defparameter definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defsetf-writer ((stream expr) &body body)

Define a function to print a defsetf definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defstruct-writer ((stream expr tag) &body body)

Define a function to print a defstruct definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-deftype-writer ((stream expr tag) &body body)

Define a function to print a deftype definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defun-writer ((stream expr tag) &body body)

Define a function to print a defun definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defvar-writer ((stream expr tag) &body body)

Define a function to print a defvar definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-emphasis-writer ((stream text) &body body)

Same as define-bold-writer, but with both bold and italic style.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-escape-text ((text) &body body)

Define a function that receives a string of text and must return another string. You want this to escape special characters that will be used with bold, italic, header-ref, web-link, etc.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-file-extension (() &body body)

Define a function that must return a string indicating the extension of the files that ADP will create.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-function-ref-writer ((stream tag source-relative-path) &body body)

Same as define-symbol-ref-writer, but it prints a function reference.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-header-ref-writer ((stream tag title source-relative-path) &body body)

Define a function to print a header reference element. It receives the stream to be written in, the tag associated to a header element, the text of said header element, and the relative path to the place where the header element is in.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-header-writer ((stream title tag) &body body)

Define a function that must print a header element. The function receives the stream to be written in, the header name and the tag associated to it.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-image-writer ((stream alt-text image-relative-path) &body body)

Define a function to print an image element. It receives the stream, the alternative text as a string, and a relative pathname to the image.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-inline-code-writer ((stream text) &body body)

Same as define-bold-writer, but with a code-inline style.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-italic-writer ((stream text) &body body)

Same as define-bold-writer, but with an italic style.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-itemize-writer ((stream itemize) &body body)

Define a function to print an itemize element. It receives the stream and a list. The first element of the
list can be :iterate or :enumerate indicating if you should use numbers. Each element of the rest of the list can be an item or a nested list element. The item has the form (:item string). A nested list element is a list starting with :itemize or :enumerate and the rest of elements are again items or nested list elements. For example, you could receive something like:
(:itemize (:item "Animals")
(:enumerate (:item "Dog")
(:item "Cat")))

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-method-combination (&body body)

Add a define-method-combination declaration. The macro expands to cl:define-method-combination.

Package

adp.

Source

adp.lisp.

Macro: define-modify-macro (&body body)

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.

Package

adp.

Source

adp.lisp.

Macro: define-setf-expander (&body body)

Add a define-setf-expander declaration. The macro expands to cl:define-setf-expander.

Package

adp.

Source

adp.lisp.

Macro: define-style-parameter (name &key value key required)
Package

adp-private.

Source

parameter.lisp.

Macro: define-style-parameter (name &key value key required)

Define a style parameter. A new parameter is defined (using defparameter) and also a style parameter is added. A style parameter is a keyword parameter added to ADP:LOAD-SYSTEM. NAME is the name of the parameter. VALUE is the default value. KEY is the keyword of the style parameter. If KEY is not specified, the keyword is obtained using the symbol name of NAME. If REQUIRED is non-NIL, the user must use this parameter when using ADP:LOAD-SYSTEM.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-subheader-writer ((stream title tag) &body body)

Same as define-header-writer but it must print a subheader element.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-subsubheader-writer ((stream title tag) &body body)

Same as define-header-writer but it must print a subsubheader element.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-symbol-macro (&body body)

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.

Package

adp.

Source

adp.lisp.

Macro: define-symbol-ref-writer ((stream tag source-relative-path) &body body)

Same as define-header-ref-writer, but it prints a symbol reference. Also, it receives the stream, the tag associated with the symbol, and the relative path to the place where the symbol definition is in.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-table-writer ((stream rows) &body body)

Define a function to print a table element. It receives the stream, and a list of lists of strings. Each inner list is a row of the table, and each string is an element of the table.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-text-writer ((stream text) &body body)

Define a function that must print a text element. It receives the stream to be written in, and a string with the text.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-type-ref-writer ((stream tag source-relative-path) &body body)

Sama as define-symbol-ref-writer, but it prints a type reference.

Package

adp-style-maker.

Source

style-maker.lisp.

Define a function to print a web link element. It receives the stream, the link text as a string, and the link address as a string.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: defmacro (&body body)

Add a defmacro declaration. The macro expands to cl:defmacro. Also, the macro name is used to create a function-tag.

Package

adp.

Source

adp.lisp.

Macro: defmethod (&body body)

Add a defmethod declaration. The macro expands to cl:defmethod.

Package

adp.

Source

adp.lisp.

Macro: defpackage (&body body)

Add a defpackage declaration. The macro expands to cl:defpackage.

Package

adp.

Source

adp.lisp.

Macro: defparameter (&body body)

Add a defparameter declaration. The macro expands to cl:defparameter. Also, the parameter name is used to create a symbol-tag.

Package

adp.

Source

adp.lisp.

Macro: defsetf (&body body)

Add a defsetf declaration. The macro expands to cl:defsetf.

Package

adp.

Source

adp.lisp.

Macro: defstruct (&body body)

Add a defstruct declaration. The macro expands to cl:defstruct. Also, the struct name is used to create a type-tag.

Package

adp.

Source

adp.lisp.

Macro: deftype (&body body)

Add a deftype declaration. The macro expands to cl:deftype. Also, the type name is used to create a type-tag.

Package

adp.

Source

adp.lisp.

Macro: defun (&body body)

Add a defun declaration. The macro expands to cl:defun. Also, the function name is used to create a function-tag.

Package

adp.

Source

adp.lisp.

Macro: defvar (&body body)

Add a defvar declaration. The macro expands to cl:defvar. Also, the variable name is used to create a symbol-tag.

Package

adp.

Source

adp.lisp.

Macro: emphasis (&rest args)

Add bold and italic style to text. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: enumerate (&rest items)

Same as itemize, but a number is printed before each element.

Package

adp.

Source

adp.lisp.

Macro: function-ref (tag)

Add a reference to a function symbol when using the macros text, cell or item. The argument is a symbol denoting a function defined with adp:defgeneric, adp:define-modify-macro, adp:defmacro or adp:defun.

Package

adp.

Source

adp.lisp.

Macro: header (str &optional tag)

Add a header with name str. Also, if tag is not nil but an interned symbol, a new header-tag is created.

Package

adp.

Source

adp.lisp.

Macro: header-ref (tag)

Add a reference to a header when using the macros text, cell or item. The argument is a symbol denoting a header-tag. Only the symbols used with the macros header, subheader and subsubheader are valid.

Package

adp.

Source

adp.lisp.

Macro: image (alt-text path)

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.

Package

adp.

Source

adp.lisp.

Macro: in-file (path)
Package

adp.

Source

adp.lisp.

Macro: inline-code (&rest args)

Add inlined style to text. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: italic (&rest args)

Add italic style to text. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: item (&rest items)

Create an item to be placed into a iterate/enumerate form. 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 cell text: bold, italic, emphasis, inline-code, web-link, header-ref, symbol-ref, function-ref and type-ref.

Package

adp.

Source

adp.lisp.

Macro: itemize (&rest items)

Add a list of items. Each argument must be a list. Each list must start with the symbol item, itemize or enumerate. If
item is used, the rest of the elements in that list will be treated as if using the macro text. If itemize or enumerate is used the rest of elements must be lists that must start with item, itemize or enumerate. In other words, when itemize or enumerate is used
a nested list is added. A certain symbol will be printed before each element of the list.

Package

adp.

Source

adp.lisp.

Macro: mini-table-of-contents ()

Add a list of all headers, subheaders and subsubheaders used in the current documentation file.

Package

adp.

Source

adp.lisp.

Macro: subheader (str &optional tag)

Add a subheader with name str. Also, if tag is not nil but an interned symbol, a new header-tag is created.

Package

adp.

Source

adp.lisp.

Macro: subsubheader (str &optional tag)

Add a subsubheader with name str. Also, if tag is not nil but an interned symbol, a new header-tag is created.

Package

adp.

Source

adp.lisp.

Macro: symbol-ref (tag)

Add a reference to a variable when using the macros text, cell or item. The argument is a symbol denoting a variable defined with adp:defconstant, adp:define-symbol-macro, adp:defparameter or adp:defvar.

Package

adp.

Source

adp.lisp.

Macro: table (&rest rows)

Add a table. Each argument must be a list of cell macro calls.

Package

adp.

Source

adp.lisp.

Macro: table-of-contents ()

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.

Package

adp.

Source

adp.lisp.

Macro: table-of-functions ()

Add an ordered list of all functions and macros defined using ADP.

Package

adp.

Source

adp.lisp.

Macro: table-of-symbols ()

Add an ordered list of all variables defined using ADP.

Package

adp.

Source

adp.lisp.

Macro: table-of-types ()

Add an ordered list of all types defined using ADP.

Package

adp.

Source

adp.lisp.

Macro: text (&rest objects)

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, emphasis, inline-code, web-link, header-ref, symbol-ref, function-ref and type-ref.

Package

adp.

Source

adp.lisp.

Macro: type-ref (tag)

Add a reference to a type symbol when using the macros text, cell or item. The argument is a symbol denoting a type defined with adp:defclass, adp:define-condition, adp:defstruct or adp:deftype.

Package

adp.

Source

adp.lisp.

Macro: verbatim-code-block (lang text)

Add a block of text. It receives two arguments. The first argument must be a string or NIL and it should denote the programming language that will be used. The second argument must be a string with the text that will be printed.

Package

adp.

Source

adp.lisp.

Add a hyperlink. The text showed is name and link must be a valid web URL. Both arguments must be strings.

Package

adp.

Source

adp.lisp.

Macro: with-defclass-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defconstant-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defgeneric-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-compiler-macro-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-condition-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-method-combination-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-modify-macro-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-setf-expander-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-symbol-macro-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defmacro-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defmethod-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defpackage-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defparameter-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defsetf-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defstruct-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-deftype-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defun-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defvar-components (((&rest component-rest-args) function-body-arg) &body body-arg)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-new-style-parameter-list (&body body)
Package

adp-private.

Source

parameter.lisp.

Macro: with-style-parameters (args &body body)
Package

adp-private.

Source

parameter.lisp.

Macro: with-tag-tables (&body body0)
Package

adp-private.

Source

tag-table.lisp.

Macro: with-writers (&body body0)
Package

adp-private.

Source

writer.lisp.


6.1.3 Ordinary functions

Function: add-code-tag (tag code)

Associate a tag with a piece of code.

Package

adp-private.

Source

core.lisp.

Function: load-system (system style &rest style-args)

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.

Package

adp.

Source

adp.lisp.

Function: project-print (project)

Generate a project documentation.

Package

adp-private.

Source

core.lisp.

Function: relative-truename (project &optional path)

Return the *load-truename* path relative to the project root directory.

Package

adp-private.

Source

core.lisp.

Function: select-file (project path)
Package

adp-private.

Source

core.lisp.


6.1.4 Generic functions

Generic Function: add-element (project element)

Add an element into a project.

Package

adp-private.

Source

core.lisp.

Methods
Method: add-element :after (project (element type-definition))
Method: add-element :after (project (element function-definition))
Method: add-element :after (project (element symbol-definition))
Method: add-element :after (project (element file-table-of-contents))
Method: add-element :after (project (element table-of-contents))
Method: add-element :after (project (element header-type))
Method: add-element (project (element element))

6.1.5 Standalone methods

Method: action-description ((o load-doc-source-op) (c parent-component))
Package

asdf/action.

Source

adp.lisp.

Method: action-description ((o load-doc-source-op) (c component))
Package

asdf/action.

Source

adp.lisp.

Method: perform ((o load-doc-source-op) (c static-file))
Package

asdf/action.

Source

adp.lisp.

Method: perform ((o load-doc-source-op) (c cl-source-file))
Package

asdf/action.

Source

adp.lisp.

Method: print-object ((object code-hide) stream)
Source

element.lisp.

Method: print-object ((object code-comment) stream)
Source

element.lisp.


6.1.6 Classes

Class: bold

Represent a bold element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-subelement.

Direct methods

element-print.

Class: cell

Represent a cell table element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-element.

Class: code

Represent a code element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct subclasses

tagged-code.

Direct slots
Slot: expr
Initargs

:expr

Class: code-block

Represent a code block element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

code-block-type.

Direct methods

element-print.

Direct slots
Slot: code-elements
Type

list

Initargs

:code-elements

Class: code-comment

Represent a code hide symbol.

Package

adp-private.

Source

element.lisp.

Direct methods

print-object.

Direct slots
Slot: comment
Type

string

Initargs

:comment

Slot: expr
Initargs

:expr

Class: code-example

Represent a code example element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct methods

element-print.

Direct slots
Slot: code-elements
Type

list

Initargs

:code-elements

Slot: output
Type

string

Initargs

:output

Slot: result
Type

list

Initargs

:result

Class: code-hide

Represent a code hide symbol.

Package

adp-private.

Source

element.lisp.

Direct methods

print-object.

Class: code-ref

Represent a code reference element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

tagged-element.

Direct slots
Slot: code-tags
Type

adp-private::tag-table

Class: defclass-definition

Represent a defclass element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

type-definition.

Direct methods

element-print.

Class: defconstant-definition

Represent a defconstant element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

symbol-definition.

Direct methods

element-print.

Class: defgeneric-definition

Represent a defgeneric element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

function-definition.

Direct methods

element-print.

Class: define-compiler-macro-definition

Represent a define-compiler-macro element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

defintion.

Direct methods

element-print.

Class: define-condition-definition

Represent a define-condition element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

type-definition.

Direct methods

element-print.

Class: define-method-combination-definition

Represent a define-method-combination element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

definition.

Direct methods

element-print.

Class: define-modify-macro-definition

Represent a define-modify-macro element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

function-definition.

Direct methods

element-print.

Class: define-setf-expander-definition

Represent a define-setf-expander element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

definition.

Direct methods

element-print.

Class: define-symbol-macro-definition

Represent a define-symbol-macro element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

symbol-definition.

Direct methods

element-print.

Class: defmacro-definition

Represent a defmacro element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

function-definition.

Direct methods

element-print.

Class: defmethod-definition

Represent a defmethod element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

definition.

Direct methods

element-print.

Class: defpackage-definition

Represent a defpackage element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

definition.

Direct methods

element-print.

Class: defparameter-definition

Represent a defparameter element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

symbol-definition.

Direct methods

element-print.

Class: defsetf-definition

Represent a defsetf element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

definition.

Direct methods

element-print.

Class: defstruct-definition

Represent a defstruct element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

type-definition.

Direct methods

element-print.

Class: deftype-definition

Represent a deftype element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

type-definition.

Direct methods

element-print.

Class: defun-definition

Represent a defun element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

function-definition.

Direct methods

element-print.

Class: defvar-definition

Represent a defvar element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

symbol-definition.

Direct methods

element-print.

Class: emphasis

Represent a bold and italic element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-subelement.

Direct methods

element-print.

Class: enumerate

Represent an enumerate element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

itemize-type.

Direct methods

process-itemize.

Class: function-ref

Represent a function reference element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-reference.

Direct methods

element-print.

Class: header

Represent a header element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

header-type.

Direct methods

element-print.

Class: header-ref

Represent a header reference element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-reference.

Direct methods

element-print.

Class: image

Represent an image element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct methods

element-print.

Direct slots
Slot: alt-text
Type

string

Initargs

:alt-text

Slot: path
Type

pathname

Initargs

:path

Class: inline-code

Represent an inline code element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-subelement.

Direct methods

element-print.

Class: italic

Represent a italic element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-subelement.

Direct methods

element-print.

Class: item

Represents an item element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-element.

Direct methods

process-itemize.

Class: itemize

Represent an itemize element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

itemize-type.

Direct methods
Class: mini-table-of-contents

Represent a table of contents element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

file-table-of-contents.

Direct methods

element-print.

Class: project
Package

adp-private.

Source

project.lisp.

Direct slots
Slot: root-directory
Type

pathname

Initargs

:root-directory

Slot: files
Type

(vector adp-private::file)

Initform

(make-array 10 :adjustable t :fill-pointer 0)

Slot: current-file
Type

pathname

Class: subheader

Represent a subheader element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

header-type.

Direct methods

element-print.

Class: subsubheader

Represent a subsubheader element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

header-type.

Direct methods

element-print.

Class: symbol-ref

Represent a symbol reference element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-reference.

Direct methods

element-print.

Class: table

Represent a table element. Each row is a list of text elements.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct methods
Direct slots
Slot: rows
Type

list

Initargs

:rows

Class: table-of-contents

Represent a table of contents element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct methods
Direct slots
Slot: project
Type

adp-private:project

Class: table-of-functions

Represent a table of functions element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

file-table-of-contents.

Direct methods

element-print.

Class: table-of-symbols

Represent a table of symbols element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

file-table-of-contents.

Direct methods

element-print.

Class: table-of-types

Represent a table of types element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

file-table-of-contents.

Direct methods

element-print.

Class: tagged-code

Represent a tagged code element.

Package

adp-private.

Source

element.lisp.

Direct superclasses
Class: text

Represents a text element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-element.

Direct methods

element-print.

Class: type-ref

Represent a type reference element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-reference.

Direct methods

element-print.

Class: verbatim-code-block

Represent a verbatim code block element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

code-block-type.

Direct methods

element-print.

Direct slots
Slot: code-text
Type

string

Initargs

:code-text

Represents a web-link element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-subelement-type.

Direct methods

element-print.

Direct slots
Slot: text
Type

string

Initargs

:text

Slot: address
Type

string

Initargs

:address


6.2 Internals


6.2.1 Special variables

Special Variable: *adp*
Package

adp.

Source

adp.lisp.

Special Variable: *code-tags*
Package

adp-private.

Source

tag-table.lisp.

Special Variable: *function-tags*
Package

adp-private.

Source

tag-table.lisp.

Special Variable: *header-tag-counter*
Package

adp.

Source

adp.lisp.

Special Variable: *header-tags*
Package

adp-private.

Source

tag-table.lisp.

Special Variable: *project*
Package

adp.

Source

adp.lisp.

Special Variable: *style-parameters*
Package

adp-private.

Source

parameter.lisp.

Special Variable: *symbol-tags*
Package

adp-private.

Source

tag-table.lisp.

Special Variable: *type-tags*
Package

adp-private.

Source

tag-table.lisp.


6.2.2 Macros

Macro: adv-defmacro (&body defmacro-body)
Package

adp.

Source

adp.lisp.

Macro: adv-defun (&body defun-body)
Package

adp.

Source

adp.lisp.

Macro: adv-header (str &optional tag)
Package

adp.

Source

adp.lisp.

Macro: adv-in-file (path)
Package

adp.

Source

adp.lisp.

Macro: adv-subheader (str &optional tag)
Package

adp.

Source

adp.lisp.

Macro: def-with-components (name &rest components)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-begin-file-writer ((stream) &body body)

Define a function that will be called when the file is about to be written in. The function receives a stream associated with said file.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-begin-project-writer ((root-directory) &body body)

Define a function that will be called before the documentation of a project begins to generate. The function receives the pathname of the project root directory.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-check-writers (name &body writer-name-optionals)
Package

adp-private.

Source

writer.lisp.

Macro: define-definition-class (name super docstring)
Package

adp-private.

Source

element.lisp.

Macro: define-definition-element-print (type writer)
Package

adp-private.

Source

core.lisp.

Macro: define-definition-macro (name type tag-extraction-expr docstring)
Package

adp.

Source

adp.lisp.

Macro: define-end-file-writer ((stream) &body body)

Define a function that will be called after a file has finished of being written in. The function receives a stream associated with said file.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-end-project-writer ((root-directory) &body body)

Define a function that will be called after the documentation of a project has been generated. The function receives the pathname of the project root directory.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-header-macro (name type)
Package

adp.

Source

adp.lisp.

Macro: define-reference-macro (name type docstring)
Package

adp.

Source

adp.lisp.

Macro: define-tag-tables (with-tag-tables-name &body names)
Package

adp-private.

Source

tag-table.lisp.

Macro: define-tagged-definition-element-print (type writer)
Package

adp-private.

Source

core.lisp.

Macro: define-text-enrichment-macro (name type docstring)
Package

adp.

Source

adp.lisp.

Macro: define-with-tag-tables (name &body tag-tables)
Package

adp-private.

Source

tag-table.lisp.

Macro: define-with-writers (name &body writer-names)
Package

adp-private.

Source

writer.lisp.

Macro: define-writer-definer (writer-proc writer-definer writer-args docstring)
Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-writers (with-writers-name check-writers-name &body writer-name-optionals)
Package

adp-private.

Source

writer.lisp.

Macro: eval-when-adp (&body body)

The body forms will be placed into a progn form only when documentation generation is activated. Otherwise, this macro expands to NIL.

Package

adp.

Source

adp.lisp.


6.2.3 Ordinary functions

Function: adp-reader-macro-dispatch (stream char num-arg)
Package

adp.

Source

adp.lisp.

Function: check-code-comment (expr)
Package

adp.

Source

adp.lisp.

Function: check-code-hide (expr)
Package

adp.

Source

adp.lisp.

Function: check-code-remove (expr)
Package

adp.

Source

adp.lisp.

Function: check-component-symbols (symbols components)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: check-style-parameters (keys)

Check if all the required keywords arguments are present. Also check if every keyword is supported.

Package

adp-private.

Source

parameter.lisp.

Function: code-to-string (code)

Turn a code element into a string.

Package

adp-private.

Source

core.lisp.

Function: convert-string-case (str)
Package

adp-private.

Source

pprint-dispatch.lisp.

Function: copy-parameter (instance)
Package

adp-private.

Source

parameter.lisp.

Function: copy-table-element (instance)
Package

adp-private.

Source

tag-table.lisp.

Function: copy-writer (instance)
Package

adp-private.

Source

writer.lisp.

Function: custom-symbol-pprint-function (stream sym)

Return a custom pprint function to print symbols.

Package

adp-private.

Source

pprint-dispatch.lisp.

Function: declarationp (expr)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-accessor-function-names (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-allocation-types (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-class-name (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-class-options (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-default-initargs (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-documentation (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-initarg-names (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-initforms (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-metaclass (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-reader-function-names (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-slot-documentations (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-slot-names (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-slot-options (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-slot-specifiers (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-superclass-names (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-type-specifiers (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defclass-writer-function-names (defclass-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defconstant-documentation (defconstant-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defconstant-initial-value (defconstant-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defconstant-name (defconstant-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-argument-precedence-order (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-documentation (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-function-name (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-generic-function-class (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-gf-declarations (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-gf-lambda-list (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-method-class (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-method-combination (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-method-descriptions (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defgeneric-options (defgeneric-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-compiler-macro-declarations (define-compiler-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-compiler-macro-documentation (define-compiler-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-compiler-macro-forms (define-compiler-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-compiler-macro-lambda-list (define-compiler-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-compiler-macro-name (define-compiler-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-default-initargs (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-documentation (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-name (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-options (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-parent-types (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-report-name (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-accessors (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-allocations (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-initargs (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-initforms (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-names (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-options (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-readers (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-specs (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-types (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-condition-slot-writers (define-condition-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-arguments (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-declarations (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-descriptions (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-documentation (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-forms (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-generic-function (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-identity-with-one-argument (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-lambda-list (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-long-form-options (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-method-group-specifier-names (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-method-group-specifiers (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-name (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-operator (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-orders (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-predicates (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-qualifier-patterns (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-requireds (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-method-combination-short-form-options (define-method-combination-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-modify-macro-documentation (define-modify-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-modify-macro-function (define-modify-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-modify-macro-lambda-list (define-modify-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-modify-macro-name (define-modify-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-setf-expander-access-fn (define-setf-expander-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-setf-expander-declarations (define-setf-expander-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-setf-expander-documentation (define-setf-expander-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-setf-expander-forms (define-setf-expander-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-setf-expander-lambda-list (define-setf-expander-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-symbol-macro-expansion (define-symbol-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: define-symbol-macro-symbol (define-symbol-macro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmacro-declarations (defmacro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmacro-documentation (defmacro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmacro-forms (defmacro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmacro-lambda-list (defmacro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmacro-name (defmacro-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmethod-declarations (defmethod-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmethod-documentation (defmethod-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmethod-forms (defmethod-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmethod-function-name (defmethod-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmethod-method-qualifiers (defmethod-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defmethod-specialized-lambda-list (defmethod-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-defined-package-name (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-documentation (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-export-symbol-names (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-import-from-package-names (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-import-from-symbol-names (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-import-symbol-names (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-nicknames (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-options (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-shadow-symbol-names (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-shadowing-import-from-package-names (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-shadowing-import-from-symbol-names (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-size (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defpackage-use-package-names (defpackage-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defparameter-documentation (defparameter-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defparameter-initial-value (defparameter-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defparameter-name (defparameter-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defsetf-access-fn (defsetf-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defsetf-documentation (defsetf-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defsetf-update-fn (defsetf-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-conc-name (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-conc-name-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-constructor-arglists (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-constructor-names (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-constructor-options (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-copier-name (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-copier-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-documentation (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-include-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-include-option-slot-descriptors (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-included-structure-name (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-initial-offset (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-initial-offset-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-name-and-options (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-named-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-options (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-predicate-name (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-predicate-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-print-function-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-print-object-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-printer-name (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-printer-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-slot-descriptions (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-slot-initforms (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-slot-names (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-slot-options (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-slot-read-only-ps (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-slot-types (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-structure-name (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-type (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defstruct-type-option (defstruct-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: deftype-declarations (deftype-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: deftype-documentation (deftype-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: deftype-forms (deftype-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: deftype-lambda-list (deftype-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: deftype-name (deftype-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defun-declarations (defun-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defun-documentation (defun-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defun-forms (defun-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defun-function-name (defun-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defun-lambda-list (defun-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defvar-documentation (defvar-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defvar-initial-value (defvar-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: defvar-name (defvar-source)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: documentationp (expr)
Package

adp-style-maker.

Source

style-maker.lisp.

Function: file-headers (file)

Return the header-type elements of a file.

Package

adp-private.

Source

core.lisp.

Function: file-print (file stream)

Create a documentation file and prints the documentation in it.

Package

adp-private.

Source

core.lisp.

Function: file-push-element (file element)

Add an element in a file.

Package

adp-private.

Source

core.lisp.

Function: header-deep-level (header)

Return the level of deepness of a header.

Package

adp-private.

Source

core.lisp.

Function: load-project (system)
Package

adp.

Source

adp.lisp.

Function: load-style (style)

Load an adp style.

Package

adp.

Source

adp.lisp.

Function: make-custom-pprint-dispatch ()
Package

adp-private.

Source

pprint-dispatch.lisp.

Function: make-itemize-table (source-element tag-table reftype refname)
Package

adp-private.

Source

core.lisp.

Function: make-itemize-toc (source-element headers)
Package

adp-private.

Source

core.lisp.

Function: make-itemize-tof (source-element)
Package

adp-private.

Source

core.lisp.

Function: make-itemize-tos (source-element)
Package

adp-private.

Source

core.lisp.

Function: make-itemize-tot (source-element)
Package

adp-private.

Source

core.lisp.

Function: make-parameter (&key keyword symbol optional value)
Package

adp-private.

Source

parameter.lisp.

Function: make-table-element (&key elements used)
Package

adp-private.

Source

tag-table.lisp.

Function: make-toc-deep-levels (headers)

Return a vector of deepness levels the headers must have in a table of contents.

Package

adp-private.

Source

core.lisp.

Function: make-unique-tag ()
Package

adp.

Source

adp.lisp.

Function: make-writer (&key proc optional)
Package

adp-private.

Source

writer.lisp.

Reader: parameter-keyword (instance)
Writer: (setf parameter-keyword) (instance)
Package

adp-private.

Source

parameter.lisp.

Target Slot

keyword.

Reader: parameter-optional (instance)
Writer: (setf parameter-optional) (instance)
Package

adp-private.

Source

parameter.lisp.

Target Slot

optional.

Function: parameter-p (object)
Package

adp-private.

Source

parameter.lisp.

Reader: parameter-symbol (instance)
Writer: (setf parameter-symbol) (instance)
Package

adp-private.

Source

parameter.lisp.

Target Slot

symbol.

Reader: parameter-value (instance)
Writer: (setf parameter-value) (instance)
Package

adp-private.

Source

parameter.lisp.

Target Slot

value.

Function: perform-lisp-load-source (o c)

Perform the loading of a Lisp file as associated to specified action (O . C)

Package

adp.

Source

adp.lisp.

Function: plistp (code)

Check if an expression is a proper list.

Package

adp.

Source

adp.lisp.

Function: process-code-tag (tag code)

Process the forms recognized by code-tag.

Package

adp.

Source

adp.lisp.

Function: process-itemize (itemize-form)
Package

adp.

Source

adp.lisp.

Function: project-add-file (project file)

Add a file into a project.

Package

adp-private.

Source

core.lisp.

Function: project-find-file (project path)

Return a file whose path is PATH. If there is not a file with path PATH, return NIL.

Package

adp-private.

Source

core.lisp.

Function: project-headers (project)

Return the header-type elements of a project.

Package

adp-private.

Source

core.lisp.

Function: remove-code-tag (expr)

Remove the forms recognized by code-tag.

Package

adp.

Source

adp.lisp.

Function: set-style-parameter-values (args)
Package

adp-private.

Source

parameter.lisp.

Function: shortest-string (strings)

Return the shortest string from a list.

Package

adp-private.

Source

pprint-dispatch.lisp.

Function: split-symbols (symbols)
Package

adp-private.

Source

core.lisp.

Reader: table-element-elements (instance)
Writer: (setf table-element-elements) (instance)
Package

adp-private.

Source

tag-table.lisp.

Target Slot

elements.

Function: table-element-p (object)
Package

adp-private.

Source

tag-table.lisp.

Reader: table-element-used (instance)
Writer: (setf table-element-used) (instance)
Package

adp-private.

Source

tag-table.lisp.

Target Slot

used.

Function: tag-table-find-elements (tag-table tag)

Retrieve the elements associated with a tag and if the elements were certainly found. If the tag is not present, return nil.

Package

adp-private.

Source

tag-table.lisp.

Function: tag-table-find-elements-using-tag (tag-table tag)

Retrieve the elements associated with a tag and mark the tag as used. If the tag is not present, return nil.

Package

adp-private.

Source

tag-table.lisp.

Function: tag-table-push-element (tag-table tag element)

Associate an element with a tag. Multiple elements can be associated with the same tag.

Package

adp-private.

Source

tag-table.lisp.

Function: tag-table-set-element (tag-table tag element)

Associate an element with a tag. Multiple elements can be associated with the same tag.

Package

adp-private.

Source

tag-table.lisp.

Function: tag-table-tag-p (tag-table tag)

Check if a tag is present in the tag-table.

Package

adp-private.

Source

tag-table.lisp.

Function: tag-table-tags (tag-table)

Return the list of tags from a tag-table.

Package

adp-private.

Source

tag-table.lisp.

Function: tag-table-unused-elements (tag-table)

Return the list of unused elements.

Package

adp-private.

Source

tag-table.lisp.

Function: unset-style-parameter-values ()
Package

adp-private.

Source

parameter.lisp.

Function: valid-tag-p (tag tags)

Check if a tag is accepted by a list of tags.

Package

adp.

Source

adp.lisp.

Function: warn-unused-code-tags ()
Package

adp-private.

Source

core.lisp.

Function: warn-unused-header-tags ()
Package

adp-private.

Source

core.lisp.

Reader: writer-optional (instance)
Writer: (setf writer-optional) (instance)
Package

adp-private.

Source

writer.lisp.

Target Slot

optional.

Function: writer-p (object)
Package

adp-private.

Source

writer.lisp.

Reader: writer-proc (instance)
Writer: (setf writer-proc) (instance)
Package

adp-private.

Source

writer.lisp.

Target Slot

proc.


6.2.4 Generic functions

Generic Function: check-subelements (element)

Check the use of subelements.

Package

adp-private.

Source

core.lisp.

Methods
Method: check-subelements ((element itemize-type))
Method: check-subelements ((element table))
Method: check-subelements ((element text-element))
Method: check-subelements ((element text-subelement))
Method: check-subelements ((element element))
Generic Function: element-print (element stream)

Print an element into the stream.

Package

adp-private.

Source

core.lisp.

Methods
Method: element-print ((element0 defvar-definition) stream1)
Method: element-print ((element0 defun-definition) stream1)
Method: element-print ((element0 deftype-definition) stream1)
Method: element-print ((element0 defstruct-definition) stream1)
Method: element-print ((element0 defsetf-definition) stream1)
Method: element-print ((element0 defparameter-definition) stream1)
Method: element-print ((element0 defpackage-definition) stream1)
Method: element-print ((element0 defmethod-definition) stream1)
Method: element-print ((element0 defmacro-definition) stream1)
Method: element-print ((element0 define-symbol-macro-definition) stream1)
Method: element-print ((element0 define-setf-expander-definition) stream1)
Method: element-print ((element0 define-modify-macro-definition) stream1)
Method: element-print ((element0 define-method-combination-definition) stream1)
Method: element-print ((element0 define-condition-definition) stream1)
Method: element-print ((element0 define-compiler-macro-definition) stream1)
Method: element-print ((element0 defgeneric-definition) stream1)
Method: element-print ((element0 defconstant-definition) stream1)
Method: element-print ((element0 defclass-definition) stream1)
Method: element-print ((element code-example) stream)
Method: element-print ((element verbatim-code-block) stream)
Method: element-print ((element code-block) stream)
Method: element-print ((element table-of-types) stream)
Method: element-print ((element table-of-symbols) stream)
Method: element-print ((element table-of-functions) stream)
Method: element-print ((element mini-table-of-contents) stream)
Method: element-print ((element table-of-contents) stream)
Method: element-print ((element itemize) stream)
Method: element-print ((element table) stream)
Method: element-print ((element image) stream)
Method: element-print ((element web-link) stream)
Method: element-print ((element type-ref) stream)
Method: element-print ((element function-ref) stream)
Method: element-print ((element symbol-ref) stream)
Method: element-print ((element header-ref) stream)
Method: element-print ((element inline-code) stream)
Method: element-print ((element emphasis) stream)
Method: element-print ((element italic) stream)
Method: element-print ((element bold) stream)
Method: element-print ((element text) stream)
Method: element-print ((element subsubheader) stream)
Method: element-print ((element subheader) stream)
Method: element-print ((element header) stream)
Generic Function: process-itemize (element)

Turn an itemize element into a style-maker suitable representation.

Package

adp-private.

Source

core.lisp.

Methods
Method: process-itemize ((element item))
Method: process-itemize ((element itemize))
Method: process-itemize ((element enumerate))
Generic Function: text-type-to-string (text)

Turn a text element into a string.

Package

adp-private.

Source

core.lisp.

Methods
Method: text-type-to-string ((text text-subelement))
Method: text-type-to-string ((text text-element))

6.2.5 Conditions

Condition: already-defined-tag-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: source-element
Initargs

:source-element

Slot: previous-source-element
Initargs

:previous-source-element

Slot: tag
Initargs

:tag

Condition: file-not-selected-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: first-element
Initargs

:first-element

Condition: itemize-first-element-not-item-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: itemize
Initargs

:itemize

Slot: subelement
Initargs

:subelement

Condition: itemize-subelement-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: itemize
Initargs

:itemize

Slot: subelement
Initargs

:subelement

Condition: null-itemize-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: itemize
Initargs

:itemize

Condition: table-subelement-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: table
Initargs

:table

Slot: subelement
Initargs

:subelement

Condition: tag-not-defined-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: source-element
Initargs

:source-element

Slot: tag
Initargs

:tag

Condition: text-subelement-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: text
Initargs

:text

Slot: subelement
Initargs

:subelement

Condition: uninterned-tag-error
Package

adp-private.

Source

error.lisp.

Direct superclasses

error.

Direct slots
Slot: source-element
Initargs

:source-element

Slot: tag
Initargs

:tag


6.2.6 Structures

Structure: parameter
Package

adp-private.

Source

parameter.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: keyword
Package

common-lisp.

Readers

parameter-keyword.

Writers

(setf parameter-keyword).

Slot: symbol
Package

common-lisp.

Readers

parameter-symbol.

Writers

(setf parameter-symbol).

Slot: optional
Readers

parameter-optional.

Writers

(setf parameter-optional).

Slot: value
Readers

parameter-value.

Writers

(setf parameter-value).

Structure: table-element
Package

adp-private.

Source

tag-table.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: elements
Type

(vector adp-private::element)

Readers

table-element-elements.

Writers

(setf table-element-elements).

Slot: used
Type

boolean

Readers

table-element-used.

Writers

(setf table-element-used).

Structure: writer
Package

adp-private.

Source

writer.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: proc
Readers

writer-proc.

Writers

(setf writer-proc).

Slot: optional
Readers

writer-optional.

Writers

(setf writer-optional).


6.2.7 Classes

Class: code-block-type

Represent a code block type element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct subclasses
Direct slots
Slot: code-type
Type

string

Initargs

:code-type

Class: definition

Represent a definition element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct subclasses
Direct slots
Slot: expr
Initargs

:expr

Class: defintion
Package

adp-private.

Direct subclasses

define-compiler-macro-definition.

Class: element

Represent the most basic unit of documentation.

Package

adp-private.

Source

element.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: name
Initargs

:name

Slot: source-location
Type

pathname

Initargs

:source-location

Slot: file-location
Type

pathname

Class: file

Represents a unit of documentation that groups several elements.

Package

adp-private.

Source

file.lisp.

Direct slots
Slot: path
Type

pathname

Initargs

:path

Slot: elements
Type

(vector adp-private::element)

Initform

(make-array 100 :adjustable t :fill-pointer 0)

Class: file-table-of-contents

Represent a file related table of contents element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct subclasses
Direct methods

add-element.

Direct slots
Slot: file
Type

adp-private::file

Class: function-definition

Represent a function tag definition element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

tagged-definition.

Direct subclasses
Direct methods

add-element.

Class: header-type

Represents a header type element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

tagged-element.

Direct subclasses
Direct methods

add-element.

Direct slots
Slot: title
Type

string

Initargs

:title

Slot: user-tag-p
Type

boolean

Initargs

:user-tag-p

Class: itemize-type

Represents an itemize element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct subclasses
Direct methods

check-subelements.

Direct slots
Slot: elements
Type

list

Initargs

:elements

Class: load-doc-source-op

Operation for loading a Lisp file as source with ADP documentation.

Package

adp.

Source

adp.lisp.

Direct superclasses
  • basic-load-op.
  • downward-operation.
  • selfward-operation.
Direct methods
Direct slots
Slot: selfward-operation
Package

asdf/action.

Allocation

:class

Initform

(quote asdf/lisp-action:prepare-op)

Class: symbol-definition

Represent a symbol tag definition element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

tagged-definition.

Direct subclasses
Direct methods

add-element.

Class: tag-table

Relates a tag with an element.

Package

adp-private.

Source

tag-table.lisp.

Direct slots
Slot: table
Type

hash-table

Initform

(make-hash-table)

Class: tagged-definition

Represent a tagged definition element.

Package

adp-private.

Source

element.lisp.

Direct superclasses
Direct subclasses
Class: tagged-element

Represent an element that can be associated with a tag.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct subclasses
Direct slots
Slot: tag
Type

(or symbol null)

Initargs

:tag

Class: text-element

Represent a top level text element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

text-type.

Direct subclasses
Direct methods
Class: text-reference

Represent a text reference element.

Package

adp-private.

Source

element.lisp.

Direct superclasses
Direct subclasses
Class: text-subelement

Represent a text subelement type element.

Package

adp-private.

Source

element.lisp.

Direct superclasses
Direct subclasses
Direct methods
Class: text-subelement-type

Repreents a text subelement type.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct subclasses
Class: text-type

Represents a text type element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

element.

Direct subclasses
Direct slots
Slot: text-elements
Type

list

Initargs

:text-elements

Class: type-definition

Represent a type tag definition element.

Package

adp-private.

Source

element.lisp.

Direct superclasses

tagged-definition.

Direct subclasses
Direct methods

add-element.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   L   M   P   R   S   T   U   V   W  
Index Entry  Section

(
(setf parameter-keyword): Private ordinary functions
(setf parameter-optional): Private ordinary functions
(setf parameter-symbol): Private ordinary functions
(setf parameter-value): Private ordinary functions
(setf table-element-elements): Private ordinary functions
(setf table-element-used): Private ordinary functions
(setf writer-optional): Private ordinary functions
(setf writer-proc): Private ordinary functions

A
action-description: Public standalone methods
action-description: Public standalone methods
add-code-tag: Public ordinary functions
add-element: Public generic functions
add-element: Public generic functions
add-element: Public generic functions
add-element: Public generic functions
add-element: Public generic functions
add-element: Public generic functions
add-element: Public generic functions
add-element: Public generic functions
adp-reader-macro-dispatch: Private ordinary functions
adv-defmacro: Private macros
adv-defun: Private macros
adv-header: Private macros
adv-in-file: Private macros
adv-subheader: Private macros

B
bold: Public macros

C
cell: Public macros
check-code-comment: Private ordinary functions
check-code-hide: Private ordinary functions
check-code-remove: Private ordinary functions
check-component-symbols: Private ordinary functions
check-style-parameters: Private ordinary functions
check-subelements: Private generic functions
check-subelements: Private generic functions
check-subelements: Private generic functions
check-subelements: Private generic functions
check-subelements: Private generic functions
check-subelements: Private generic functions
check-writers: Public macros
cl-ref: Public macros
code-block: Public macros
code-comment: Public macros
code-example: Public macros
code-hide: Public macros
code-quote: Public macros
code-remove: Public macros
code-tag: Public macros
code-to-string: Private ordinary functions
convert-string-case: Private ordinary functions
copy-parameter: Private ordinary functions
copy-table-element: Private ordinary functions
copy-writer: Private ordinary functions
custom-symbol-pprint-function: Private ordinary functions

D
declarationp: Private ordinary functions
def-with-components: Private macros
defclass: Public macros
defclass-accessor-function-names: Private ordinary functions
defclass-allocation-types: Private ordinary functions
defclass-class-name: Private ordinary functions
defclass-class-options: Private ordinary functions
defclass-default-initargs: Private ordinary functions
defclass-documentation: Private ordinary functions
defclass-initarg-names: Private ordinary functions
defclass-initforms: Private ordinary functions
defclass-metaclass: Private ordinary functions
defclass-reader-function-names: Private ordinary functions
defclass-slot-documentations: Private ordinary functions
defclass-slot-names: Private ordinary functions
defclass-slot-options: Private ordinary functions
defclass-slot-specifiers: Private ordinary functions
defclass-superclass-names: Private ordinary functions
defclass-type-specifiers: Private ordinary functions
defclass-writer-function-names: Private ordinary functions
defconstant: Public macros
defconstant-documentation: Private ordinary functions
defconstant-initial-value: Private ordinary functions
defconstant-name: Private ordinary functions
defgeneric: Public macros
defgeneric-argument-precedence-order: Private ordinary functions
defgeneric-documentation: Private ordinary functions
defgeneric-function-name: Private ordinary functions
defgeneric-generic-function-class: Private ordinary functions
defgeneric-gf-declarations: Private ordinary functions
defgeneric-gf-lambda-list: Private ordinary functions
defgeneric-method-class: Private ordinary functions
defgeneric-method-combination: Private ordinary functions
defgeneric-method-descriptions: Private ordinary functions
defgeneric-options: Private ordinary functions
define-begin-file-writer: Private macros
define-begin-project-writer: Private macros
define-bold-writer: Public macros
define-check-writers: Private macros
define-code-block-writer: Public macros
define-code-example-writer: Public macros
define-compiler-macro: Public macros
define-compiler-macro-declarations: Private ordinary functions
define-compiler-macro-documentation: Private ordinary functions
define-compiler-macro-forms: Private ordinary functions
define-compiler-macro-lambda-list: Private ordinary functions
define-compiler-macro-name: Private ordinary functions
define-condition: Public macros
define-condition-default-initargs: Private ordinary functions
define-condition-documentation: Private ordinary functions
define-condition-name: Private ordinary functions
define-condition-options: Private ordinary functions
define-condition-parent-types: Private ordinary functions
define-condition-report-name: Private ordinary functions
define-condition-slot-accessors: Private ordinary functions
define-condition-slot-allocations: Private ordinary functions
define-condition-slot-initargs: Private ordinary functions
define-condition-slot-initforms: Private ordinary functions
define-condition-slot-names: Private ordinary functions
define-condition-slot-options: Private ordinary functions
define-condition-slot-readers: Private ordinary functions
define-condition-slot-specs: Private ordinary functions
define-condition-slot-types: Private ordinary functions
define-condition-slot-writers: Private ordinary functions
define-defclass-writer: Public macros
define-defconstant-writer: Public macros
define-defgeneric-writer: Public macros
define-define-compiler-macro-writer: Public macros
define-define-condition-writer: Public macros
define-define-method-combination-writer: Public macros
define-define-modify-macro-writer: Public macros
define-define-setf-expander-writer: Public macros
define-define-symbol-macro-writer: Public macros
define-definition-class: Private macros
define-definition-element-print: Private macros
define-definition-macro: Private macros
define-defmacro-writer: Public macros
define-defmethod-writer: Public macros
define-defpackage-writer: Public macros
define-defparameter-writer: Public macros
define-defsetf-writer: Public macros
define-defstruct-writer: Public macros
define-deftype-writer: Public macros
define-defun-writer: Public macros
define-defvar-writer: Public macros
define-emphasis-writer: Public macros
define-end-file-writer: Private macros
define-end-project-writer: Private macros
define-escape-text: Public macros
define-file-extension: Public macros
define-function-ref-writer: Public macros
define-header-macro: Private macros
define-header-ref-writer: Public macros
define-header-writer: Public macros
define-image-writer: Public macros
define-inline-code-writer: Public macros
define-italic-writer: Public macros
define-itemize-writer: Public macros
define-method-combination: Public macros
define-method-combination-arguments: Private ordinary functions
define-method-combination-declarations: Private ordinary functions
define-method-combination-descriptions: Private ordinary functions
define-method-combination-documentation: Private ordinary functions
define-method-combination-forms: Private ordinary functions
define-method-combination-generic-function: Private ordinary functions
define-method-combination-identity-with-one-argument: Private ordinary functions
define-method-combination-lambda-list: Private ordinary functions
define-method-combination-long-form-options: Private ordinary functions
define-method-combination-method-group-specifier-names: Private ordinary functions
define-method-combination-method-group-specifiers: Private ordinary functions
define-method-combination-name: Private ordinary functions
define-method-combination-operator: Private ordinary functions
define-method-combination-orders: Private ordinary functions
define-method-combination-predicates: Private ordinary functions
define-method-combination-qualifier-patterns: Private ordinary functions
define-method-combination-requireds: Private ordinary functions
define-method-combination-short-form-options: Private ordinary functions
define-modify-macro: Public macros
define-modify-macro-documentation: Private ordinary functions
define-modify-macro-function: Private ordinary functions
define-modify-macro-lambda-list: Private ordinary functions
define-modify-macro-name: Private ordinary functions
define-reference-macro: Private macros
define-setf-expander: Public macros
define-setf-expander-access-fn: Private ordinary functions
define-setf-expander-declarations: Private ordinary functions
define-setf-expander-documentation: Private ordinary functions
define-setf-expander-forms: Private ordinary functions
define-setf-expander-lambda-list: Private ordinary functions
define-style-parameter: Public macros
define-style-parameter: Public macros
define-subheader-writer: Public macros
define-subsubheader-writer: Public macros
define-symbol-macro: Public macros
define-symbol-macro-expansion: Private ordinary functions
define-symbol-macro-symbol: Private ordinary functions
define-symbol-ref-writer: Public macros
define-table-writer: Public macros
define-tag-tables: Private macros
define-tagged-definition-element-print: Private macros
define-text-enrichment-macro: Private macros
define-text-writer: Public macros
define-type-ref-writer: Public macros
define-web-link-writer: Public macros
define-with-tag-tables: Private macros
define-with-writers: Private macros
define-writer-definer: Private macros
define-writers: Private macros
defmacro: Public macros
defmacro-declarations: Private ordinary functions
defmacro-documentation: Private ordinary functions
defmacro-forms: Private ordinary functions
defmacro-lambda-list: Private ordinary functions
defmacro-name: Private ordinary functions
defmethod: Public macros
defmethod-declarations: Private ordinary functions
defmethod-documentation: Private ordinary functions
defmethod-forms: Private ordinary functions
defmethod-function-name: Private ordinary functions
defmethod-method-qualifiers: Private ordinary functions
defmethod-specialized-lambda-list: Private ordinary functions
defpackage: Public macros
defpackage-defined-package-name: Private ordinary functions
defpackage-documentation: Private ordinary functions
defpackage-export-symbol-names: Private ordinary functions
defpackage-import-from-package-names: Private ordinary functions
defpackage-import-from-symbol-names: Private ordinary functions
defpackage-import-symbol-names: Private ordinary functions
defpackage-nicknames: Private ordinary functions
defpackage-options: Private ordinary functions
defpackage-shadow-symbol-names: Private ordinary functions
defpackage-shadowing-import-from-package-names: Private ordinary functions
defpackage-shadowing-import-from-symbol-names: Private ordinary functions
defpackage-size: Private ordinary functions
defpackage-use-package-names: Private ordinary functions
defparameter: Public macros
defparameter-documentation: Private ordinary functions
defparameter-initial-value: Private ordinary functions
defparameter-name: Private ordinary functions
defsetf: Public macros
defsetf-access-fn: Private ordinary functions
defsetf-documentation: Private ordinary functions
defsetf-update-fn: Private ordinary functions
defstruct: Public macros
defstruct-conc-name: Private ordinary functions
defstruct-conc-name-option: Private ordinary functions
defstruct-constructor-arglists: Private ordinary functions
defstruct-constructor-names: Private ordinary functions
defstruct-constructor-options: Private ordinary functions
defstruct-copier-name: Private ordinary functions
defstruct-copier-option: Private ordinary functions
defstruct-documentation: Private ordinary functions
defstruct-include-option: Private ordinary functions
defstruct-include-option-slot-descriptors: Private ordinary functions
defstruct-included-structure-name: Private ordinary functions
defstruct-initial-offset: Private ordinary functions
defstruct-initial-offset-option: Private ordinary functions
defstruct-name-and-options: Private ordinary functions
defstruct-named-option: Private ordinary functions
defstruct-options: Private ordinary functions
defstruct-predicate-name: Private ordinary functions
defstruct-predicate-option: Private ordinary functions
defstruct-print-function-option: Private ordinary functions
defstruct-print-object-option: Private ordinary functions
defstruct-printer-name: Private ordinary functions
defstruct-printer-option: Private ordinary functions
defstruct-slot-descriptions: Private ordinary functions
defstruct-slot-initforms: Private ordinary functions
defstruct-slot-names: Private ordinary functions
defstruct-slot-options: Private ordinary functions
defstruct-slot-read-only-ps: Private ordinary functions
defstruct-slot-types: Private ordinary functions
defstruct-structure-name: Private ordinary functions
defstruct-type: Private ordinary functions
defstruct-type-option: Private ordinary functions
deftype: Public macros
deftype-declarations: Private ordinary functions
deftype-documentation: Private ordinary functions
deftype-forms: Private ordinary functions
deftype-lambda-list: Private ordinary functions
deftype-name: Private ordinary functions
defun: Public macros
defun-declarations: Private ordinary functions
defun-documentation: Private ordinary functions
defun-forms: Private ordinary functions
defun-function-name: Private ordinary functions
defun-lambda-list: Private ordinary functions
defvar: Public macros
defvar-documentation: Private ordinary functions
defvar-initial-value: Private ordinary functions
defvar-name: Private ordinary functions
documentationp: Private ordinary functions

E
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
element-print: Private generic functions
emphasis: Public macros
enumerate: Public macros
eval-when-adp: Private macros

F
file-headers: Private ordinary functions
file-print: Private ordinary functions
file-push-element: Private ordinary functions
Function, (setf parameter-keyword): Private ordinary functions
Function, (setf parameter-optional): Private ordinary functions
Function, (setf parameter-symbol): Private ordinary functions
Function, (setf parameter-value): Private ordinary functions
Function, (setf table-element-elements): Private ordinary functions
Function, (setf table-element-used): Private ordinary functions
Function, (setf writer-optional): Private ordinary functions
Function, (setf writer-proc): Private ordinary functions
Function, add-code-tag: Public ordinary functions
Function, adp-reader-macro-dispatch: Private ordinary functions
Function, check-code-comment: Private ordinary functions
Function, check-code-hide: Private ordinary functions
Function, check-code-remove: Private ordinary functions
Function, check-component-symbols: Private ordinary functions
Function, check-style-parameters: Private ordinary functions
Function, code-to-string: Private ordinary functions
Function, convert-string-case: Private ordinary functions
Function, copy-parameter: Private ordinary functions
Function, copy-table-element: Private ordinary functions
Function, copy-writer: Private ordinary functions
Function, custom-symbol-pprint-function: Private ordinary functions
Function, declarationp: Private ordinary functions
Function, defclass-accessor-function-names: Private ordinary functions
Function, defclass-allocation-types: Private ordinary functions
Function, defclass-class-name: Private ordinary functions
Function, defclass-class-options: Private ordinary functions
Function, defclass-default-initargs: Private ordinary functions
Function, defclass-documentation: Private ordinary functions
Function, defclass-initarg-names: Private ordinary functions
Function, defclass-initforms: Private ordinary functions
Function, defclass-metaclass: Private ordinary functions
Function, defclass-reader-function-names: Private ordinary functions
Function, defclass-slot-documentations: Private ordinary functions
Function, defclass-slot-names: Private ordinary functions
Function, defclass-slot-options: Private ordinary functions
Function, defclass-slot-specifiers: Private ordinary functions
Function, defclass-superclass-names: Private ordinary functions
Function, defclass-type-specifiers: Private ordinary functions
Function, defclass-writer-function-names: Private ordinary functions
Function, defconstant-documentation: Private ordinary functions
Function, defconstant-initial-value: Private ordinary functions
Function, defconstant-name: Private ordinary functions
Function, defgeneric-argument-precedence-order: Private ordinary functions
Function, defgeneric-documentation: Private ordinary functions
Function, defgeneric-function-name: Private ordinary functions
Function, defgeneric-generic-function-class: Private ordinary functions
Function, defgeneric-gf-declarations: Private ordinary functions
Function, defgeneric-gf-lambda-list: Private ordinary functions
Function, defgeneric-method-class: Private ordinary functions
Function, defgeneric-method-combination: Private ordinary functions
Function, defgeneric-method-descriptions: Private ordinary functions
Function, defgeneric-options: Private ordinary functions
Function, define-compiler-macro-declarations: Private ordinary functions
Function, define-compiler-macro-documentation: Private ordinary functions
Function, define-compiler-macro-forms: Private ordinary functions
Function, define-compiler-macro-lambda-list: Private ordinary functions
Function, define-compiler-macro-name: Private ordinary functions
Function, define-condition-default-initargs: Private ordinary functions
Function, define-condition-documentation: Private ordinary functions
Function, define-condition-name: Private ordinary functions
Function, define-condition-options: Private ordinary functions
Function, define-condition-parent-types: Private ordinary functions
Function, define-condition-report-name: Private ordinary functions
Function, define-condition-slot-accessors: Private ordinary functions
Function, define-condition-slot-allocations: Private ordinary functions
Function, define-condition-slot-initargs: Private ordinary functions
Function, define-condition-slot-initforms: Private ordinary functions
Function, define-condition-slot-names: Private ordinary functions
Function, define-condition-slot-options: Private ordinary functions
Function, define-condition-slot-readers: Private ordinary functions
Function, define-condition-slot-specs: Private ordinary functions
Function, define-condition-slot-types: Private ordinary functions
Function, define-condition-slot-writers: Private ordinary functions
Function, define-method-combination-arguments: Private ordinary functions
Function, define-method-combination-declarations: Private ordinary functions
Function, define-method-combination-descriptions: Private ordinary functions
Function, define-method-combination-documentation: Private ordinary functions
Function, define-method-combination-forms: Private ordinary functions
Function, define-method-combination-generic-function: Private ordinary functions
Function, define-method-combination-identity-with-one-argument: Private ordinary functions
Function, define-method-combination-lambda-list: Private ordinary functions
Function, define-method-combination-long-form-options: Private ordinary functions
Function, define-method-combination-method-group-specifier-names: Private ordinary functions
Function, define-method-combination-method-group-specifiers: Private ordinary functions
Function, define-method-combination-name: Private ordinary functions
Function, define-method-combination-operator: Private ordinary functions
Function, define-method-combination-orders: Private ordinary functions
Function, define-method-combination-predicates: Private ordinary functions
Function, define-method-combination-qualifier-patterns: Private ordinary functions
Function, define-method-combination-requireds: Private ordinary functions
Function, define-method-combination-short-form-options: Private ordinary functions
Function, define-modify-macro-documentation: Private ordinary functions
Function, define-modify-macro-function: Private ordinary functions
Function, define-modify-macro-lambda-list: Private ordinary functions
Function, define-modify-macro-name: Private ordinary functions
Function, define-setf-expander-access-fn: Private ordinary functions
Function, define-setf-expander-declarations: Private ordinary functions
Function, define-setf-expander-documentation: Private ordinary functions
Function, define-setf-expander-forms: Private ordinary functions
Function, define-setf-expander-lambda-list: Private ordinary functions
Function, define-symbol-macro-expansion: Private ordinary functions
Function, define-symbol-macro-symbol: Private ordinary functions
Function, defmacro-declarations: Private ordinary functions
Function, defmacro-documentation: Private ordinary functions
Function, defmacro-forms: Private ordinary functions
Function, defmacro-lambda-list: Private ordinary functions
Function, defmacro-name: Private ordinary functions
Function, defmethod-declarations: Private ordinary functions
Function, defmethod-documentation: Private ordinary functions
Function, defmethod-forms: Private ordinary functions
Function, defmethod-function-name: Private ordinary functions
Function, defmethod-method-qualifiers: Private ordinary functions
Function, defmethod-specialized-lambda-list: Private ordinary functions
Function, defpackage-defined-package-name: Private ordinary functions
Function, defpackage-documentation: Private ordinary functions
Function, defpackage-export-symbol-names: Private ordinary functions
Function, defpackage-import-from-package-names: Private ordinary functions
Function, defpackage-import-from-symbol-names: Private ordinary functions
Function, defpackage-import-symbol-names: Private ordinary functions
Function, defpackage-nicknames: Private ordinary functions
Function, defpackage-options: Private ordinary functions
Function, defpackage-shadow-symbol-names: Private ordinary functions
Function, defpackage-shadowing-import-from-package-names: Private ordinary functions
Function, defpackage-shadowing-import-from-symbol-names: Private ordinary functions
Function, defpackage-size: Private ordinary functions
Function, defpackage-use-package-names: Private ordinary functions
Function, defparameter-documentation: Private ordinary functions
Function, defparameter-initial-value: Private ordinary functions
Function, defparameter-name: Private ordinary functions
Function, defsetf-access-fn: Private ordinary functions
Function, defsetf-documentation: Private ordinary functions
Function, defsetf-update-fn: Private ordinary functions
Function, defstruct-conc-name: Private ordinary functions
Function, defstruct-conc-name-option: Private ordinary functions
Function, defstruct-constructor-arglists: Private ordinary functions
Function, defstruct-constructor-names: Private ordinary functions
Function, defstruct-constructor-options: Private ordinary functions
Function, defstruct-copier-name: Private ordinary functions
Function, defstruct-copier-option: Private ordinary functions
Function, defstruct-documentation: Private ordinary functions
Function, defstruct-include-option: Private ordinary functions
Function, defstruct-include-option-slot-descriptors: Private ordinary functions
Function, defstruct-included-structure-name: Private ordinary functions
Function, defstruct-initial-offset: Private ordinary functions
Function, defstruct-initial-offset-option: Private ordinary functions
Function, defstruct-name-and-options: Private ordinary functions
Function, defstruct-named-option: Private ordinary functions
Function, defstruct-options: Private ordinary functions
Function, defstruct-predicate-name: Private ordinary functions
Function, defstruct-predicate-option: Private ordinary functions
Function, defstruct-print-function-option: Private ordinary functions
Function, defstruct-print-object-option: Private ordinary functions
Function, defstruct-printer-name: Private ordinary functions
Function, defstruct-printer-option: Private ordinary functions
Function, defstruct-slot-descriptions: Private ordinary functions
Function, defstruct-slot-initforms: Private ordinary functions
Function, defstruct-slot-names: Private ordinary functions
Function, defstruct-slot-options: Private ordinary functions
Function, defstruct-slot-read-only-ps: Private ordinary functions
Function, defstruct-slot-types: Private ordinary functions
Function, defstruct-structure-name: Private ordinary functions
Function, defstruct-type: Private ordinary functions
Function, defstruct-type-option: Private ordinary functions
Function, deftype-declarations: Private ordinary functions
Function, deftype-documentation: Private ordinary functions
Function, deftype-forms: Private ordinary functions
Function, deftype-lambda-list: Private ordinary functions
Function, deftype-name: Private ordinary functions
Function, defun-declarations: Private ordinary functions
Function, defun-documentation: Private ordinary functions
Function, defun-forms: Private ordinary functions
Function, defun-function-name: Private ordinary functions
Function, defun-lambda-list: Private ordinary functions
Function, defvar-documentation: Private ordinary functions
Function, defvar-initial-value: Private ordinary functions
Function, defvar-name: Private ordinary functions
Function, documentationp: Private ordinary functions
Function, file-headers: Private ordinary functions
Function, file-print: Private ordinary functions
Function, file-push-element: Private ordinary functions
Function, header-deep-level: Private ordinary functions
Function, load-project: Private ordinary functions
Function, load-style: Private ordinary functions
Function, load-system: Public ordinary functions
Function, make-custom-pprint-dispatch: Private ordinary functions
Function, make-itemize-table: Private ordinary functions
Function, make-itemize-toc: Private ordinary functions
Function, make-itemize-tof: Private ordinary functions
Function, make-itemize-tos: Private ordinary functions
Function, make-itemize-tot: Private ordinary functions
Function, make-parameter: Private ordinary functions
Function, make-table-element: Private ordinary functions
Function, make-toc-deep-levels: Private ordinary functions
Function, make-unique-tag: Private ordinary functions
Function, make-writer: Private ordinary functions
Function, parameter-keyword: Private ordinary functions
Function, parameter-optional: Private ordinary functions
Function, parameter-p: Private ordinary functions
Function, parameter-symbol: Private ordinary functions
Function, parameter-value: Private ordinary functions
Function, perform-lisp-load-source: Private ordinary functions
Function, plistp: Private ordinary functions
Function, process-code-tag: Private ordinary functions
Function, process-itemize: Private ordinary functions
Function, project-add-file: Private ordinary functions
Function, project-find-file: Private ordinary functions
Function, project-headers: Private ordinary functions
Function, project-print: Public ordinary functions
Function, relative-truename: Public ordinary functions
Function, remove-code-tag: Private ordinary functions
Function, select-file: Public ordinary functions
Function, set-style-parameter-values: Private ordinary functions
Function, shortest-string: Private ordinary functions
Function, split-symbols: Private ordinary functions
Function, table-element-elements: Private ordinary functions
Function, table-element-p: Private ordinary functions
Function, table-element-used: Private ordinary functions
Function, tag-table-find-elements: Private ordinary functions
Function, tag-table-find-elements-using-tag: Private ordinary functions
Function, tag-table-push-element: Private ordinary functions
Function, tag-table-set-element: Private ordinary functions
Function, tag-table-tag-p: Private ordinary functions
Function, tag-table-tags: Private ordinary functions
Function, tag-table-unused-elements: Private ordinary functions
Function, unset-style-parameter-values: Private ordinary functions
Function, valid-tag-p: Private ordinary functions
Function, warn-unused-code-tags: Private ordinary functions
Function, warn-unused-header-tags: Private ordinary functions
Function, writer-optional: Private ordinary functions
Function, writer-p: Private ordinary functions
Function, writer-proc: Private ordinary functions
function-ref: Public macros

G
Generic Function, add-element: Public generic functions
Generic Function, check-subelements: Private generic functions
Generic Function, element-print: Private generic functions
Generic Function, process-itemize: Private generic functions
Generic Function, text-type-to-string: Private generic functions

H
header: Public macros
header-deep-level: Private ordinary functions
header-ref: Public macros

I
image: Public macros
in-file: Public macros
inline-code: Public macros
italic: Public macros
item: Public macros
itemize: Public macros

L
load-project: Private ordinary functions
load-style: Private ordinary functions
load-system: Public ordinary functions

M
Macro, adv-defmacro: Private macros
Macro, adv-defun: Private macros
Macro, adv-header: Private macros
Macro, adv-in-file: Private macros
Macro, adv-subheader: Private macros
Macro, bold: Public macros
Macro, cell: Public macros
Macro, check-writers: Public macros
Macro, cl-ref: Public macros
Macro, code-block: Public macros
Macro, code-comment: Public macros
Macro, code-example: Public macros
Macro, code-hide: Public macros
Macro, code-quote: Public macros
Macro, code-remove: Public macros
Macro, code-tag: Public macros
Macro, def-with-components: Private macros
Macro, defclass: Public macros
Macro, defconstant: Public macros
Macro, defgeneric: Public macros
Macro, define-begin-file-writer: Private macros
Macro, define-begin-project-writer: Private macros
Macro, define-bold-writer: Public macros
Macro, define-check-writers: Private macros
Macro, define-code-block-writer: Public macros
Macro, define-code-example-writer: Public macros
Macro, define-compiler-macro: Public macros
Macro, define-condition: Public macros
Macro, define-defclass-writer: Public macros
Macro, define-defconstant-writer: Public macros
Macro, define-defgeneric-writer: Public macros
Macro, define-define-compiler-macro-writer: Public macros
Macro, define-define-condition-writer: Public macros
Macro, define-define-method-combination-writer: Public macros
Macro, define-define-modify-macro-writer: Public macros
Macro, define-define-setf-expander-writer: Public macros
Macro, define-define-symbol-macro-writer: Public macros
Macro, define-definition-class: Private macros
Macro, define-definition-element-print: Private macros
Macro, define-definition-macro: Private macros
Macro, define-defmacro-writer: Public macros
Macro, define-defmethod-writer: Public macros
Macro, define-defpackage-writer: Public macros
Macro, define-defparameter-writer: Public macros
Macro, define-defsetf-writer: Public macros
Macro, define-defstruct-writer: Public macros
Macro, define-deftype-writer: Public macros
Macro, define-defun-writer: Public macros
Macro, define-defvar-writer: Public macros
Macro, define-emphasis-writer: Public macros
Macro, define-end-file-writer: Private macros
Macro, define-end-project-writer: Private macros
Macro, define-escape-text: Public macros
Macro, define-file-extension: Public macros
Macro, define-function-ref-writer: Public macros
Macro, define-header-macro: Private macros
Macro, define-header-ref-writer: Public macros
Macro, define-header-writer: Public macros
Macro, define-image-writer: Public macros
Macro, define-inline-code-writer: Public macros
Macro, define-italic-writer: Public macros
Macro, define-itemize-writer: Public macros
Macro, define-method-combination: Public macros
Macro, define-modify-macro: Public macros
Macro, define-reference-macro: Private macros
Macro, define-setf-expander: Public macros
Macro, define-style-parameter: Public macros
Macro, define-style-parameter: Public macros
Macro, define-subheader-writer: Public macros
Macro, define-subsubheader-writer: Public macros
Macro, define-symbol-macro: Public macros
Macro, define-symbol-ref-writer: Public macros
Macro, define-table-writer: Public macros
Macro, define-tag-tables: Private macros
Macro, define-tagged-definition-element-print: Private macros
Macro, define-text-enrichment-macro: Private macros
Macro, define-text-writer: Public macros
Macro, define-type-ref-writer: Public macros
Macro, define-web-link-writer: Public macros
Macro, define-with-tag-tables: Private macros
Macro, define-with-writers: Private macros
Macro, define-writer-definer: Private macros
Macro, define-writers: Private macros
Macro, defmacro: Public macros
Macro, defmethod: Public macros
Macro, defpackage: Public macros
Macro, defparameter: Public macros
Macro, defsetf: Public macros
Macro, defstruct: Public macros
Macro, deftype: Public macros
Macro, defun: Public macros
Macro, defvar: Public macros
Macro, emphasis: Public macros
Macro, enumerate: Public macros
Macro, eval-when-adp: Private macros
Macro, function-ref: Public macros
Macro, header: Public macros
Macro, header-ref: Public macros
Macro, image: Public macros
Macro, in-file: Public macros
Macro, inline-code: Public macros
Macro, italic: Public macros
Macro, item: Public macros
Macro, itemize: Public macros
Macro, mini-table-of-contents: Public macros
Macro, subheader: Public macros
Macro, subsubheader: Public macros
Macro, symbol-ref: Public macros
Macro, table: Public macros
Macro, table-of-contents: Public macros
Macro, table-of-functions: Public macros
Macro, table-of-symbols: Public macros
Macro, table-of-types: Public macros
Macro, text: Public macros
Macro, type-ref: Public macros
Macro, verbatim-code-block: Public macros
Macro, web-link: Public macros
Macro, with-defclass-components: Public macros
Macro, with-defconstant-components: Public macros
Macro, with-defgeneric-components: Public macros
Macro, with-define-compiler-macro-components: Public macros
Macro, with-define-condition-components: Public macros
Macro, with-define-method-combination-components: Public macros
Macro, with-define-modify-macro-components: Public macros
Macro, with-define-setf-expander-components: Public macros
Macro, with-define-symbol-macro-components: Public macros
Macro, with-defmacro-components: Public macros
Macro, with-defmethod-components: Public macros
Macro, with-defpackage-components: Public macros
Macro, with-defparameter-components: Public macros
Macro, with-defsetf-components: Public macros
Macro, with-defstruct-components: Public macros
Macro, with-deftype-components: Public macros
Macro, with-defun-components: Public macros
Macro, with-defvar-components: Public macros
Macro, with-new-style-parameter-list: Public macros
Macro, with-style-parameters: Public macros
Macro, with-tag-tables: Public macros
Macro, with-writers: Public macros
make-custom-pprint-dispatch: Private ordinary functions
make-itemize-table: Private ordinary functions
make-itemize-toc: Private ordinary functions
make-itemize-tof: Private ordinary functions
make-itemize-tos: Private ordinary functions
make-itemize-tot: Private ordinary functions
make-parameter: Private ordinary functions
make-table-element: Private ordinary functions
make-toc-deep-levels: Private ordinary functions
make-unique-tag: Private ordinary functions
make-writer: Private ordinary functions
Method, action-description: Public standalone methods
Method, action-description: Public standalone methods
Method, add-element: Public generic functions
Method, add-element: Public generic functions
Method, add-element: Public generic functions
Method, add-element: Public generic functions
Method, add-element: Public generic functions
Method, add-element: Public generic functions
Method, add-element: Public generic functions
Method, check-subelements: Private generic functions
Method, check-subelements: Private generic functions
Method, check-subelements: Private generic functions
Method, check-subelements: Private generic functions
Method, check-subelements: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, element-print: Private generic functions
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, process-itemize: Private generic functions
Method, process-itemize: Private generic functions
Method, process-itemize: Private generic functions
Method, text-type-to-string: Private generic functions
Method, text-type-to-string: Private generic functions
mini-table-of-contents: Public macros

P
parameter-keyword: Private ordinary functions
parameter-optional: Private ordinary functions
parameter-p: Private ordinary functions
parameter-symbol: Private ordinary functions
parameter-value: Private ordinary functions
perform: Public standalone methods
perform: Public standalone methods
perform-lisp-load-source: Private ordinary functions
plistp: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
process-code-tag: Private ordinary functions
process-itemize: Private ordinary functions
process-itemize: Private generic functions
process-itemize: Private generic functions
process-itemize: Private generic functions
process-itemize: Private generic functions
project-add-file: Private ordinary functions
project-find-file: Private ordinary functions
project-headers: Private ordinary functions
project-print: Public ordinary functions

R
relative-truename: Public ordinary functions
remove-code-tag: Private ordinary functions

S
select-file: Public ordinary functions
set-style-parameter-values: Private ordinary functions
shortest-string: Private ordinary functions
split-symbols: Private ordinary functions
subheader: Public macros
subsubheader: Public macros
symbol-ref: Public macros

T
table: Public macros
table-element-elements: Private ordinary functions
table-element-p: Private ordinary functions
table-element-used: Private ordinary functions
table-of-contents: Public macros
table-of-functions: Public macros
table-of-symbols: Public macros
table-of-types: Public macros
tag-table-find-elements: Private ordinary functions
tag-table-find-elements-using-tag: Private ordinary functions
tag-table-push-element: Private ordinary functions
tag-table-set-element: Private ordinary functions
tag-table-tag-p: Private ordinary functions
tag-table-tags: Private ordinary functions
tag-table-unused-elements: Private ordinary functions
text: Public macros
text-type-to-string: Private generic functions
text-type-to-string: Private generic functions
text-type-to-string: Private generic functions
type-ref: Public macros

U
unset-style-parameter-values: Private ordinary functions

V
valid-tag-p: Private ordinary functions
verbatim-code-block: Public macros

W
warn-unused-code-tags: Private ordinary functions
warn-unused-header-tags: Private ordinary functions
web-link: Public macros
with-defclass-components: Public macros
with-defconstant-components: Public macros
with-defgeneric-components: Public macros
with-define-compiler-macro-components: Public macros
with-define-condition-components: Public macros
with-define-method-combination-components: Public macros
with-define-modify-macro-components: Public macros
with-define-setf-expander-components: Public macros
with-define-symbol-macro-components: Public macros
with-defmacro-components: Public macros
with-defmethod-components: Public macros
with-defpackage-components: Public macros
with-defparameter-components: Public macros
with-defsetf-components: Public macros
with-defstruct-components: Public macros
with-deftype-components: Public macros
with-defun-components: Public macros
with-defvar-components: Public macros
with-new-style-parameter-list: Public macros
with-style-parameters: Public macros
with-tag-tables: Public macros
with-writers: Public macros
writer-optional: Private ordinary functions
writer-p: Private ordinary functions
writer-proc: Private ordinary functions


A.3 Variables

Jump to:   *  
A   C   E   F   I   K   N   O   P   R   S   T   U   V  
Index Entry  Section

*
*adp*: Private special variables
*adp-pprint-dispatch*: Public special variables
*adp-pprint-dispatch*: Public special variables
*begin-file-writer*: Public special variables
*begin-project-writer*: Public special variables
*bold-writer*: Public special variables
*code-block-writer*: Public special variables
*code-example-writer*: Public special variables
*code-tags*: Private special variables
*defclass-writer*: Public special variables
*defconstant-writer*: Public special variables
*defgeneric-writer*: Public special variables
*define-compiler-macro-writer*: Public special variables
*define-condition-writer*: Public special variables
*define-method-combination-writer*: Public special variables
*define-modify-macro-writer*: Public special variables
*define-setf-expander-writer*: Public special variables
*define-symbol-macro-writer*: Public special variables
*defmacro-writer*: Public special variables
*defmethod-writer*: Public special variables
*defpackage-writer*: Public special variables
*defparameter-writer*: Public special variables
*defsetf-writer*: Public special variables
*defstruct-writer*: Public special variables
*deftype-writer*: Public special variables
*defun-writer*: Public special variables
*defvar-writer*: Public special variables
*emphasis-writer*: Public special variables
*end-file-writer*: Public special variables
*end-project-writer*: Public special variables
*escape-text*: Public special variables
*file-extension*: Public special variables
*function-ref-writer*: Public special variables
*function-tags*: Private special variables
*header-ref-writer*: Public special variables
*header-tag-counter*: Private special variables
*header-tags*: Private special variables
*header-writer*: Public special variables
*image-writer*: Public special variables
*inline-code-writer*: Public special variables
*italic-writer*: Public special variables
*itemize-writer*: Public special variables
*project*: Private special variables
*style-parameters*: Private special variables
*subheader-writer*: Public special variables
*subsubheader-writer*: Public special variables
*symbol-ref-writer*: Public special variables
*symbol-tags*: Private special variables
*table-writer*: Public special variables
*text-writer*: Public special variables
*type-ref-writer*: Public special variables
*type-tags*: Private special variables
*web-link-writer*: Public special variables

A
address: Public classes
alt-text: Public classes

C
code-elements: Public classes
code-elements: Public classes
code-tags: Public classes
code-text: Public classes
code-type: Private classes
comment: Public classes
current-file: Public classes

E
elements: Private structures
elements: Private classes
elements: Private classes
expr: Public classes
expr: Public classes
expr: Private classes

F
file: Private classes
file-location: Private classes
files: Public classes
first-element: Private conditions

I
itemize: Private conditions
itemize: Private conditions
itemize: Private conditions

K
keyword: Private structures

N
name: Private classes

O
optional: Private structures
optional: Private structures
output: Public classes

P
path: Public classes
path: Private classes
previous-source-element: Private conditions
proc: Private structures
project: Public classes

R
result: Public classes
root-directory: Public classes
rows: Public classes

S
selfward-operation: Private classes
Slot, address: Public classes
Slot, alt-text: Public classes
Slot, code-elements: Public classes
Slot, code-elements: Public classes
Slot, code-tags: Public classes
Slot, code-text: Public classes
Slot, code-type: Private classes
Slot, comment: Public classes
Slot, current-file: Public classes
Slot, elements: Private structures
Slot, elements: Private classes
Slot, elements: Private classes
Slot, expr: Public classes
Slot, expr: Public classes
Slot, expr: Private classes
Slot, file: Private classes
Slot, file-location: Private classes
Slot, files: Public classes
Slot, first-element: Private conditions
Slot, itemize: Private conditions
Slot, itemize: Private conditions
Slot, itemize: Private conditions
Slot, keyword: Private structures
Slot, name: Private classes
Slot, optional: Private structures
Slot, optional: Private structures
Slot, output: Public classes
Slot, path: Public classes
Slot, path: Private classes
Slot, previous-source-element: Private conditions
Slot, proc: Private structures
Slot, project: Public classes
Slot, result: Public classes
Slot, root-directory: Public classes
Slot, rows: Public classes
Slot, selfward-operation: Private classes
Slot, source-element: Private conditions
Slot, source-element: Private conditions
Slot, source-element: Private conditions
Slot, source-location: Private classes
Slot, subelement: Private conditions
Slot, subelement: Private conditions
Slot, subelement: Private conditions
Slot, subelement: Private conditions
Slot, symbol: Private structures
Slot, table: Private conditions
Slot, table: Private classes
Slot, tag: Private conditions
Slot, tag: Private conditions
Slot, tag: Private conditions
Slot, tag: Private classes
Slot, text: Public classes
Slot, text: Private conditions
Slot, text-elements: Private classes
Slot, title: Private classes
Slot, used: Private structures
Slot, user-tag-p: Private classes
Slot, value: Private structures
source-element: Private conditions
source-element: Private conditions
source-element: Private conditions
source-location: Private classes
Special Variable, *adp*: Private special variables
Special Variable, *adp-pprint-dispatch*: Public special variables
Special Variable, *adp-pprint-dispatch*: Public special variables
Special Variable, *begin-file-writer*: Public special variables
Special Variable, *begin-project-writer*: Public special variables
Special Variable, *bold-writer*: Public special variables
Special Variable, *code-block-writer*: Public special variables
Special Variable, *code-example-writer*: Public special variables
Special Variable, *code-tags*: Private special variables
Special Variable, *defclass-writer*: Public special variables
Special Variable, *defconstant-writer*: Public special variables
Special Variable, *defgeneric-writer*: Public special variables
Special Variable, *define-compiler-macro-writer*: Public special variables
Special Variable, *define-condition-writer*: Public special variables
Special Variable, *define-method-combination-writer*: Public special variables
Special Variable, *define-modify-macro-writer*: Public special variables
Special Variable, *define-setf-expander-writer*: Public special variables
Special Variable, *define-symbol-macro-writer*: Public special variables
Special Variable, *defmacro-writer*: Public special variables
Special Variable, *defmethod-writer*: Public special variables
Special Variable, *defpackage-writer*: Public special variables
Special Variable, *defparameter-writer*: Public special variables
Special Variable, *defsetf-writer*: Public special variables
Special Variable, *defstruct-writer*: Public special variables
Special Variable, *deftype-writer*: Public special variables
Special Variable, *defun-writer*: Public special variables
Special Variable, *defvar-writer*: Public special variables
Special Variable, *emphasis-writer*: Public special variables
Special Variable, *end-file-writer*: Public special variables
Special Variable, *end-project-writer*: Public special variables
Special Variable, *escape-text*: Public special variables
Special Variable, *file-extension*: Public special variables
Special Variable, *function-ref-writer*: Public special variables
Special Variable, *function-tags*: Private special variables
Special Variable, *header-ref-writer*: Public special variables
Special Variable, *header-tag-counter*: Private special variables
Special Variable, *header-tags*: Private special variables
Special Variable, *header-writer*: Public special variables
Special Variable, *image-writer*: Public special variables
Special Variable, *inline-code-writer*: Public special variables
Special Variable, *italic-writer*: Public special variables
Special Variable, *itemize-writer*: Public special variables
Special Variable, *project*: Private special variables
Special Variable, *style-parameters*: Private special variables
Special Variable, *subheader-writer*: Public special variables
Special Variable, *subsubheader-writer*: Public special variables
Special Variable, *symbol-ref-writer*: Public special variables
Special Variable, *symbol-tags*: Private special variables
Special Variable, *table-writer*: Public special variables
Special Variable, *text-writer*: Public special variables
Special Variable, *type-ref-writer*: Public special variables
Special Variable, *type-tags*: Private special variables
Special Variable, *web-link-writer*: Public special variables
subelement: Private conditions
subelement: Private conditions
subelement: Private conditions
subelement: Private conditions
symbol: Private structures

T
table: Private conditions
table: Private classes
tag: Private conditions
tag: Private conditions
tag: Private conditions
tag: Private classes
text: Public classes
text: Private conditions
text-elements: Private classes
title: Private classes

U
used: Private structures
user-tag-p: Private classes

V
value: Private structures


A.4 Data types

Jump to:   A   B   C   D   E   F   H   I   L   M   N   P   S   T   U   V   W  
Index Entry  Section

A
adp: The adp system
adp: The adp package
adp-private: The adp-private package
adp-style-maker: The adp-style-maker package
adp.asd: The adp/adp․asd file
adp.lisp: The adp/src/adp․lisp file
already-defined-tag-error: Private conditions

B
bold: Public classes

C
cell: Public classes
Class, bold: Public classes
Class, cell: Public classes
Class, code: Public classes
Class, code-block: Public classes
Class, code-block-type: Private classes
Class, code-comment: Public classes
Class, code-example: Public classes
Class, code-hide: Public classes
Class, code-ref: Public classes
Class, defclass-definition: Public classes
Class, defconstant-definition: Public classes
Class, defgeneric-definition: Public classes
Class, define-compiler-macro-definition: Public classes
Class, define-condition-definition: Public classes
Class, define-method-combination-definition: Public classes
Class, define-modify-macro-definition: Public classes
Class, define-setf-expander-definition: Public classes
Class, define-symbol-macro-definition: Public classes
Class, definition: Private classes
Class, defintion: Private classes
Class, defmacro-definition: Public classes
Class, defmethod-definition: Public classes
Class, defpackage-definition: Public classes
Class, defparameter-definition: Public classes
Class, defsetf-definition: Public classes
Class, defstruct-definition: Public classes
Class, deftype-definition: Public classes
Class, defun-definition: Public classes
Class, defvar-definition: Public classes
Class, element: Private classes
Class, emphasis: Public classes
Class, enumerate: Public classes
Class, file: Private classes
Class, file-table-of-contents: Private classes
Class, function-definition: Private classes
Class, function-ref: Public classes
Class, header: Public classes
Class, header-ref: Public classes
Class, header-type: Private classes
Class, image: Public classes
Class, inline-code: Public classes
Class, italic: Public classes
Class, item: Public classes
Class, itemize: Public classes
Class, itemize-type: Private classes
Class, load-doc-source-op: Private classes
Class, mini-table-of-contents: Public classes
Class, project: Public classes
Class, subheader: Public classes
Class, subsubheader: Public classes
Class, symbol-definition: Private classes
Class, symbol-ref: Public classes
Class, table: Public classes
Class, table-of-contents: Public classes
Class, table-of-functions: Public classes
Class, table-of-symbols: Public classes
Class, table-of-types: Public classes
Class, tag-table: Private classes
Class, tagged-code: Public classes
Class, tagged-definition: Private classes
Class, tagged-element: Private classes
Class, text: Public classes
Class, text-element: Private classes
Class, text-reference: Private classes
Class, text-subelement: Private classes
Class, text-subelement-type: Private classes
Class, text-type: Private classes
Class, type-definition: Private classes
Class, type-ref: Public classes
Class, verbatim-code-block: Public classes
Class, web-link: Public classes
code: Public classes
code-block: Public classes
code-block-type: Private classes
code-comment: Public classes
code-example: Public classes
code-hide: Public classes
code-ref: Public classes
Condition, already-defined-tag-error: Private conditions
Condition, file-not-selected-error: Private conditions
Condition, itemize-first-element-not-item-error: Private conditions
Condition, itemize-subelement-error: Private conditions
Condition, null-itemize-error: Private conditions
Condition, table-subelement-error: Private conditions
Condition, tag-not-defined-error: Private conditions
Condition, text-subelement-error: Private conditions
Condition, uninterned-tag-error: Private conditions
core.lisp: The adp/src/core․lisp file

D
defclass-definition: Public classes
defconstant-definition: Public classes
defgeneric-definition: Public classes
define-compiler-macro-definition: Public classes
define-condition-definition: Public classes
define-method-combination-definition: Public classes
define-modify-macro-definition: Public classes
define-setf-expander-definition: Public classes
define-symbol-macro-definition: Public classes
definition: Private classes
defintion: Private classes
defmacro-definition: Public classes
defmethod-definition: Public classes
defpackage-definition: Public classes
defparameter-definition: Public classes
defsetf-definition: Public classes
defstruct-definition: Public classes
deftype-definition: Public classes
defun-definition: Public classes
defvar-definition: Public classes

E
element: Private classes
element.lisp: The adp/src/element․lisp file
emphasis: Public classes
enumerate: Public classes
error.lisp: The adp/src/error․lisp file

F
file: Private classes
File, adp.asd: The adp/adp․asd file
File, adp.lisp: The adp/src/adp․lisp file
File, core.lisp: The adp/src/core․lisp file
File, element.lisp: The adp/src/element․lisp file
File, error.lisp: The adp/src/error․lisp file
File, file.lisp: The adp/src/file․lisp file
File, package.lisp: The adp/package․lisp file
File, parameter.lisp: The adp/src/parameter․lisp file
File, pprint-dispatch.lisp: The adp/src/pprint-dispatch․lisp file
File, project.lisp: The adp/src/project․lisp file
File, style-maker.lisp: The adp/src/style-maker․lisp file
File, tag-table.lisp: The adp/src/tag-table․lisp file
File, writer.lisp: The adp/src/writer․lisp file
file-not-selected-error: Private conditions
file-table-of-contents: Private classes
file.lisp: The adp/src/file․lisp file
function-definition: Private classes
function-ref: Public classes

H
header: Public classes
header-ref: Public classes
header-type: Private classes

I
image: Public classes
inline-code: Public classes
italic: Public classes
item: Public classes
itemize: Public classes
itemize-first-element-not-item-error: Private conditions
itemize-subelement-error: Private conditions
itemize-type: Private classes

L
load-doc-source-op: Private classes

M
mini-table-of-contents: Public classes
Module, src: The adp/src module

N
null-itemize-error: Private conditions

P
Package, adp: The adp package
Package, adp-private: The adp-private package
Package, adp-style-maker: The adp-style-maker package
package.lisp: The adp/package․lisp file
parameter: Private structures
parameter.lisp: The adp/src/parameter․lisp file
pprint-dispatch.lisp: