Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The adp Reference Manual

This is the adp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:31:06 2024 GMT+0.

Next: Systems, Previous: The adp Reference Manual, Up: The adp Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The adp Reference Manual [Contents][Index]

2 Systems

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

adp

Previous: Systems, Up: Systems [Contents][Index]

2.1 `adp`

Add Documentation, Please. A Common Lisp semi-automatic documentation generator and literate programming tool with Scribble files and @-syntax support.

Author

Héctor Galbis Sanchis

License

MIT

Dependencies

scribble (system).
alexandria (system).

Source

adp.asd.

Child Components

package.lisp (file).
adp.lisp (file).

Next: Packages, Previous: Systems, Up: The adp Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: adp/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `adp/adp.asd`

Source: adp.asd.
Parent Component: adp (system).
ASDF Systems: adp.

Next: adp/adp.lisp, Previous: adp/adp.asd, Up: Lisp [Contents][Index]

3.1.2 `adp/package.lisp`

Source: adp.asd.
Parent Component: adp (system).
Packages: adp.

Previous: adp/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `adp/adp.lisp`

Source

adp.asd.

Parent Component

adp (system).

Public Interface

*adp* (special variable).
define-adp-file (macro).
define-adp-operation (macro).
export-content (generic function).
file-component (reader method).
file-elements (reader method).
operation-done-p (method).
operation-done-p (method).
perform (method).
perform (method).
perform (method).
perform (method).
perform (method).
perform (method).
perform (method).
perform (method).
post-process-file (generic function).
post-process-system (generic function).
pre-process-file (generic function).
pre-process-system (generic function).
scribble (class).

Internals

*current-content-file* (special variable).
*files* (special variable).
add-element (macro).
add-file (function).
adp-op (class).
current-file-add-element (function).
destroy-files-container (function).
file (class).
file-add-element (function).
get-load-operation (generic function).
get-package-and-stream (function).
make-files-container (function).
prepare-adp-op (class).
read-sheat-syntax (function).
reexport (function).
scribble-package (generic function).
scribble-source-file (class).
with-package-and-stream (macro).

Next: Definitions, Previous: Files, Up: The adp Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

adp

Previous: Packages, Up: Packages [Contents][Index]

4.1 `adp`

Source

package.lisp.

Use List

common-lisp.

Public Interface

*adp* (special variable).
define-adp-file (macro).
define-adp-operation (macro).
export-content (generic function).
file-component (generic reader).
file-elements (generic reader).
post-process-file (generic function).
post-process-system (generic function).
pre-process-file (generic function).
pre-process-system (generic function).
scribble (class).

Internals

*current-content-file* (special variable).
*files* (special variable).
add-element (macro).
add-file (function).
adp-op (class).
current-file-add-element (function).
destroy-files-container (function).
file (class).
file-add-element (function).
get-load-operation (generic function).
get-package-and-stream (function).
make-files-container (function).
prepare-adp-op (class).
read-sheat-syntax (function).
reexport (function).
scribble-package (generic function).
scribble-source-file (class).
with-package-and-stream (macro).

Next: Indexes, Previous: Packages, Up: The adp Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Special variables
Macros
Generic functions
Standalone methods
Classes

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Special variables

Special Variable: *adp* ¶

Indicates whether adp is generating documentation.

Package: adp.
Source: adp.lisp.

Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]

5.1.2 Macros

Macro: define-adp-file (name &optional type) ¶

Defines an adp file.

Package: adp.
Source: adp.lisp.

Macro: define-adp-operation (name) ¶

Defines an adp operation.

Package: adp.
Source: adp.lisp.

Next: Standalone methods, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.3 Generic functions

Generic Function: export-content (op files system) ¶

Exports the files gathered by ADP.

Package: adp.
Source: adp.lisp.

Generic Reader: file-component (object) ¶

Package

adp.

Methods

Reader Method: file-component ((file file)) ¶

automatically generated reader method

Source: adp.lisp.
Target Slot: component.

Generic Reader: file-elements (object) ¶

Package

adp.

Methods

Reader Method: file-elements ((file file)) ¶

automatically generated reader method

Source: adp.lisp.
Target Slot: elements.

Generic Function: post-process-file (op f) ¶

Package

adp.

Source

adp.lisp.

Methods

Method: post-process-file ((op adp-op) f) ¶

Generic Function: post-process-system (op s) ¶

Package

adp.

Source

adp.lisp.

Methods

Method: post-process-system ((op adp-op) s) ¶

Generic Function: pre-process-file (op f) ¶

Package

adp.

Source

adp.lisp.

Methods

Method: pre-process-file ((op adp-op) f) ¶

Generic Function: pre-process-system (op s) ¶

Package

adp.

Source

adp.lisp.

Methods

Method: pre-process-system ((op adp-op) s) ¶

Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.4 Standalone methods

Method: operation-done-p ((o prepare-adp-op) (c component)) ¶

We can’t know if output files has been modified or removed. So, operation must always be done.

Package: asdf/action.
Source: adp.lisp.

Method: operation-done-p ((o adp-op) (c component)) ¶

We can’t know if output files has been modified or removed. So, operation must always be done.

Package: asdf/action.
Source: adp.lisp.

Method: perform ((o prepare-adp-op) (s system)) ¶

Package: asdf/action.
Source: adp.lisp.

Method: perform ((o prepare-adp-op) (c component)) ¶

Package: asdf/action.
Source: adp.lisp.

Method: perform ((o adp-op) (c system)) ¶

Package: asdf/action.
Source: adp.lisp.

Method: perform ((o adp-op) (c static-file)) ¶

Package: asdf/action.
Source: adp.lisp.

Method: perform ((o adp-op) (c scribble-source-file)) ¶

Package: asdf/action.
Source: adp.lisp.

Method: perform ((o adp-op) (c cl-source-file)) ¶

Package: asdf/action.
Source: adp.lisp.

Method: perform ((o load-op) (c scribble-source-file)) ¶

Package: asdf/action.
Source: adp.lisp.

Method: perform ((o compile-op) (c scribble-source-file)) ¶

Package: asdf/action.
Source: adp.lisp.

Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.5 Classes

Class: scribble ¶

Package: adp.
Source: adp.lisp.
Direct superclasses: scribble-source-file.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Macros
Ordinary functions
Generic functions
Classes

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *current-content-file* ¶

The current content file where the elements must be added. Used while loading a common lisp source file.

Package: adp.
Source: adp.lisp.

Special Variable: *files* ¶

A container with all the content files. The keys are the pathnames of the file relative to the asdf root file.

Package: adp.
Source: adp.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Macros

Macro: add-element (element) ¶

Adds an element to the current selected content file.

Package: adp.
Source: adp.lisp.

Macro: with-package-and-stream ((package-name stream-name file) &body body) ¶

Package: adp.
Source: adp.lisp.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

5.2.3 Ordinary functions

Function: add-file (file) ¶

Adds a file to the files container.

Package: adp.
Source: adp.lisp.

Function: current-file-add-element (element) ¶

Package: adp.
Source: adp.lisp.

Function: destroy-files-container () ¶

Destroys the files container.

Package: adp.
Source: adp.lisp.

Function: file-add-element (file element) ¶

Adds an element to a file.

Package: adp.
Source: adp.lisp.

Function: get-package-and-stream (file) ¶

Package: adp.
Source: adp.lisp.

Function: make-files-container () ¶

Initializes the files container.

Package: adp.
Source: adp.lisp.

Function: read-sheat-syntax (s c n) ¶

Package: adp.
Source: adp.lisp.

Function: reexport (symbol package) ¶

Package: adp.
Source: adp.lisp.

Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.4 Generic functions

Generic Function: get-load-operation (o) ¶

Package

adp.

Source

adp.lisp.

Methods

Method: get-load-operation ((o prepare-adp-op)) ¶

Generic Function: scribble-package (op f) ¶

Returns the package to be used while loading scribble files.

Package

adp.

Source

adp.lisp.

Methods

Method: scribble-package ((op adp-op) f) ¶

Previous: Generic functions, Up: Internals [Contents][Index]

5.2.5 Classes

Class: adp-op ¶

Operation for loading and generating documentation.

Package

adp.

Source

adp.lisp.

Direct superclasses

downward-operation.
selfward-operation.

Direct methods

operation-done-p.
perform.
perform.
perform.
perform.
post-process-file.
post-process-system.
pre-process-file.
pre-process-system.
scribble-package.

Direct slots

Slot: selfward-operation ¶

Package: asdf/action.
Allocation: :class
Initform: (quote adp::prepare-adp-op)

Class: file ¶

Represents a unit of documentation that groups several elements.

Package

adp.

Source

adp.lisp.

Direct methods

file-component.
file-elements.

Direct slots

Slot: component ¶

Type: asdf/component:source-file
Initargs: :component
Readers: file-component.
Writers: This slot is read-only.

Slot: elements ¶

Type: vector
Initform: (make-array 100 :fill-pointer 0)
Initargs: :elements
Readers: file-elements.
Writers: This slot is read-only.

Class: prepare-adp-op ¶

Operation for loading and generating the documentation of dependencies.

Package

adp.

Source

adp.lisp.

Direct superclasses

sideway-operation.
upward-operation.

Direct methods

get-load-operation.
operation-done-p.
perform.
perform.

Direct slots

Slot: sideway-operation ¶

Package: asdf/action.
Allocation: :class
Initform: (quote asdf/lisp-action:load-op)

Class: scribble-source-file ¶

Component class for a Scribble source file (using type "scrbl")

Package

adp.

Source

adp.lisp.

Direct superclasses

source-file.

Direct subclasses

scribble.

Direct methods

perform.
perform.
perform.

Direct slots

Slot: type ¶

Package: common-lisp.
Initform: "scrbl"

Previous: Definitions, Up: The adp Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	A C D E F G M O P R S W

	Index Entry	Section

A
	`add-element`:	Private macros
	`add-file`:	Private ordinary functions

C
	`current-file-add-element`:	Private ordinary functions

D
	`define-adp-file`:	Public macros
	`define-adp-operation`:	Public macros
	`destroy-files-container`:	Private ordinary functions

E
	`export-content`:	Public generic functions

F
	`file-add-element`:	Private ordinary functions
	`file-component`:	Public generic functions
	`file-component`:	Public generic functions
	`file-elements`:	Public generic functions
	`file-elements`:	Public generic functions
	`Function, add-file`:	Private ordinary functions
	`Function, current-file-add-element`:	Private ordinary functions
	`Function, destroy-files-container`:	Private ordinary functions
	`Function, file-add-element`:	Private ordinary functions
	`Function, get-package-and-stream`:	Private ordinary functions
	`Function, make-files-container`:	Private ordinary functions
	`Function, read-sheat-syntax`:	Private ordinary functions
	`Function, reexport`:	Private ordinary functions

G
	`Generic Function, export-content`:	Public generic functions
	`Generic Function, file-component`:	Public generic functions
	`Generic Function, file-elements`:	Public generic functions
	`Generic Function, get-load-operation`:	Private generic functions
	`Generic Function, post-process-file`:	Public generic functions
	`Generic Function, post-process-system`:	Public generic functions
	`Generic Function, pre-process-file`:	Public generic functions
	`Generic Function, pre-process-system`:	Public generic functions
	`Generic Function, scribble-package`:	Private generic functions
	`get-load-operation`:	Private generic functions
	`get-load-operation`:	Private generic functions
	`get-package-and-stream`:	Private ordinary functions

M
	`Macro, add-element`:	Private macros
	`Macro, define-adp-file`:	Public macros
	`Macro, define-adp-operation`:	Public macros
	`Macro, with-package-and-stream`:	Private macros
	`make-files-container`:	Private ordinary functions
	`Method, file-component`:	Public generic functions
	`Method, file-elements`:	Public generic functions
	`Method, get-load-operation`:	Private generic functions
	`Method, operation-done-p`:	Public standalone methods
	`Method, operation-done-p`:	Public standalone methods
	`Method, perform`:	Public standalone methods
	`Method, perform`:	Public standalone methods
	`Method, perform`:	Public standalone methods
	`Method, perform`:	Public standalone methods
	`Method, perform`:	Public standalone methods
	`Method, perform`:	Public standalone methods
	`Method, perform`:	Public standalone methods
	`Method, perform`:	Public standalone methods
	`Method, post-process-file`:	Public generic functions
	`Method, post-process-system`:	Public generic functions
	`Method, pre-process-file`:	Public generic functions
	`Method, pre-process-system`:	Public generic functions
	`Method, scribble-package`:	Private generic functions

O
	`operation-done-p`:	Public standalone methods
	`operation-done-p`:	Public standalone methods

P
	`perform`:	Public standalone methods
	`perform`:	Public standalone methods
	`perform`:	Public standalone methods
	`perform`:	Public standalone methods
	`perform`:	Public standalone methods
	`perform`:	Public standalone methods
	`perform`:	Public standalone methods
	`perform`:	Public standalone methods
	`post-process-file`:	Public generic functions
	`post-process-file`:	Public generic functions
	`post-process-system`:	Public generic functions
	`post-process-system`:	Public generic functions
	`pre-process-file`:	Public generic functions
	`pre-process-file`:	Public generic functions
	`pre-process-system`:	Public generic functions
	`pre-process-system`:	Public generic functions

R
	`read-sheat-syntax`:	Private ordinary functions
	`reexport`:	Private ordinary functions

S
	`scribble-package`:	Private generic functions
	`scribble-package`:	Private generic functions

W
	`with-package-and-stream`:	Private macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* C E S T

	Index Entry	Section

*
	`adp`:	Public special variables
	`current-content-file`:	Private special variables
	`files`:	Private special variables

C
	`component`:	Private classes

E
	`elements`:	Private classes

S
	`selfward-operation`:	Private classes
	`sideway-operation`:	Private classes
	`Slot, component`:	Private classes
	`Slot, elements`:	Private classes
	`Slot, selfward-operation`:	Private classes
	`Slot, sideway-operation`:	Private classes
	`Slot, type`:	Private classes
	`Special Variable, adp`:	Public special variables
	`Special Variable, current-content-file`:	Private special variables
	`Special Variable, files`:	Private special variables

T
	`type`:	Private classes

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	A C F P S

	Index Entry	Section

A
	`adp`:	The adp system
	`adp`:	The adp package
	`adp-op`:	Private classes
	`adp.asd`:	The adp/adp․asd file
	`adp.lisp`:	The adp/adp․lisp file

C
	`Class, adp-op`:	Private classes
	`Class, file`:	Private classes
	`Class, prepare-adp-op`:	Private classes
	`Class, scribble`:	Public classes
	`Class, scribble-source-file`:	Private classes

F
	`file`:	Private classes
	`File, adp.asd`:	The adp/adp․asd file
	`File, adp.lisp`:	The adp/adp․lisp file
	`File, package.lisp`:	The adp/package․lisp file

P
	`Package, adp`:	The adp package
	`package.lisp`:	The adp/package․lisp file
	`prepare-adp-op`:	Private classes

S
	`scribble`:	Public classes
	`scribble-source-file`:	Private classes
	`System, adp`:	The adp system

The adp Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 adp

3 Files

3.1 Lisp

3.1.1 adp/adp.asd

3.1.2 adp/package.lisp

3.1.3 adp/adp.lisp

4 Packages

4.1 adp

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Macros

5.1.3 Generic functions

5.1.4 Standalone methods

5.1.5 Classes

5.2 Internals

5.2.1 Special variables

5.2.2 Macros

5.2.3 Ordinary functions

5.2.4 Generic functions

5.2.5 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `adp`

3.1.1 `adp/adp.asd`

3.1.2 `adp/package.lisp`

3.1.3 `adp/adp.lisp`

4.1 `adp`