The adp-plain Reference Manual

This is the adp-plain Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:12:07 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 adp-plain

Add Documentation, Please... using plain text. An extension of ADP to generate files with barely additional features.

Author

Héctor Galbis Sanchis

License

MIT

Dependency

adp (system).

Source

adp-plain.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-plain/adp-plain.asd

Source

adp-plain.asd.

Parent Component

adp-plain (system).

ASDF Systems

adp-plain.


3.1.2 adp-plain/package.lisp

Source

adp-plain.asd.

Parent Component

adp-plain (system).

Packages

adp-plain.


3.1.3 adp-plain/adp-plain.lisp

Source

adp-plain.asd.

Parent Component

adp-plain (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 adp-plain

Source

package.lisp.

Use List

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 Ordinary functions

Function: output-file (path)
Package

adp-plain.

Source

adp-plain.lisp.


5.1.2 Generic functions

Generic Function: print-element (element stream)
Package

adp-plain.

Source

adp-plain.lisp.

Methods
Method: print-element (element stream)
Method: print-element ((element output-file-element) stream)

5.1.3 Standalone methods

Method: export-content ((op adp-plain-op) files system)
Package

adp.

Source

adp-plain.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *output-path*
Package

adp-plain.

Source

adp-plain.lisp.


5.2.2 Ordinary functions

Function: ensure-relative-path (path default-name default-type)
Package

adp-plain.

Source

adp-plain.lisp.


5.2.3 Generic functions

Generic Reader: output-file-path (object)
Package

adp-plain.

Methods
Reader Method: output-file-path ((output-file-element output-file-element))

automatically generated reader method

Source

adp-plain.lisp.

Target Slot

path.


5.2.4 Classes

Class: adp-plain-op
Package

adp-plain.

Source

adp-plain.lisp.

Direct superclasses

adp-op.

Direct methods

export-content.

Direct slots
Slot: selfward-operation
Package

asdf/action.

Allocation

:class

Initform

(quote #:adp-plain-op-prepare-op)

Class: output-file-element
Package

adp-plain.

Source

adp-plain.lisp.

Direct methods
Direct slots
Slot: path
Type

pathname

Initargs

:path

Readers

output-file-path.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts