The adp Reference Manual

This is the adp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 19:21:48 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 adp

Add Documentation, Please. A documentation generator.

Author

Héctor Galbis Sanchis

License

The Unlicense

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

adp.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 adp/adp.asd

Source

adp.asd.

Parent Component

adp (system).

ASDF Systems

adp.


3.1.2 adp/package.lisp

Source

adp.asd.

Parent Component

adp (system).

Packages

3.1.3 adp/adp-core.lisp

Source

adp.asd.

Parent Component

adp (system).

Public Interface
Internals

3.1.4 adp/adp.lisp

Source

adp.asd.

Parent Component

adp (system).

Public Interface
Internals

3.1.5 adp/adp-writers.lisp

Source

adp.asd.

Parent Component

adp (system).

Public Interface
Internals

def-customizable-writer (macro).


3.1.6 adp/helper-style-functions.lisp

Source

adp.asd.

Parent Component

adp (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 adp-private

Source

package.lisp.

Nickname

adppvt

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

4.2 adp

Source

package.lisp.

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

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *add-documentation*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *custom-pprint-dispatch*

An extension of *print-pprint-dispatch*. The define functions (like defun) from adp will be printed with pretty indentation as if they were from cl. Internal symbols will be printed without the package extension even if *print-escape* is true. Besides, the shortest package nickname will be printed as the package extension of a symbol.

Package

adp-private.

Source

helper-style-functions.lisp.

Special Variable: *file-adp-elements*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *function-tags*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *header-tags*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *symbol-tags*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *type-tags*
Package

adp-private.

Source

adp-core.lisp.


5.1.2 Macros

Macro: bold (&rest args)

Add bold style to text when using the macros text, table or itemize. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: bold-italic (&rest args)

Add bold and italic style to text when using the macros text, table or itemize. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: cl-ref (sym)

Add a reference to a Common Lisp symbol when using the macros text, table or itemize.

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

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-inline (&rest code)

Add inlined style to text when using the macros text, table or itemize. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: code-tag (tags &body code)

Assign several tags to a piece of code. The code is placed into a progn form. The argument tags must be a list
of symbols. If no tags are provided, then code-tag will do nothing. Each symbol in tags will be a code-tag assigned to code. Inside the code-tag form it is correct to use a (code-hide tags &rest forms) form. It only indicates to code-tag
which parts of code can be hidden when using the tag in the macro code-block. code-hide accepts also a list of tags. If a tag used in code-tag also appears in code-hide, that piece of code will be hidden when using the macro code-block. If the list of tags in code-hide is empty, the that piece of code will be hidden for every tag used in code-tag.

Package

adp.

Source

adp.lisp.

Macro: def-bold-italic-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-bold-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-code-block-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-code-example-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-code-inline-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defclass-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defconstant-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defgeneric-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-define-compiler-macro-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-define-condition-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-define-method-combination-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-define-modify-macro-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-define-setf-expander-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-define-symbol-macro-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defmacro-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defmethod-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defpackage-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defparameter-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defsetf-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defstruct-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-deftype-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defun-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-defvar-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-file-foot-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-file-header-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-function-ref-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-get-file-extension-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-header-ref-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-header-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-image-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-italic-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-itemize-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

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

adp-private.

Source

adp-writers.lisp.

Macro: def-subheader-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-subsubheader-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-symbol-ref-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-system-files-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-table-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-text-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Macro: def-type-ref-writer (writer-args1 &body body-arg2)
Package

adp-private.

Source

adp-writers.lisp.

Package

adp-private.

Source

adp-writers.lisp.

Macro: defclass (&body defclass-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 defconstant-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 defgeneric-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-compiler-macro (&body define-compiler-macro-body)

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

Package

adp.

Source

adp.lisp.

Macro: define-condition (&body define-condition-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-method-combination (&body define-method-combination-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 define-modify-macro-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 define-setf-expander-body)

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

Package

adp.

Source

adp.lisp.

Macro: define-symbol-macro (&body define-symbol-macro-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: defmacro (&body defmacro-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 defmethod-body)

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

Package

adp.

Source

adp.lisp.

Macro: defpackage (&body defpackage-body)

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

Package

adp.

Source

adp.lisp.

Macro: defparameter (&body defparameter-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 defsetf-body)

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

Package

adp.

Source

adp.lisp.

Macro: defstruct (&body defstruct-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 deftype-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 defun-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 defvar-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: function-ref (tag)

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

Package

adp.

Source

adp.lisp.

Macro: header (str &optional tag)

Add a header with name str. Also, if tag is not nil but a 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, table or itemize. The argument is a symbol denoting a header-tag. Only the symbols used with the macros header, subheader and subsubheader are valid.

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: italic (&rest args)

Add italic style to text when using the macros text, table or itemize. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: itemize (&rest items)

Add a list of items. Each argument must be a list. Each list must have as first argument the keyword :item or :itemize. If :item is used, the rest of the elements in that list will be treated as if using the macro text. If :itemize is used the rest of elements must be lists where its first elements are the keywords :item or :itemize. In other words, when :itemize is used a nested list is added.

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)

Same as header, but add a subheader.

Package

adp.

Source

adp.lisp.

Macro: subsubheader (str &optional tag)

Same as header, but add a subsubheader.

Package

adp.

Source

adp.lisp.

Macro: symbol-ref (tag)

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

Package

adp.

Source

adp.lisp.

Macro: table (&rest rows)

Add a table. Each argument must be a list of lists. Each inner list must have as first element the keyword :cell and the rest are treated as if using the macro text.

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, bold-italic, code-inline, 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, table or itemize. 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.

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-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defconstant-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defgeneric-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-define-compiler-macro-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-define-condition-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-define-method-combination-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-define-modify-macro-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-define-setf-expander-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-define-symbol-macro-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defmacro-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defmethod-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defpackage-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defparameter-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defsetf-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defstruct-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-deftype-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defun-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: with-defvar-components (((&rest component-rest-args0) function-body-arg1) &body body-arg2)
Package

adp-private.

Source

helper-style-functions.lisp.

Macro: write-in-file (file-path)

Associate all the information gathered so far with the pathname file-path. This will cause the creation of a file where all the information will be printed in. The pathname will be considered relative to the system’s root directory. Only the directory and name parts of file-path are considered. The rest are ignored (including the extension). This macro can be used multiple times.

Package

adp.

Source

adp.lisp.


5.1.3 Ordinary functions

Function: add-code-tag (tag &rest list-code)
Package

adp-private.

Source

adp-core.lisp.

Function: add-function-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: add-header-tag (tag str)
Package

adp-private.

Source

adp-core.lisp.

Function: add-symbol-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: add-type-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: check-current-procs ()
Package

adp-private.

Source

adp-core.lisp.

Function: check-style-parameters (style-params)
Package

adp-private.

Source

adp-core.lisp.

Function: create-bold-italic-text (&rest args)
Package

adp-private.

Source

adp-core.lisp.

Function: create-bold-text (&rest args)
Package

adp-private.

Source

adp-core.lisp.

Function: create-code-block-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: create-code-inline-text (&rest args)
Package

adp-private.

Source

adp-core.lisp.

Function: create-function-ref-text (label)
Package

adp-private.

Source

adp-core.lisp.

Function: create-header-ref-text (label)
Package

adp-private.

Source

adp-core.lisp.

Function: create-italic-text (&rest args)
Package

adp-private.

Source

adp-core.lisp.

Function: create-symbol-ref-text (label)
Package

adp-private.

Source

adp-core.lisp.

Function: create-type-ref-text (label)
Package

adp-private.

Source

adp-core.lisp.

Package

adp-private.

Source

adp-core.lisp.

Function: custom-prin1 (code &optional stream hide-str)

It is like prin1, but uses *custom-pprint-dispatch* instead. Also, if hidden code is found, then hide-str is princ-ed.

Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defclass-documentation (defclass-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defclass-initforms (defclass-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defclass-metaclass (defclass-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defconstant-documentation (defconstant-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defconstant-name (defconstant-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defgeneric-documentation (defgeneric-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defgeneric-options (defgeneric-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defmacro-declarations (defmacro-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defmacro-documentation (defmacro-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defmacro-forms (defmacro-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defmacro-name (defmacro-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defmethod-declarations (defmethod-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defmethod-documentation (defmethod-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defmethod-forms (defmethod-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defpackage-nicknames (defpackage-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defpackage-options (defpackage-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defpackage-size (defpackage-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defparameter-documentation (defparameter-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defparameter-name (defparameter-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defsetf-documentation (defsetf-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defstruct-documentation (defstruct-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defstruct-options (defstruct-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defstruct-type (defstruct-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: deftype-declarations (deftype-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: deftype-documentation (deftype-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: deftype-forms (deftype-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: deftype-name (deftype-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defun-declarations (defun-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defun-documentation (defun-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defun-forms (defun-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defvar-documentation (defvar-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: defvar-name (defvar-source)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: emplace-adp-element (key-type &rest contents)
Package

adp-private.

Source

adp-core.lisp.

Function: empty-function-tags ()
Package

adp-private.

Source

adp-core.lisp.

Function: empty-header-tags ()
Package

adp-private.

Source

adp-core.lisp.

Function: empty-symbol-tags ()
Package

adp-private.

Source

adp-core.lisp.

Function: empty-type-tags ()
Package

adp-private.

Source

adp-core.lisp.

Function: get-code-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: hide-symbolp (code)
Package

adp-private.

Source

adp-core.lisp.

Function: load-documentation-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: process-code-tag (tag code)
Package

adp-private.

Source

adp-core.lisp.

Function: push-adp-file (path)
Package

adp-private.

Source

adp-core.lisp.

Function: remove-code-tag-exprs (code)
Package

adp-private.

Source

adp-core.lisp.

Function: remove-current-data ()
Package

adp-private.

Source

adp-core.lisp.

Function: remove-current-procs ()
Package

adp-private.

Source

adp-core.lisp.

Function: remove-own-code-hide-exprs (code)
Package

adp-private.

Source

adp-core.lisp.

Function: set-parameter-value (key-name value)
Package

adp-private.

Source

adp-core.lisp.

Function: write-system-files (root-path)
Package

adp-private.

Source

adp-core.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *bold-italic-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *bold-italic-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *bold-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *bold-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *code-block-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *code-block-tag-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *code-example-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *code-inline-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *code-inline-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *code-tags*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *current-adp-file*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *current-adp-file-contents*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defclass-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defconstant-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defgeneric-proc*
Package

adp-private.

Source

adp-core.lisp.

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

adp-private.

Source

adp-core.lisp.

Special Variable: *define-condition-proc*
Package

adp-private.

Source

adp-core.lisp.

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

adp-private.

Source

adp-core.lisp.

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

adp-private.

Source

adp-core.lisp.

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

adp-private.

Source

adp-core.lisp.

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

adp-private.

Source

adp-core.lisp.

Special Variable: *defmacro-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defmethod-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defpackage-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defparameter-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defsetf-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defstruct-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *deftype-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defun-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *defvar-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *file-foot-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *file-header-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *function-ref-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *function-ref-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *get-file-extension-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *header-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *header-ref-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *header-ref-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *hide-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *image-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *italic-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *italic-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *itemize-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *never-used-code-tags*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *never-used-header-tags*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *normal-pprint-dispatch*
Package

adp-private.

Source

helper-style-functions.lisp.

Special Variable: *project-adp-files*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *style-parameters*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *subheader-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *subsubheader-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *symbol-ref-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *symbol-ref-symbol*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *system-files-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *table-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *text-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *type-ref-proc*
Package

adp-private.

Source

adp-core.lisp.

Special Variable: *type-ref-symbol*
Package

adp-private.

Source

adp-core.lisp.

Package

adp-private.

Source

adp-core.lisp.

Package

adp-private.

Source

adp-core.lisp.


5.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-subheader (str &optional tag)
Package

adp.

Source

adp.lisp.

Macro: adv-write-in-file (file-path)
Package

adp.

Source

adp.lisp.

Macro: def-customizable-writer (writer-name global-proc-name num-args)
Package

adp-private.

Source

adp-writers.lisp.

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

adp-private.

Source

helper-style-functions.lisp.


5.2.3 Ordinary functions

Function: add-never-used-code-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: add-never-used-header-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: add-style-parameter (name key-name required)
Package

adp-private.

Source

adp-core.lisp.

Function: adp-element-contents (elem)
Package

adp-private.

Source

adp-core.lisp.

Function: adp-element-key-type (elem)
Package

adp-private.

Source

adp-core.lisp.

Function: adp-file-contents (file)
Package

adp-private.

Source

adp-core.lisp.

Function: adp-file-path (file)
Package

adp-private.

Source

adp-core.lisp.

Function: adp-files-file-headers (path)
Package

adp-private.

Source

adp-core.lisp.

Function: adp-files-headers ()
Package

adp-private.

Source

adp-core.lisp.

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

adp.

Source

adp.lisp.

Function: bold-italic-textp (arg)
Package

adp-private.

Source

adp-core.lisp.

Function: bold-textp (arg)
Package

adp-private.

Source

adp-core.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: check-space-at-boundaries (from text)
Package

adp-private.

Source

adp-core.lisp.

Function: code-block-tagp (arg)
Package

adp-private.

Source

adp-core.lisp.

Function: code-inline-textp (arg)
Package

adp-private.

Source

adp-core.lisp.

Function: code-tagp (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: create-adp-element (key-type &rest contents)
Package

adp-private.

Source

adp-core.lisp.

Function: create-adp-file (path contents)
Package

adp-private.

Source

adp-core.lisp.

Function: create-headers-toc-list (headers)
Package

adp-private.

Source

adp-core.lisp.

Function: create-mini-toc-list (path)
Package

adp-private.

Source

adp-core.lisp.

Function: create-table-of-functions ()
Package

adp-private.

Source

adp-core.lisp.

Function: create-table-of-symbols ()
Package

adp-private.

Source

adp-core.lisp.

Function: create-table-of-types ()
Package

adp-private.

Source

adp-core.lisp.

Function: create-toc-deep-levels (headers)
Package

adp-private.

Source

adp-core.lisp.

Function: create-toc-list ()
Package

adp-private.

Source

adp-core.lisp.

Function: declarationp (expr)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: defpackage-documentation (defpackage-source)
Package

adp-private.

Source

helper-style-functions.lisp.

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

adp-private.

Source

helper-style-functions.lisp.

Function: documentationp (expr)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: empty-adp-files ()
Package

adp-private.

Source

adp-core.lisp.

Function: empty-code-tags ()
Package

adp-private.

Source

adp-core.lisp.

Function: empty-never-used-code-tags ()
Package

adp-private.

Source

adp-core.lisp.

Function: empty-never-used-header-tags ()
Package

adp-private.

Source

adp-core.lisp.

Function: empty-style-parameters ()
Package

adp-private.

Source

adp-core.lisp.

Function: find-shortest-string (strings)
Package

adp-private.

Source

helper-style-functions.lisp.

Function: function-ref-textp (arg)
Package

adp-private.

Source

adp-core.lisp.

Function: get-function-tag-info (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: get-header-tag-info (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: get-project-adp-file-contents (path)
Package

adp-private.

Source

adp-core.lisp.

Function: get-symbol-tag-info (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: get-type-tag-info (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: header-contents-tag (header)
Package

adp-private.

Source

adp-core.lisp.

Function: header-deep-level (header-type)
Package

adp-private.

Source

adp-core.lisp.

Function: header-ref-textp (arg)
Package

adp-private.

Source

adp-core.lisp.

Function: italic-textp (arg)
Package

adp-private.

Source

adp-core.lisp.

Function: plistp (code)
Package

adp-private.

Source

adp-core.lisp.

Function: push-adp-element (elem)
Package

adp-private.

Source

adp-core.lisp.

Function: remove-never-used-code-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: remove-never-used-header-tag (tag)
Package

adp-private.

Source

adp-core.lisp.

Function: simple-slice-format (from &rest args)
Package

adp-private.

Source

adp-core.lisp.

Function: slice-format (&rest args)
Package

adp-private.

Source

adp-core.lisp.

Function: style-parameter-requiredp (key-name)
Package

adp-private.

Source

adp-core.lisp.

Function: style-parameterp (key-name)
Package

adp-private.

Source

adp-core.lisp.

Function: style-required-parameters ()
Package

adp-private.

Source

adp-core.lisp.

Function: symbol-ref-textp (arg)
Package

adp-private.

Source

adp-core.lisp.

Function: type-ref-textp (arg)
Package

adp-private.

Source

adp-core.lisp.

Package

adp-private.

Source

adp-core.lisp.

Function: write-file (root-path rel-path elements)
Package

adp-private.

Source

adp-core.lisp.

Function: write-file-contents (stream rel-path elements)
Package

adp-private.

Source

adp-core.lisp.


5.2.4 Types

Type: adp-element ()
Package

adp-private.

Source

adp-core.lisp.

Type: adp-file ()
Package

adp-private.

Source

adp-core.lisp.


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   W  
Index Entry  Section

A
add-code-tag: Public ordinary functions
add-function-tag: Public ordinary functions
add-header-tag: Public ordinary functions
add-never-used-code-tag: Private ordinary functions
add-never-used-header-tag: Private ordinary functions
add-style-parameter: Private ordinary functions
add-symbol-tag: Public ordinary functions
add-type-tag: Public ordinary functions
adp-element-contents: Private ordinary functions
adp-element-key-type: Private ordinary functions
adp-file-contents: Private ordinary functions
adp-file-path: Private ordinary functions
adp-files-file-headers: Private ordinary functions
adp-files-headers: Private ordinary functions
adp-reader-macro-dispatch: Private ordinary functions
adv-defmacro: Private macros
adv-defun: Private macros
adv-header: Private macros
adv-subheader: Private macros
adv-write-in-file: Private macros

B
bold: Public macros
bold-italic: Public macros
bold-italic-textp: Private ordinary functions
bold-textp: Private ordinary functions

C
check-component-symbols: Private ordinary functions
check-current-procs: Public ordinary functions
check-space-at-boundaries: Private ordinary functions
check-style-parameters: Public ordinary functions
cl-ref: Public macros
code-block: Public macros
code-block-tagp: Private ordinary functions
code-example: Public macros
code-inline: Public macros
code-inline-textp: Private ordinary functions
code-tag: Public macros
code-tagp: Private ordinary functions
create-adp-element: Private ordinary functions
create-adp-file: Private ordinary functions
create-bold-italic-text: Public ordinary functions
create-bold-text: Public ordinary functions
create-code-block-tag: Public ordinary functions
create-code-inline-text: Public ordinary functions
create-function-ref-text: Public ordinary functions
create-header-ref-text: Public ordinary functions
create-headers-toc-list: Private ordinary functions
create-italic-text: Public ordinary functions
create-mini-toc-list: Private ordinary functions
create-symbol-ref-text: Public ordinary functions
create-table-of-functions: Private ordinary functions
create-table-of-symbols: Private ordinary functions
create-table-of-types: Private ordinary functions
create-toc-deep-levels: Private ordinary functions
create-toc-list: Private ordinary functions
create-type-ref-text: Public ordinary functions
create-web-link-text: Public ordinary functions
custom-prin1: Public ordinary functions

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

E
emplace-adp-element: Public ordinary functions
empty-adp-files: Private ordinary functions
empty-code-tags: Private ordinary functions
empty-function-tags: Public ordinary functions
empty-header-tags: Public ordinary functions
empty-never-used-code-tags: Private ordinary functions
empty-never-used-header-tags: Private ordinary functions
empty-style-parameters: Private ordinary functions
empty-symbol-tags: Public ordinary functions
empty-type-tags: Public ordinary functions

F
find-shortest-string: Private ordinary functions
Function, add-code-tag: Public ordinary functions
Function, add-function-tag: Public ordinary functions
Function, add-header-tag: Public ordinary functions
Function, add-never-used-code-tag: Private ordinary functions
Function, add-never-used-header-tag: Private ordinary functions
Function, add-style-parameter: Private ordinary functions
Function, add-symbol-tag: Public ordinary functions
Function, add-type-tag: Public ordinary functions
Function, adp-element-contents: Private ordinary functions
Function, adp-element-key-type: Private ordinary functions
Function, adp-file-contents: Private ordinary functions
Function, adp-file-path: Private ordinary functions
Function, adp-files-file-headers: Private ordinary functions
Function, adp-files-headers: Private ordinary functions
Function, adp-reader-macro-dispatch: Private ordinary functions
Function, bold-italic-textp: Private ordinary functions
Function, bold-textp: Private ordinary functions
Function, check-component-symbols: Private ordinary functions
Function, check-current-procs: Public ordinary functions
Function, check-space-at-boundaries: Private ordinary functions
Function, check-style-parameters: Public ordinary functions
Function, code-block-tagp: Private ordinary functions
Function, code-inline-textp: Private ordinary functions
Function, code-tagp: Private ordinary functions
Function, create-adp-element: Private ordinary functions
Function, create-adp-file: Private ordinary functions
Function, create-bold-italic-text: Public ordinary functions
Function, create-bold-text: Public ordinary functions
Function, create-code-block-tag: Public ordinary functions
Function, create-code-inline-text: Public ordinary functions
Function, create-function-ref-text: Public ordinary functions
Function, create-header-ref-text: Public ordinary functions
Function, create-headers-toc-list: Private ordinary functions
Function, create-italic-text: Public ordinary functions
Function, create-mini-toc-list: Private ordinary functions
Function, create-symbol-ref-text: Public ordinary functions
Function, create-table-of-functions: Private ordinary functions
Function, create-table-of-symbols: Private ordinary functions
Function, create-table-of-types: Private ordinary functions
Function, create-toc-deep-levels: Private ordinary functions
Function, create-toc-list: Private ordinary functions
Function, create-type-ref-text: Public ordinary functions
Function, create-web-link-text: Public ordinary functions
Function, custom-prin1: Public ordinary functions
Function, declarationp: Private ordinary functions
Function, defclass-accessor-function-names: Public ordinary functions
Function, defclass-allocation-types: Public ordinary functions
Function, defclass-class-name: Public ordinary functions
Function, defclass-class-options: Public ordinary functions
Function, defclass-default-initargs: Public ordinary functions
Function, defclass-documentation: Public ordinary functions
Function, defclass-initarg-names: Public ordinary functions
Function, defclass-initforms: Public ordinary functions
Function, defclass-metaclass: Public ordinary functions
Function, defclass-reader-function-names: Public ordinary functions
Function, defclass-slot-documentations: Public ordinary functions
Function, defclass-slot-names: Public ordinary functions
Function, defclass-slot-options: Public ordinary functions
Function, defclass-slot-specifiers: Public ordinary functions
Function, defclass-superclass-names: Public ordinary functions
Function, defclass-type-specifiers: Public ordinary functions
Function, defclass-writer-function-names: Public ordinary functions
Function, defconstant-documentation: Public ordinary functions
Function, defconstant-initial-value: Public ordinary functions
Function, defconstant-name: Public ordinary functions
Function, defgeneric-argument-precedence-order: Public ordinary functions
Function, defgeneric-documentation: Public ordinary functions
Function, defgeneric-function-name: Public ordinary functions
Function, defgeneric-generic-function-class: Public ordinary functions
Function, defgeneric-gf-declarations: Public ordinary functions
Function, defgeneric-gf-lambda-list: Public ordinary functions
Function, defgeneric-method-class: Public ordinary functions
Function, defgeneric-method-combination: Public ordinary functions
Function, defgeneric-method-descriptions: Public ordinary functions
Function, defgeneric-options: Public ordinary functions
Function, define-compiler-macro-declarations: Public ordinary functions
Function, define-compiler-macro-documentation: Public ordinary functions
Function, define-compiler-macro-forms: Public ordinary functions
Function, define-compiler-macro-lambda-list: Public ordinary functions
Function, define-compiler-macro-name: Public ordinary functions
Function, define-condition-default-initargs: Public ordinary functions
Function, define-condition-documentation: Public ordinary functions
Function, define-condition-name: Public ordinary functions
Function, define-condition-options: Public ordinary functions
Function, define-condition-parent-types: Public ordinary functions
Function, define-condition-report-name: Public ordinary functions
Function, define-condition-slot-accessors: Public ordinary functions
Function, define-condition-slot-allocations: Public ordinary functions
Function, define-condition-slot-initargs: Public ordinary functions
Function, define-condition-slot-initforms: Public ordinary functions
Function, define-condition-slot-names: Public ordinary functions
Function, define-condition-slot-options: Public ordinary functions
Function, define-condition-slot-readers: Public ordinary functions
Function, define-condition-slot-specs: Public ordinary functions
Function, define-condition-slot-types: Public ordinary functions
Function, define-condition-slot-writers: Public ordinary functions
Function, define-method-combination-arguments: Public ordinary functions
Function, define-method-combination-declarations: Public ordinary functions
Function, define-method-combination-descriptions: Public ordinary functions
Function, define-method-combination-documentation: Public ordinary functions
Function, define-method-combination-forms: Public ordinary functions
Function, define-method-combination-generic-function: Public ordinary functions
Function, define-method-combination-identity-with-one-argument: Public ordinary functions
Function, define-method-combination-lambda-list: Public ordinary functions
Function, define-method-combination-long-form-options: Public ordinary functions
Function, define-method-combination-method-group-specifier-names: Public ordinary functions
Function, define-method-combination-method-group-specifiers: Public ordinary functions
Function, define-method-combination-name: Public ordinary functions
Function, define-method-combination-operator: Public ordinary functions
Function, define-method-combination-orders: Public ordinary functions
Function, define-method-combination-predicates: Public ordinary functions
Function, define-method-combination-qualifier-patterns: Public ordinary functions
Function, define-method-combination-requireds: Public ordinary functions
Function, define-method-combination-short-form-options: Public ordinary functions
Function, define-modify-macro-documentation: Public ordinary functions
Function, define-modify-macro-function: Public ordinary functions
Function, define-modify-macro-lambda-list: Public ordinary functions
Function, define-modify-macro-name: Public ordinary functions
Function, define-setf-expander-access-fn: Public ordinary functions
Function, define-setf-expander-declarations: Public ordinary functions
Function, define-setf-expander-documentation: Public ordinary functions
Function, define-setf-expander-forms: Public ordinary functions
Function, define-setf-expander-lambda-list: Public ordinary functions
Function, define-symbol-macro-expansion: Public ordinary functions
Function, define-symbol-macro-symbol: Public ordinary functions
Function, defmacro-declarations: Public ordinary functions
Function, defmacro-documentation: Public ordinary functions
Function, defmacro-forms: Public ordinary functions
Function, defmacro-lambda-list: Public ordinary functions
Function, defmacro-name: Public ordinary functions
Function, defmethod-declarations: Public ordinary functions
Function, defmethod-documentation: Public ordinary functions
Function, defmethod-forms: Public ordinary functions
Function, defmethod-function-name: Public ordinary functions
Function, defmethod-method-qualifiers: Public ordinary functions
Function, defmethod-specialized-lambda-list: Public ordinary functions
Function, defpackage-defined-package-name: Public ordinary functions
Function, defpackage-documentation: Private ordinary functions
Function, defpackage-export-symbol-names: Public ordinary functions
Function, defpackage-import-from-package-names: Public ordinary functions
Function, defpackage-import-from-symbol-names: Public ordinary functions
Function, defpackage-import-symbol-names: Public ordinary functions
Function, defpackage-nicknames: Public ordinary functions
Function, defpackage-options: Public ordinary functions
Function, defpackage-shadow-symbol-names: Public ordinary functions
Function, defpackage-shadowing-import-from-package-names: Public ordinary functions
Function, defpackage-shadowing-import-from-symbol-names: Public ordinary functions
Function, defpackage-size: Public ordinary functions
Function, defpackage-use-package-names: Public ordinary functions
Function, defparameter-documentation: Public ordinary functions
Function, defparameter-initial-value: Public ordinary functions
Function, defparameter-name: Public ordinary functions
Function, defsetf-access-fn: Public ordinary functions
Function, defsetf-documentation: Public ordinary functions
Function, defsetf-update-fn: Public ordinary functions
Function, defstruct-conc-name: Public ordinary functions
Function, defstruct-conc-name-option: Public ordinary functions
Function, defstruct-constructor-arglists: Public ordinary functions
Function, defstruct-constructor-names: Public ordinary functions
Function, defstruct-constructor-options: Public ordinary functions
Function, defstruct-copier-name: Public ordinary functions
Function, defstruct-copier-option: Public ordinary functions
Function, defstruct-documentation: Public ordinary functions
Function, defstruct-include-option: Public ordinary functions
Function, defstruct-include-option-slot-descriptors: Public ordinary functions
Function, defstruct-included-structure-name: Public ordinary functions
Function, defstruct-initial-offset: Public ordinary functions
Function, defstruct-initial-offset-option: Public ordinary functions
Function, defstruct-name-and-options: Public ordinary functions
Function, defstruct-named-option: Public ordinary functions
Function, defstruct-options: Public ordinary functions
Function, defstruct-predicate-name: Public ordinary functions
Function, defstruct-predicate-option: Public ordinary functions
Function, defstruct-print-function-option: Public ordinary functions
Function, defstruct-print-object-option: Public ordinary functions
Function, defstruct-printer-name: Public ordinary functions
Function, defstruct-printer-option: Public ordinary functions
Function, defstruct-slot-descriptions: Public ordinary functions
Function, defstruct-slot-initforms: Public ordinary functions
Function, defstruct-slot-names: Public ordinary functions
Function, defstruct-slot-options: Public ordinary functions
Function, defstruct-slot-read-only-ps: Public ordinary functions
Function, defstruct-slot-types: Public ordinary functions
Function, defstruct-structure-name: Private ordinary functions
Function, defstruct-type: Public ordinary functions
Function, defstruct-type-option: Public ordinary functions
Function, deftype-declarations: Public ordinary functions
Function, deftype-documentation: Public ordinary functions
Function, deftype-forms: Public ordinary functions
Function, deftype-lambda-list: Public ordinary functions
Function, deftype-name: Public ordinary functions
Function, defun-declarations: Public ordinary functions
Function, defun-documentation: Public ordinary functions
Function, defun-forms: Public ordinary functions
Function, defun-function-name: Public ordinary functions
Function, defun-lambda-list: Public ordinary functions
Function, defvar-documentation: Public ordinary functions
Function, defvar-initial-value: Public ordinary functions
Function, defvar-name: Public ordinary functions
Function, documentationp: Private ordinary functions
Function, emplace-adp-element: Public ordinary functions
Function, empty-adp-files: Private ordinary functions
Function, empty-code-tags: Private ordinary functions
Function, empty-function-tags: Public ordinary functions
Function, empty-header-tags: Public ordinary functions
Function, empty-never-used-code-tags: Private ordinary functions
Function, empty-never-used-header-tags: Private ordinary functions
Function, empty-style-parameters: Private ordinary functions
Function, empty-symbol-tags: Public ordinary functions
Function, empty-type-tags: Public ordinary functions
Function, find-shortest-string: Private ordinary functions
Function, function-ref-textp: Private ordinary functions
Function, get-code-tag: Public ordinary functions
Function, get-function-tag-info: Private ordinary functions
Function, get-header-tag-info: Private ordinary functions
Function, get-project-adp-file-contents: Private ordinary functions
Function, get-symbol-tag-info: Private ordinary functions
Function, get-type-tag-info: Private ordinary functions
Function, header-contents-tag: Private ordinary functions
Function, header-deep-level: Private ordinary functions
Function, header-ref-textp: Private ordinary functions
Function, hide-symbolp: Public ordinary functions
Function, italic-textp: Private ordinary functions
Function, load-documentation-system: Public ordinary functions
Function, plistp: Private ordinary functions
Function, process-code-tag: Public ordinary functions
Function, push-adp-element: Private ordinary functions
Function, push-adp-file: Public ordinary functions
Function, remove-code-tag-exprs: Public ordinary functions
Function, remove-current-data: Public ordinary functions
Function, remove-current-procs: Public ordinary functions
Function, remove-never-used-code-tag: Private ordinary functions
Function, remove-never-used-header-tag: Private ordinary functions
Function, remove-own-code-hide-exprs: Public ordinary functions
Function, set-parameter-value: Public ordinary functions
Function, simple-slice-format: Private ordinary functions
Function, slice-format: Private ordinary functions
Function, style-parameter-requiredp: Private ordinary functions
Function, style-parameterp: Private ordinary functions
Function, style-required-parameters: Private ordinary functions
Function, symbol-ref-textp: Private ordinary functions
Function, type-ref-textp: Private ordinary functions
Function, web-link-textp: Private ordinary functions
Function, write-file: Private ordinary functions
Function, write-file-contents: Private ordinary functions
Function, write-system-files: Public ordinary functions
function-ref: Public macros
function-ref-textp: Private ordinary functions

G
get-code-tag: Public ordinary functions
get-function-tag-info: Private ordinary functions
get-header-tag-info: Private ordinary functions
get-project-adp-file-contents: Private ordinary functions
get-symbol-tag-info: Private ordinary functions
get-type-tag-info: Private ordinary functions

H
header: Public macros
header-contents-tag: Private ordinary functions
header-deep-level: Private ordinary functions
header-ref: Public macros
header-ref-textp: Private ordinary functions
hide-symbolp: Public ordinary functions

I
image: Public macros
italic: Public macros
italic-textp: Private ordinary functions
itemize: Public macros

L
load-documentation-system: Public ordinary functions

M
Macro, adv-defmacro: Private macros
Macro, adv-defun: Private macros
Macro, adv-header: Private macros
Macro, adv-subheader: Private macros
Macro, adv-write-in-file: Private macros
Macro, bold: Public macros
Macro, bold-italic: Public macros
Macro, cl-ref: Public macros
Macro, code-block: Public macros
Macro, code-example: Public macros
Macro, code-inline: Public macros
Macro, code-tag: Public macros
Macro, def-bold-italic-writer: Public macros
Macro, def-bold-writer: Public macros
Macro, def-code-block-writer: Public macros
Macro, def-code-example-writer: Public macros
Macro, def-code-inline-writer: Public macros
Macro, def-customizable-writer: Private macros
Macro, def-defclass-writer: Public macros
Macro, def-defconstant-writer: Public macros
Macro, def-defgeneric-writer: Public macros
Macro, def-define-compiler-macro-writer: Public macros
Macro, def-define-condition-writer: Public macros
Macro, def-define-method-combination-writer: Public macros
Macro, def-define-modify-macro-writer: Public macros
Macro, def-define-setf-expander-writer: Public macros
Macro, def-define-symbol-macro-writer: Public macros
Macro, def-defmacro-writer: Public macros
Macro, def-defmethod-writer: Public macros
Macro, def-defpackage-writer: Public macros
Macro, def-defparameter-writer: Public macros
Macro, def-defsetf-writer: Public macros
Macro, def-defstruct-writer: Public macros
Macro, def-deftype-writer: Public macros
Macro, def-defun-writer: Public macros
Macro, def-defvar-writer: Public macros
Macro, def-file-foot-writer: Public macros
Macro, def-file-header-writer: Public macros
Macro, def-function-ref-writer: Public macros
Macro, def-get-file-extension-writer: Public macros
Macro, def-header-ref-writer: Public macros
Macro, def-header-writer: Public macros
Macro, def-image-writer: Public macros
Macro, def-italic-writer: Public macros
Macro, def-itemize-writer: Public macros
Macro, def-style-parameter: Public macros
Macro, def-subheader-writer: Public macros
Macro, def-subsubheader-writer: Public macros
Macro, def-symbol-ref-writer: Public macros
Macro, def-system-files-writer: Public macros
Macro, def-table-writer: Public macros
Macro, def-text-writer: Public macros
Macro, def-type-ref-writer: Public macros
Macro, def-web-link-writer: Public macros
Macro, def-with-components: Private macros
Macro, defclass: Public macros
Macro, defconstant: Public macros
Macro, defgeneric: Public macros
Macro, define-compiler-macro: Public macros
Macro, define-condition: Public macros
Macro, define-method-combination: Public macros
Macro, define-modify-macro: Public macros
Macro, define-setf-expander: Public macros
Macro, define-symbol-macro: Public 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, function-ref: Public macros
Macro, header: Public macros
Macro, header-ref: Public macros
Macro, image: Public macros
Macro, italic: 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, 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, write-in-file: Public macros
mini-table-of-contents: Public macros

P
plistp: Private ordinary functions
process-code-tag: Public ordinary functions
push-adp-element: Private ordinary functions
push-adp-file: Public ordinary functions

R
remove-code-tag-exprs: Public ordinary functions
remove-current-data: Public ordinary functions
remove-current-procs: Public ordinary functions
remove-never-used-code-tag: Private ordinary functions
remove-never-used-header-tag: Private ordinary functions
remove-own-code-hide-exprs: Public ordinary functions

S
set-parameter-value: Public ordinary functions
simple-slice-format: Private ordinary functions
slice-format: Private ordinary functions
style-parameter-requiredp: Private ordinary functions
style-parameterp: Private ordinary functions
style-required-parameters: Private ordinary functions
subheader: Public macros
subsubheader: Public macros
symbol-ref: Public macros
symbol-ref-textp: Private ordinary functions

T
table: Public macros
table-of-contents: Public macros
table-of-functions: Public macros
table-of-symbols: Public macros
table-of-types: Public macros
text: Public macros
type-ref: Public macros
type-ref-textp: Private ordinary functions

W
web-link: Public macros
web-link-textp: Private ordinary functions
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
write-file: Private ordinary functions
write-file-contents: Private ordinary functions
write-in-file: Public macros
write-system-files: Public ordinary functions


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*add-documentation*: Public special variables
*bold-italic-proc*: Private special variables
*bold-italic-symbol*: Private special variables
*bold-proc*: Private special variables
*bold-symbol*: Private special variables
*code-block-proc*: Private special variables
*code-block-tag-symbol*: Private special variables
*code-example-proc*: Private special variables
*code-inline-proc*: Private special variables
*code-inline-symbol*: Private special variables
*code-tags*: Private special variables
*current-adp-file*: Private special variables
*current-adp-file-contents*: Private special variables
*custom-pprint-dispatch*: Public special variables
*defclass-proc*: Private special variables
*defconstant-proc*: Private special variables
*defgeneric-proc*: Private special variables
*define-compiler-macro-proc*: Private special variables
*define-condition-proc*: Private special variables
*define-method-combination-proc*: Private special variables
*define-modify-macro-proc*: Private special variables
*define-setf-expander-proc*: Private special variables
*define-symbol-macro-proc*: Private special variables
*defmacro-proc*: Private special variables
*defmethod-proc*: Private special variables
*defpackage-proc*: Private special variables
*defparameter-proc*: Private special variables
*defsetf-proc*: Private special variables
*defstruct-proc*: Private special variables
*deftype-proc*: Private special variables
*defun-proc*: Private special variables
*defvar-proc*: Private special variables
*file-adp-elements*: Public special variables
*file-foot-proc*: Private special variables
*file-header-proc*: Private special variables
*function-ref-proc*: Private special variables
*function-ref-symbol*: Private special variables
*function-tags*: Public special variables
*get-file-extension-proc*: Private special variables
*header-proc*: Private special variables
*header-ref-proc*: Private special variables
*header-ref-symbol*: Private special variables
*header-tags*: Public special variables
*hide-symbol*: Private special variables
*image-proc*: Private special variables
*italic-proc*: Private special variables
*italic-symbol*: Private special variables
*itemize-proc*: Private special variables
*never-used-code-tags*: Private special variables
*never-used-header-tags*: Private special variables
*normal-pprint-dispatch*: Private special variables
*project-adp-files*: Private special variables
*style-parameters*: Private special variables
*subheader-proc*: Private special variables
*subsubheader-proc*: Private special variables
*symbol-ref-proc*: Private special variables
*symbol-ref-symbol*: Private special variables
*symbol-tags*: Public special variables
*system-files-proc*: Private special variables
*table-proc*: Private special variables
*text-proc*: Private special variables
*type-ref-proc*: Private special variables
*type-ref-symbol*: Private special variables
*type-tags*: Public special variables
*web-link-proc*: Private special variables
*web-link-symbol*: Private special variables

S
Special Variable, *add-documentation*: Public special variables
Special Variable, *bold-italic-proc*: Private special variables
Special Variable, *bold-italic-symbol*: Private special variables
Special Variable, *bold-proc*: Private special variables
Special Variable, *bold-symbol*: Private special variables
Special Variable, *code-block-proc*: Private special variables
Special Variable, *code-block-tag-symbol*: Private special variables
Special Variable, *code-example-proc*: Private special variables
Special Variable, *code-inline-proc*: Private special variables
Special Variable, *code-inline-symbol*: Private special variables
Special Variable, *code-tags*: Private special variables
Special Variable, *current-adp-file*: Private special variables
Special Variable, *current-adp-file-contents*: Private special variables
Special Variable, *custom-pprint-dispatch*: Public special variables
Special Variable, *defclass-proc*: Private special variables
Special Variable, *defconstant-proc*: Private special variables
Special Variable, *defgeneric-proc*: Private special variables
Special Variable, *define-compiler-macro-proc*: Private special variables
Special Variable, *define-condition-proc*: Private special variables
Special Variable, *define-method-combination-proc*: Private special variables
Special Variable, *define-modify-macro-proc*: Private special variables
Special Variable, *define-setf-expander-proc*: Private special variables
Special Variable, *define-symbol-macro-proc*: Private special variables
Special Variable, *defmacro-proc*: Private special variables
Special Variable, *defmethod-proc*: Private special variables
Special Variable, *defpackage-proc*: Private special variables
Special Variable, *defparameter-proc*: Private special variables
Special Variable, *defsetf-proc*: Private special variables
Special Variable, *defstruct-proc*: Private special variables
Special Variable, *deftype-proc*: Private special variables
Special Variable, *defun-proc*: Private special variables
Special Variable, *defvar-proc*: Private special variables
Special Variable, *file-adp-elements*: Public special variables
Special Variable, *file-foot-proc*: Private special variables
Special Variable, *file-header-proc*: Private special variables
Special Variable, *function-ref-proc*: Private special variables
Special Variable, *function-ref-symbol*: Private special variables
Special Variable, *function-tags*: Public special variables
Special Variable, *get-file-extension-proc*: Private special variables
Special Variable, *header-proc*: Private special variables
Special Variable, *header-ref-proc*: Private special variables
Special Variable, *header-ref-symbol*: Private special variables
Special Variable, *header-tags*: Public special variables
Special Variable, *hide-symbol*: Private special variables
Special Variable, *image-proc*: Private special variables
Special Variable, *italic-proc*: Private special variables
Special Variable, *italic-symbol*: Private special variables
Special Variable, *itemize-proc*: Private special variables
Special Variable, *never-used-code-tags*: Private special variables
Special Variable, *never-used-header-tags*: Private special variables
Special Variable, *normal-pprint-dispatch*: Private special variables
Special Variable, *project-adp-files*: Private special variables
Special Variable, *style-parameters*: Private special variables
Special Variable, *subheader-proc*: Private special variables
Special Variable, *subsubheader-proc*: Private special variables
Special Variable, *symbol-ref-proc*: Private special variables
Special Variable, *symbol-ref-symbol*: Private special variables
Special Variable, *symbol-tags*: Public special variables
Special Variable, *system-files-proc*: Private special variables
Special Variable, *table-proc*: Private special variables
Special Variable, *text-proc*: Private special variables
Special Variable, *type-ref-proc*: Private special variables
Special Variable, *type-ref-symbol*: Private special variables
Special Variable, *type-tags*: Public special variables
Special Variable, *web-link-proc*: Private special variables
Special Variable, *web-link-symbol*: Private special variables