The net.didierverna.declt Reference Manual

4.1.1 net.didierverna.declt/net.didierverna.declt.asd

Source

net.didierverna.declt.asd.

Parent Component

net.didierverna.declt (system).

ASDF Systems

net.didierverna.declt.

---

4.1.2 net.didierverna.declt.setup/net.didierverna.declt.setup.asd

Source

net.didierverna.declt.setup.asd.

Parent Component

net.didierverna.declt.setup (system).

ASDF Systems

net.didierverna.declt.setup.

---

4.1.3 net.didierverna.declt.core/net.didierverna.declt.core.asd

Source

net.didierverna.declt.core.asd.

Parent Component

net.didierverna.declt.core (system).

ASDF Systems

net.didierverna.declt.core.

---

4.1.4 net.didierverna.declt.assess/net.didierverna.declt.assess.asd

Source

net.didierverna.declt.assess.asd.

Parent Component

net.didierverna.declt.assess (system).

ASDF Systems

net.didierverna.declt.assess.

---

4.1.5 net.didierverna.declt.setup/package.lisp

Source

net.didierverna.declt.setup.asd.

Parent Component

net.didierverna.declt.setup (system).

Packages

net.didierverna.declt.setup.

---

4.1.6 net.didierverna.declt.setup/src/configuration.lisp

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Public Interface

• configuration (function).
• configure (function).

Internals

*configuration* (special variable).

---

4.1.7 net.didierverna.declt.setup/src/readtable.lisp

Dependency

configuration.lisp (file).

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Internals

• clindent (function).
• defindent (macro).
• i-reader (function).

---

4.1.8 net.didierverna.declt.setup/src/version.lisp

Dependency

readtable.lisp (file).

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Public Interface

• *copyright-years* (special variable).
• *release-major-level* (special variable).
• *release-minor-level* (special variable).
• *release-name* (special variable).
• *release-status* (special variable).
• *release-status-level* (special variable).
• version (function).

Internals

• %version (function).
• release-status-number (function).

---

4.1.9 net.didierverna.declt.setup/src/util.lisp

Dependency

readtable.lisp (file).

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Public Interface

• abstract-class (class).
• declare-valid-superclass (macro).
• defabstract (macro).
• endpush (macro).
• find* (function).
• make-instance (method).
• mapcat (function).
• non-empty-string (type).
• non-empty-string-p (function).
• retain (function).
• validate-superclass (method).
• validate-superclass (method).
• when-let (macro).
• when-let* (macro).
• while (macro).

---

4.1.10 net.didierverna.declt.core/package.lisp

Source

net.didierverna.declt.core.asd.

Parent Component

net.didierverna.declt.core (system).

Packages

net.didierverna.declt.

Public Interface

nickname-package (function).

---

4.1.11 net.didierverna.declt.core/src/util/misc.lisp

Source

net.didierverna.declt.core.asd.

Parent Component

util (module).

Internals

current-time-string (function).

---

4.1.12 net.didierverna.declt.core/src/doc/texi.lisp

Source

net.didierverna.declt.core.asd.

Parent Component

doc (module).

Internals

• %deffn (function).
• *fragile-characters* (special variable).
• *section-names* (special variable).
• *special-characters* (special variable).
• @anchor (function).
• @deffn (function).
• @deffnx (function).
• @deftp (function).
• @defvr (function).
• @end (function).
• @item (function).
• @itemize (function).
• @multitable (function).
• @ref (function).
• @table (function).
• add-child (function).
• copy-node (function).
• deffn (macro).
• deftp (macro).
• defvr (macro).
• escape (function).
• escape-anchor (function).
• escape-label (function).
• escape-lambda-list (function).
• first-word-length (function).
• item (macro).
• itemize (macro).
• itemize-list (function).
• make-node (function).
• multitable (macro).
• node (structure).
• node-after-menu-contents (reader).
• (setf node-after-menu-contents) (writer).
• node-before-menu-contents (reader).
• (setf node-before-menu-contents) (writer).
• node-children (reader).
• (setf node-children) (writer).
• node-name (reader).
• (setf node-name) (writer).
• node-next (reader).
• (setf node-next) (writer).
• node-p (function).
• node-previous (reader).
• (setf node-previous) (writer).
• node-section-name (reader).
• (setf node-section-name) (writer).
• node-section-type (reader).
• (setf node-section-type) (writer).
• node-synopsis (reader).
• (setf node-synopsis) (writer).
• node-up (reader).
• (setf node-up) (writer).
• read-next-line (function).
• render-node (function).
• render-text (function).
• render-to-string (macro).
• render-top-node (function).
• table (macro).

---

4.1.13 net.didierverna.declt.core/src/doc/doc.lisp

Dependency

texi.lisp (file).

Source

net.didierverna.declt.core.asd.

Parent Component

doc (module).

Internals

• *blanks* (special variable).
• anchor (function).
• anchor-and-index (function).
• anchor-name (function).
• category-name (generic function).
• context (class).
• declt-notice (reader method).
• default-values (reader method).
• document (generic function).
• document (method combination).
• foreign-definitions (reader method).
• index (function).
• index-command-name (generic function).
• locations (reader method).
• long-title (function).
• make-context (function).
• reference (function).
• render-docstring (function).
• render-references (function).
• reveal (function).
• safe-name (generic function).

---

4.1.14 net.didierverna.declt.core/src/doc/symbol.lisp

Dependency

doc.lisp (file).

Source

net.didierverna.declt.core.asd.

Parent Component

doc (module).

Internals

• *categories* (special variable).
• add-categories-node (function).
• add-category-node (function).
• add-definitions-node (function).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• category-name (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• merge-expander-p (function).
• merge-generic-writer (function).
• merge-methods (function).
• merge-ordinary-writer (function).
• render-definition-core (function).
• render-headline (function).
• render-package-reference (function).
• safe-lambda-list (function).
• safe-name (method).
• safe-name (method).
• safe-name (method).
• safe-specializers (function).

---

4.1.15 net.didierverna.declt.core/src/doc/package.lisp

Dependency

symbol.lisp (file).

Source

net.didierverna.declt.core.asd.

Parent Component

doc (module).

Internals

• add-packages-node (function).
• category-name (method).
• document (method).
• index-command-name (method).

---

4.1.16 net.didierverna.declt.core/src/doc/asdf.lisp

Dependency

package.lisp (file).

Source

net.didierverna.declt.core.asd.

Parent Component

doc (module).

Internals

• add-files-node (function).
• add-modules-node (function).
• add-systems-node (function).
• category-name (method).
• category-name (method).
• category-name (method).
• document (method).
• document (method).
• document (method).
• document (method).
• document (method).
• file-node (function).
• index-command-name (method).
• index-command-name (method).
• index-command-name (method).
• render-dependencies (function).
• render-dependency (function).
• safe-name (method).
• safe-name (method).

---

4.1.17 net.didierverna.declt.core/src/declt.lisp

Dependency

doc (module).

Source

net.didierverna.declt.core.asd.

Parent Component

src (module).

Public Interface

declt (function).

Internals

• declt-1 (function).
• render-header (function).
• select-keys (function).

---

4.1.18 net.didierverna.declt.assess/package.lisp

Source

net.didierverna.declt.assess.asd.

Parent Component

net.didierverna.declt.assess (system).

Packages

net.didierverna.declt.assess.

---

4.1.19 net.didierverna.declt.assess/src/util.lisp

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Internals

• one-liner-p (function).
• parse-contact(s) (function).
• parse-contact-string (function).
• reorder-dependency-def (function).
• reordered-dependency-def-system (function).
• source-by-name (function).
• source-by-object (function).
• validate-email (function).

---

4.1.20 net.didierverna.declt.assess/src/definition.lisp

Dependency

util.lisp (file).

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Public Interface

• definition (class).
• docstring (generic function).
• foreignp (reader method).
• (setf foreignp) (writer method).
• name (generic function).
• object (reader method).
• print-object (method).
• private-definitions (generic function).
• public-definitions (generic function).
• source-file (reader method).
• (setf source-file) (writer method).
• uid (reader method).
• (setf uid) (writer method).

Internals

• domesticp (function).
• find-definition (function).
• source-pathname (generic function).

---

4.1.21 net.didierverna.declt.assess/src/license.lisp

Dependency

definition.lisp (file).

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Internals

*licenses* (special variable).

---

4.1.22 net.didierverna.declt.assess/src/symbol.lisp

Dependency

license.lisp (file).

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Public Interface

• accessor-method-definition (class).
• accessor-mixin (class).
• alias-definition (class).
• allocation (function).
• class-definition (class).
• classoid (reader method).
• classoid-definition (class).
• clients (reader method).
• (setf clients) (writer method).
• clos-classoid-mixin (class).
• clos-slot-definition (class).
• clos-structure-definition (class).
• combination (reader method).
• combination (reader method).
• (setf combination) (writer method).
• combination-definition (class).
• combination-options (function).
• compiler-macro-alias-definition (class).
• compiler-macro-definition (class).
• condition-definition (class).
• constant-definition (class).
• definition-class (reader method).
• definition-compiler-macro (reader method).
• definition-condition (reader method).
• definition-function (reader method).
• definition-method (reader method).
• definition-structure (reader method).
• definition-symbol (reader method).
• direct-default-initargs (function).
• direct-methods (reader method).
• (setf direct-methods) (writer method).
• direct-slots (reader method).
• (setf direct-slots) (writer method).
• direct-subclasses (reader method).
• (setf direct-subclasses) (writer method).
• direct-subclassoids (reader method).
• (setf direct-subclassoids) (writer method).
• direct-subconditions (reader method).
• (setf direct-subconditions) (writer method).
• direct-substructures (reader method).
• (setf direct-substructures) (writer method).
• direct-superclasses (reader method).
• (setf direct-superclasses) (writer method).
• direct-superclassoids (reader method).
• (setf direct-superclassoids) (writer method).
• direct-superconditions (reader method).
• (setf direct-superconditions) (writer method).
• direct-superstructures (reader method).
• (setf direct-superstructures) (writer method).
• docstring (method).
• docstring (method).
• docstring (method).
• docstring (method).
• docstring (method).
• docstring (method).
• docstring (method).
• docstring (method).
• docstring (method).
• docstring (method).
• docstring (method).
• element-type (reader method).
• (setf element-type) (writer method).
• expander (reader method).
• expander (reader method).
• expander-definition (class).
• expander-for (reader method).
• (setf expander-for) (writer method).
• expanders-to (reader method).
• (setf expanders-to) (writer method).
• funcoid (reader method).
• funcoid-definition (class).
• function-alias-definition (class).
• function-definition (class).
• generic (reader method).
• generic-accessor-definition (class).
• generic-function-definition (class).
• generic-reader-definition (class).
• generic-writer-definition (class).
• home-package (reader method).
• (setf home-package) (writer method).
• identity-with-one-argument (function).
• initargs (function).
• initform (function).
• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• lambda-list (generic function).
• long-combination-definition (class).
• long-expander-definition (class).
• macro (reader method).
• macro-alias-definition (class).
• macro-definition (class).
• method-definition (class).
• method-definition-p (function).
• methods (reader method).
• (setf methods) (writer method).
• name (method).
• name (method).
• name (method).
• ordinary-accessor-definition (class).
• ordinary-function-definition (class).
• ordinary-reader-definition (class).
• ordinary-writer-definition (class).
• owner (reader method).
• owner (reader method).
• (setf owner) (writer method).
• (setf owner) (writer method).
• publicp (function).
• qualifiers (function).
• reader-method-definition (class).
• reader-method-definition-p (function).
• readers (reader method).
• (setf readers) (writer method).
• referee (reader method).
• (setf referee) (writer method).
• setfable-funcoid-definition (class).
• setfp (reader method).
• setfp (reader method).
• short-combination-definition (class).
• short-expander-definition (class).
• short-expander-definition-p (function).
• slot (reader method).
• slot-definition (class).
• special-definition (class).
• specializers (reader method).
• (setf specializers) (writer method).
• standalone-combinator (reader method).
• (setf standalone-combinator) (writer method).
• standalone-reader (reader method).
• (setf standalone-reader) (writer method).
• standalone-writer (reader method).
• (setf standalone-writer) (writer method).
• structure-definition (class).
• structure-type (reader method).
• (setf structure-type) (writer method).
• symbol-definition (class).
• symbol-definition-p (function).
• symbol-macro-definition (class).
• target-slot (reader method).
• type-definition (class).
• typed-structure-definition (class).
• typed-structure-slot-definition (class).
• value-type (generic function).
• variable-definition (class).
• varoid-definition (class).
• writer-method-definition (class).
• writer-method-definition-p (function).
• writers (reader method).
• (setf writers) (writer method).

Internals

• definition-source-by-name (function).
• make-classoid-definition (function).
• make-clos-slot-definition (function).
• make-combination-definition (function).
• make-compiler-macro-alias-definition (function).
• make-compiler-macro-definition (function).
• make-constant-definition (function).
• make-expander-definition (function).
• make-function-alias-definition (function).
• make-generic-function-definition (function).
• make-macro-alias-definition (function).
• make-macro-definition (function).
• make-method-definition (function).
• make-ordinary-function-definition (function).
• make-special-definition (function).
• make-symbol-macro-definition (function).
• make-type-definition (function).
• make-typed-structure-slot-definition (function).
• method-name (function).
• source-pathname (method).
• source-pathname (method).
• source-pathname (method).
• source-pathname (method).
• source-pathname (method).
• source-pathname (method).
• source-pathname (method).
• source-pathname (method).

---

4.1.23 net.didierverna.declt.assess/src/package.lisp

Dependency

symbol.lisp (file).

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Public Interface

• definition-package (reader method).
• definitions (reader method).
• (setf definitions) (writer method).
• initialize-instance (method).
• name (method).
• nicknames (function).
• package-definition (class).
• package-definition-p (function).
• private-definitions (method).
• public-definitions (method).
• use-list (reader method).
• (setf use-list) (writer method).
• used-by-list (reader method).
• (setf used-by-list) (writer method).

Internals

• external-symbols (reader method).
• (setf external-symbols) (writer method).
• internal-symbols (reader method).
• (setf internal-symbols) (writer method).
• make-package-definition (function).
• package-external-symbols (function).
• package-internal-symbols (function).

---

4.1.24 net.didierverna.declt.assess/src/asdf.lisp

Dependency

package.lisp (file).

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Public Interface

• authors (reader method).
• (setf authors) (writer method).
• bug-tracker (function).
• c-file-definition (class).
• children (reader method).
• (setf children) (writer method).
• cl-source-file.asd (class).
• component (reader method).
• component-definition (class).
• component-definition-p (function).
• definition-version (function).
• definitions (reader method).
• (setf definitions) (writer method).
• defsystem-dependencies (reader method).
• (setf defsystem-dependencies) (writer method).
• dependencies (reader method).
• (setf dependencies) (writer method).
• description (function).
• doc-file-definition (class).
• docstring (method).
• extension (function).
• file (reader method).
• file-definition (class).
• file-definition-p (function).
• homepage (function).
• html-file-definition (class).
• if-feature (function).
• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• java-file-definition (class).
• license-name (function).
• lisp-file-definition (class).
• lisp-file-definition-p (function).
• location (reader method).
• (setf location) (writer method).
• long-description (function).
• long-name (function).
• mailto (function).
• maintainers (reader method).
• (setf maintainers) (writer method).
• module (reader method).
• module-definition (class).
• module-definition-p (function).
• name (method).
• parent (reader method).
• (setf parent) (writer method).
• source-control (function).
• source-file-definition (class).
• static-file-definition (class).
• system (reader method).
• system-definition (class).
• system-definition-p (function).
• system-file-definition (class).

Internals

• make-file-definition (function).
• make-module-definition (function).
• make-system-definition (function).
• make-system-file-definition (function).
• make-system-file-definitions (function).
• source-pathname (method).

---

4.1.25 net.didierverna.declt.assess/src/finalize.lisp

Dependency

asdf.lisp (file).

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Internals

• *stabilized* (special variable).
• destabilize (macro).
• finalize (function).
• freeze (function).
• new-funcoid-definition (function).
• new-generic-definition (function).
• resolve-dependency-specification (function).
• stabilize (generic function).
• stabilize-clos-classoid-slot (function).
• stabilize-clos-structure-slot (function).

---

4.1.26 net.didierverna.declt.assess/src/assess.lisp

Dependency

finalize.lisp (file).

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Public Interface

• assess (function).
• conclusion (reader method).
• (setf conclusion) (writer method).
• contacts (reader method).
• (setf contacts) (writer method).
• copyright-years (reader method).
• (setf copyright-years) (writer method).
• definitions (reader method).
• (setf definitions) (writer method).
• introduction (reader method).
• (setf introduction) (writer method).
• library-name (reader method).
• (setf library-name) (writer method).
• library-version (reader method).
• (setf library-version) (writer method).
• license (reader method).
• (setf license) (writer method).
• print-object (method).
• report (class).
• system-name (reader method).
• tagline (reader method).
• (setf tagline) (writer method).

Internals

• components (function).
• file-components (function).
• funcoid-name (function).
• load-system (function).
• make-all-file-definitions (function).
• make-all-module-definitions (function).
• make-all-package-definitions (function).
• make-all-symbol-definitions (function).
• make-all-system-definitions (function).
• make-report (function).
• make-symbol-definitions (function).
• module-components (function).
• package-symbols (function).
• sub-component-p (function).
• subsystem (function).
• subsystems (function).
• system-dependencies (function).

---

6.1.1 Special variables

Special Variable: *copyright-years* ¶

A string denoting the copyright years for the whole project.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-major-level* ¶

The major level of this release.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-minor-level* ¶

The minor level of this release.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-name* ¶

The name of this release.
The general naming theme for Declt is "Star Trek characters".

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-status* ¶

The status of this release.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-status-level* ¶

The status level of this release.

Package

net.didierverna.declt.setup.

Source

version.lisp.

---

6.1.2 Macros

Macro: declare-valid-superclass (class superclass) ¶

Validate SUPERCLASS classes for CLASS classes.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: defabstract (class super-classes slots &rest options) ¶

Like DEFCLASS, but define an abstract class.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: endpush (object place) ¶

Push OBJECT at the end of PLACE.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: when-let (bindings &body body) ¶

Execute BODY only when all BINDINGS are non-nil.
BINDINGS must be either a single binding of the form (VARIABLE VALUE), or a list of such. VALUEs are computed sequentially in the specified order, and then VARIABLEs are bound to the corresponding VALUEs. If all VALUEs are non-nil, BODY is executed.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: when-let* (bindings &body body) ¶

Execute BODY only when all BINDINGS are non-nil.
BINDINGS must be either a single binding of the form (VARIABLE VALUE),
or a list of such. VARIABLEs are bound to their respective VALUE sequentially, so that each VALUE expression may refer to a previously bound VARIABLE. Execution stops completely as soon as a null VALUE is encountered. Otherwise, BODY is executed as an implicit PROGN.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: while (test &body body) ¶

Execute BODY while TEST.

Package

net.didierverna.declt.setup.

Source

util.lisp.

---

6.1.3 Ordinary functions

Function: allocation (definition) ¶

Return CLOS slot DEFINITION’s allocation type.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: assess (system-name &key introspection-level library-name tagline library-version contact copyright-years license introduction conclusion) ¶

Extract and return documentation information for ASDF SYSTEM-NAME.
The documentation information is returned in a REPORT structure, which see.

SYSTEM-NAME is an ASDF system designator. The following keyword parameters allow to specify or override some bits of information.
- INTROSPECTION-LEVEL: how hard to introspect the Lisp environment. At level 1 (the default), scan only the symbols from domestic packages. At level 2, scan all accessible symbols in the Lisp environment. Some additional information may be discovered in the process, at the expense of a much higher computation time.
- LIBRARY-NAME: name of the library being documented. Defaults to the system name.
- TAGLINE: small text to be used as the manual’s subtitle, or NIL. Defaults to the system long name or description.
- LIBRARY-VERSION: version information, or NIL.
Defaults to the system version.
- CONTACT: contact information, or NIL. The default value is computed from the system maintainer(s), author(s), and mailto information. Accepts a contact string, or a list of such. See ‘parse-contact-string’ for more information. - COPYRIGHT-YEARS: copyright years information or NIL. Defaults to the current year.
- LICENSE: license information. Defaults to NIL. Also accepts :mit, :boost, :bsd, :gpl, :lgpl, and :ms-pl.
- INTRODUCTION: introduction chapter contents in Texinfo format.
Defaults to NIL.
- CONCLUSION: conclusion chapter contents in Texinfo format.
Defaults to NIL.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: bug-tracker (definition) ¶

Return system DEFINITION’s bug tracker, or NIL.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: combination-options (definition) ¶

Return generic function DEFINITION’s method combination options.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: component-definition-p (definition) ¶

Return T if DEFINITION is a component definition.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: configuration (key) ¶

Return KEY’s value in the current Declt configuration.

Package

net.didierverna.declt.setup.

Source

configuration.lisp.

Function: configure (key value) ¶

Set KEY to VALUE in the current Declt configuration.

Package

net.didierverna.declt.setup.

Source

configuration.lisp.

Function: declt (system-name &rest keys &key introspection-level library-name tagline library-version contact copyright-years license introduction conclusion locations default-values foreign-definitions declt-notice output-directory file-name info-name info-category) ¶

Generate a reference manual for ASDF SYSTEM-NAME.
The reference manual is currently generated in Texinfo format.

For a description of SYSTEM-NAME, INTROSPECTION-LEVEL, LIBRARY-NAME, TAGLINE, LIBRARY-VERSION, CONTACT, COPYRIGHT-YEARS, LICENSE, INTRODUCTION, and CONCLUSION, see ‘assess’.

For a description of LOCATIONS, DEFAULT-VALUES, FOREIGN-DEFINITIONS, and DECLT-NOTICE, see ‘make-context’.

The following keyword parameters are also available.
- OUTPUT-DIRECTORY: output directory for the generated reference manual. Defaults to the current directory.
- FILE-NAME: base name for the generated reference manual, sans extension. Defaults to the system name.
- INFO-NAME: base name for the subsequent Info file, sans extension (this name appears in the Texinfo file). Defaults to FILE-NAME.
- INFO-CATEGORY: category under which to install the Info file (technically, this provides the value for Texinfo’s @dircategory command).
Defaults to "Common Lisp".

Package

net.didierverna.declt.

Source

declt.lisp.

Function: definition-version (definition) ¶

Return component DEFINITION’s version string.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: description (definition) ¶

Return component DEFINITION’s description.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: direct-default-initargs (definition) ¶

Return CLOS classoid mixin DEFINITION’s direct default initargs.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: extension (definition) ¶

Return file DEFINITION’s file extension, if any.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: file-definition-p (definition) ¶

Return T if DEFINITION is a file definition.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: find* (object list &key test key pre-test) ¶

Return the first finding of OBJECT in LIST, or NIL.
Each item in LIST is TESTed with EQ by default. TEST is performed on the item itself by default, or on the result of applying KEY to it. Optionally, only items satisfying PRE-TEST are considered.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Function: homepage (definition) ¶

Return system DEFINITION’s homepage, or NIL.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: identity-with-one-argument (definition) ¶

Return short combination DEFINITION’s :identity-with-one-argument option.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: if-feature (definition) ¶

Return component DEFINITION’s if-feature.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: initargs (definition) ¶

Return CLOS slot DEFINITION’s initargs.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: initform (definition) ¶

Return CLOS slot DEFINITION’s initform.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: license-name (definition) ¶

Return system DEFINITION’s license name, or NIL.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: lisp-file-definition-p (definition) ¶

Return T if DEFINITION is a Lisp file definition.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: long-description (definition) ¶

Return component DEFINITION’s long description.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: long-name (definition) ¶

Return system DEFINITION’s long name, or NIL.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: mailto (definition) ¶

Return system DEFINITION’s mailto, or NIL.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: mapcat (function &rest lists) ¶

Short for "mapconcat": non destructive version of MAPCAN. That is, concatenate the results with APPEND rather than NCONC.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Function: method-definition-p (definition) ¶

Return T if DEFINITION is a method definition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: module-definition-p (definition) ¶

Return T if DEFINITION is a module definition.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: nickname-package (&optional nickname) ¶

Add NICKNAME (:DECLT by default) to the :NET.DIDIERVERNA.DECLT package.

Package

net.didierverna.declt.

Source

package.lisp.

Function: nicknames (package-definition) ¶

Return the list of nicknames for PACKAGE-DEFINITION.

Package

net.didierverna.declt.assess.

Source

package.lisp.

Function: non-empty-string-p (object) ¶

Return T if OBJECT is a non-empty string.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Function: package-definition-p (definition) ¶

Return T if DEFINITION is a package definition.

Package

net.didierverna.declt.assess.

Source

package.lisp.

Function: publicp (definition) ¶

Return T is DEFINITION is public.
A definition is public when the symbol naming it has a home package, and is exported from it.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: qualifiers (definition) ¶

Return method DEFINITION’s method qualifiers.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: reader-method-definition-p (definition) ¶

Return T if DEFINITION is a reader method definition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: retain (object list &key test key pre-test) ¶

Return a copy of LIST from which only OBJECT is retained.
Each item in LIST is TESTed with EQ by default. TEST is performed on the item itself by default, or on the result of applying KEY to it. Optionally, only items satisfying PRE-TEST are considered.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Function: short-expander-definition-p (definition) ¶

Return T if DEFINITION is a short expander definition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: source-control (definition) ¶

Return system DEFINITION’s source control, or NIL.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: symbol-definition-p (definition) ¶

Return T if DEFINITION is a symbol definition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: system-definition-p (definition) ¶

Return T if DEFINITION is a system definition.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: version (&optional type) ¶

Return the current version of Declt.
TYPE can be one of :number, :short or :long.

A version number is computed as major*10000 + minor*100 + patchlevel, leaving two digits for each level. Alpha, beta and rc status are ignored in version numbers.

A short version is something like 1.3{a,b,rc}4, or 1.3.4 for patchlevel. Alpha, beta or rc levels start at 1. Patchlevels start at 0 but are ignored in the output, so that 1.3.0 appears as just 1.3.

A long version is something like
1.3 {alpha,beta,release candidate,patchlevel} 4 "James T. Kirk". As for the short version, a patchlevel of 0 is ignored in the output.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Function: writer-method-definition-p (definition) ¶

Return T if DEFINITION is a writer method definition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

---

6.1.4 Generic functions

Generic Reader: authors (object) ¶

Generic Writer: (setf authors) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: authors ((system-definition system-definition)) ¶

Writer Method: (setf authors) ((system-definition system-definition)) ¶

The list of parsed author contacts.
See ‘parse-contact-string’ for more information.

Source

asdf.lisp.

Target Slot

authors.

Generic Reader: children (object) ¶

Generic Writer: (setf children) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: children ((module-definition module-definition)) ¶

Writer Method: (setf children) ((module-definition module-definition)) ¶

The list of child definitions for this definition’s module.

Source

asdf.lisp.

Target Slot

children.

Generic Reader: classoid (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: classoid ((classoid-definition classoid-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: clients (object) ¶

Generic Writer: (setf clients) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: clients ((combination-definition combination-definition)) ¶

Writer Method: (setf clients) ((combination-definition combination-definition)) ¶

The list of client definitions for this definition’s method combnination. These are generic functions using this combination.

Source

symbol.lisp.

Target Slot

clients.

Generic Reader: combination (object) ¶

Generic Writer: (setf combination) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: combination ((generic-function-definition generic-function-definition)) ¶

Writer Method: (setf combination) ((generic-function-definition generic-function-definition)) ¶

The method combination definition for this definition’s generic function.

Source

symbol.lisp.

Target Slot

combination.

Reader Method: combination ((combination-definition combination-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: component (object) ¶

Package

net.didierverna.declt.assess.

Methods

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

automatically generated reader method

Source

asdf.lisp.

Target Slot

object.

Generic Reader: conclusion (object) ¶

Generic Writer: (setf conclusion) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: conclusion ((report report)) ¶

Writer Method: (setf conclusion) ((report report)) ¶

Contents for a conclusion chapter.

Source

assess.lisp.

Target Slot

conclusion.

Generic Reader: contacts (object) ¶

Generic Writer: (setf contacts) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: contacts ((report report)) ¶

Writer Method: (setf contacts) ((report report)) ¶

The list of contacts for the library.
Each element is of the form (NAME . EMAIL) where both NAME and EMAIL are strings or NIL, and cannot be null at the same time.

Source

assess.lisp.

Target Slot

contacts.

Generic Reader: copyright-years (object) ¶

Generic Writer: (setf copyright-years) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: copyright-years ((report report)) ¶

Writer Method: (setf copyright-years) ((report report)) ¶

A copyright years string.

Source

assess.lisp.

Target Slot

copyright-years.

Generic Reader: definition-class (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definition-class ((class-definition class-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: definition-compiler-macro (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definition-compiler-macro ((compiler-macro-definition compiler-macro-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: definition-condition (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definition-condition ((condition-definition condition-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: definition-function (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definition-function ((function-definition function-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: definition-method (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definition-method ((method-definition method-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: definition-package (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definition-package ((package-definition package-definition)) ¶

automatically generated reader method

Source

package.lisp.

Target Slot

object.

Generic Reader: definition-structure (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definition-structure ((structure-definition structure-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: definition-symbol (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definition-symbol ((symbol-definition symbol-definition)) ¶

The symbol naming this definition.

Source

symbol.lisp.

Target Slot

symbol.

Generic Reader: definitions (object) ¶

Generic Writer: (setf definitions) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: definitions ((report report)) ¶

Writer Method: (setf definitions) ((report report)) ¶

The list of definitions.

Source

assess.lisp.

Target Slot

definitions.

Reader Method: definitions ((lisp-file-definition lisp-file-definition)) ¶

Writer Method: (setf definitions) ((lisp-file-definition lisp-file-definition)) ¶

The list of definitions for this definition’s file.

Source

asdf.lisp.

Target Slot

definitions.

Reader Method: definitions ((package-definition package-definition)) ¶

Writer Method: (setf definitions) ((package-definition package-definition)) ¶

The list of corresponding definitions.

Source

package.lisp.

Target Slot

definitions.

Generic Reader: defsystem-dependencies (object) ¶

Generic Writer: (setf defsystem-dependencies) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: defsystem-dependencies ((system-definition system-definition)) ¶

Writer Method: (setf defsystem-dependencies) ((system-definition system-definition)) ¶

The list of defsystem dependency definitions.

Source

asdf.lisp.

Target Slot

defsystem-dependencies.

Generic Reader: dependencies (object) ¶

Generic Writer: (setf dependencies) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: dependencies ((component-definition component-definition)) ¶

Writer Method: (setf dependencies) ((component-definition component-definition)) ¶

The list of dependency definitions for this definition’s component.

Source

asdf.lisp.

Target Slot

dependencies.

Generic Reader: direct-methods (object) ¶

Generic Writer: (setf direct-methods) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-methods ((clos-classoid-mixin clos-classoid-mixin)) ¶

Writer Method: (setf direct-methods) ((clos-classoid-mixin clos-classoid-mixin)) ¶

The list of direct method definitions for this definition’s classoid.

Source

symbol.lisp.

Target Slot

direct-methods.

Generic Reader: direct-slots (object) ¶

Generic Writer: (setf direct-slots) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-slots ((classoid-definition classoid-definition)) ¶

Writer Method: (setf direct-slots) ((classoid-definition classoid-definition)) ¶

The list of direct slot definitions for this definition’s classoid.

Source

symbol.lisp.

Target Slot

direct-slots.

Generic Reader: direct-subclasses (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-subclasses ((class-definition class-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

direct-subclassoids.

Generic Writer: (setf direct-subclasses) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Writer Method: (setf direct-subclasses) ((class-definition class-definition)) ¶

automatically generated writer method

Source

symbol.lisp.

Target Slot

direct-subclassoids.

Generic Reader: direct-subclassoids (object) ¶

Generic Writer: (setf direct-subclassoids) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-subclassoids ((clos-classoid-mixin clos-classoid-mixin)) ¶

Writer Method: (setf direct-subclassoids) ((clos-classoid-mixin clos-classoid-mixin)) ¶

The list of direct subclassoid definitions for this definition’s classoid.

Source

symbol.lisp.

Target Slot

direct-subclassoids.

Generic Reader: direct-subconditions (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-subconditions ((condition-definition condition-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

direct-subclassoids.

Generic Writer: (setf direct-subconditions) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Writer Method: (setf direct-subconditions) ((condition-definition condition-definition)) ¶

automatically generated writer method

Source

symbol.lisp.

Target Slot

direct-subclassoids.

Generic Reader: direct-substructures (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-substructures ((clos-structure-definition clos-structure-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

direct-subclassoids.

Generic Writer: (setf direct-substructures) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Writer Method: (setf direct-substructures) ((clos-structure-definition clos-structure-definition)) ¶

automatically generated writer method

Source

symbol.lisp.

Target Slot

direct-subclassoids.

Generic Reader: direct-superclasses (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-superclasses ((class-definition class-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

direct-superclassoids.

Generic Writer: (setf direct-superclasses) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Writer Method: (setf direct-superclasses) ((class-definition class-definition)) ¶

automatically generated writer method

Source

symbol.lisp.

Target Slot

direct-superclassoids.

Generic Reader: direct-superclassoids (object) ¶

Generic Writer: (setf direct-superclassoids) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-superclassoids ((clos-classoid-mixin clos-classoid-mixin)) ¶

Writer Method: (setf direct-superclassoids) ((clos-classoid-mixin clos-classoid-mixin)) ¶

The list of direct superclassoid definitions for this definition’s classoid.

Source

symbol.lisp.

Target Slot

direct-superclassoids.

Generic Reader: direct-superconditions (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-superconditions ((condition-definition condition-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

direct-superclassoids.

Generic Writer: (setf direct-superconditions) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Writer Method: (setf direct-superconditions) ((condition-definition condition-definition)) ¶

automatically generated writer method

Source

symbol.lisp.

Target Slot

direct-superclassoids.

Generic Reader: direct-superstructures (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: direct-superstructures ((clos-structure-definition clos-structure-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

direct-superclassoids.

Generic Writer: (setf direct-superstructures) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Writer Method: (setf direct-superstructures) ((clos-structure-definition clos-structure-definition)) ¶

automatically generated writer method

Source

symbol.lisp.

Target Slot

direct-superclassoids.

Generic Function: docstring (definition) ¶

Return DEFINITION’s docstring (Lisp documentation).

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Methods

Method: docstring ((definition component-definition)) ¶

Return component DEFINITION’s description. This is the same as the ‘description’ function.

Source

asdf.lisp.

Method: docstring ((definition function-alias-definition)) ¶

Return function alias DEFINITION’s docstring. This is the docstring attached to DEFINITION’s name, rather than the one attached to the function.

Source

symbol.lisp.

Method: docstring ((definition compiler-macro-alias-definition)) ¶

Return compiler macro alias DEFINITION’s docstring.
This is the docstring attached to DEFINITION’s name, rather than the one attached to the compiler macro function.

Source

symbol.lisp.

Method: docstring ((definition macro-alias-definition)) ¶

Return macro alias DEFINITION’s docstring.
This is the docstring attached to DEFINITION’s symbol, rather than the one attached to the macro function.

Source

symbol.lisp.

Method: docstring ((definition typed-structure-slot-definition)) ¶

Return NIL.

Source

symbol.lisp.

Method: docstring ((definition clos-slot-definition)) ¶

Return CLOS slot DEFINITION’s docstring.

Source

symbol.lisp.

Method: docstring ((definition typed-structure-definition)) ¶

Return typed structure DEFINITION’s docstring.

Source

symbol.lisp.

Method: docstring ((definition combination-definition)) ¶

Return method combination DEFINITION’s docstring.

Source

symbol.lisp.

Method: docstring ((definition expander-definition)) ¶

Return setf expander DEFINITION’s docstring.

Source

symbol.lisp.

Method: docstring ((definition type-definition)) ¶

Return type DEFINITION’s docstring.

Source

symbol.lisp.

Method: docstring ((definition symbol-macro-definition)) ¶

Return NIL (symbol macros don’t have a docstring).

Source

symbol.lisp.

Method: docstring ((definition variable-definition)) ¶

Return variable DEFINITION’s docstring.

Source

symbol.lisp.

Method: docstring (definition) ¶

Return DEFINITION’s object canonical documentation. This is the default method.

Generic Reader: element-type (object) ¶

Generic Writer: (setf element-type) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: element-type ((typed-structure-definition typed-structure-definition)) ¶

Writer Method: (setf element-type) ((typed-structure-definition typed-structure-definition)) ¶

The structure’s element type.
It is T for list structures, but may be something else for vector ones.

Source

symbol.lisp.

Target Slot

element-type.

Generic Reader: expander (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: expander ((expander-definition expander-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Reader Method: expander ((type-definition type-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: expander-for (object) ¶

Generic Writer: (setf expander-for) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: expander-for ((setfable-funcoid-definition setfable-funcoid-definition)) ¶

Writer Method: (setf expander-for) ((setfable-funcoid-definition setfable-funcoid-definition)) ¶

A setf expander definition for this funcoid, or NIL.
This is the definition of a setf expander that expands forms identical to this funcoid’s signature. There can be only one. Note that the Common Lisp standard does not impose any actual relation between the setf expander and its access-fn. In fact, the access-fn may not even exist at all. However, if it does, it is very likely that it is a reader for the place updated by this setf expander.

Source

symbol.lisp.

Target Slot

expander-for.

Generic Reader: expanders-to (object) ¶

Generic Writer: (setf expanders-to) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: expanders-to ((setfable-funcoid-definition setfable-funcoid-definition)) ¶

Writer Method: (setf expanders-to) ((setfable-funcoid-definition setfable-funcoid-definition)) ¶

The list of setf expander definitions to this funcoid.
This is a list of definitions for short form setf expanders that have this funcoid as their update-fn. There might be more than one.

Source

symbol.lisp.

Target Slot

expanders-to.

Generic Reader: file (object) ¶

Package

net.didierverna.declt.assess.

Methods

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

automatically generated reader method

Source

asdf.lisp.

Target Slot

object.

Generic Reader: foreignp (object) ¶

Generic Writer: (setf foreignp) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: foreignp ((definition definition)) ¶

Writer Method: (setf foreignp) ((definition definition)) ¶

Whether this definition is foreign.

Source

definition.lisp.

Target Slot

foreign.

Generic Reader: funcoid (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: funcoid ((funcoid-definition funcoid-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: generic (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: generic ((generic-function-definition generic-function-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: home-package (object) ¶

Generic Writer: (setf home-package) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: home-package ((symbol-definition symbol-definition)) ¶

Writer Method: (setf home-package) ((symbol-definition symbol-definition)) ¶

The home package definition for this definition’s symbol.
Every definition gets a home package, even foreign ones. A home package can only be null when the definition’s symbol is uninterned.

Source

symbol.lisp.

Target Slot

home-package.

Generic Reader: introduction (object) ¶

Generic Writer: (setf introduction) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: introduction ((report report)) ¶

Writer Method: (setf introduction) ((report report)) ¶

Contents for an introduction chapter.

Source

assess.lisp.

Target Slot

introduction.

Generic Function: lambda-list (definition) ¶

Return funcoid DEFINITION’s lambda-list.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Methods

Method: lambda-list ((definition alias-definition)) ¶

Return the lambda-list of alias DEFINITION’s referee.

Method: lambda-list ((definition method-definition)) ¶

Return method DEFINITION’s method lambda-list.

Method: lambda-list ((definition combination-definition)) ¶

Return method combination DEFINITION’s lambda-list.

Method: lambda-list ((definition long-expander-definition)) ¶

Return long setf expander DEFINITION’s expander function’s lambda-list.

Method: lambda-list ((definition short-expander-definition)) ¶

Return short setf expander DEFINITION’s lambda-list.
This lambda-list is computed as the shortened version of DEFINITION’s update-fn lambda-list, because setf expanders pass the new value as the last argument to their operator.
If the expander’s update-fn is not defined, return two values: NIL and T.

Method: lambda-list ((definition type-definition)) ¶

Return type DEFINITION’s type lambda-list.

Method: lambda-list ((definition funcoid-definition)) ¶

Return funcoid DEFINITION’s function lambda-list. This is the default method.

Method: lambda-list :around ((definition funcoid-definition)) ¶

Return only the lambda-list’s CDR for setf definitions.
This only applies to compiler macros and functions (to filter out the parameter corresponding to the new value) but does nothing on setf expanders because their primary methods already do the filtering (differently).

Generic Reader: library-name (object) ¶

Generic Writer: (setf library-name) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: library-name ((report report)) ¶

Writer Method: (setf library-name) ((report report)) ¶

The library’s name.

Source

assess.lisp.

Target Slot

library-name.

Generic Reader: library-version (object) ¶

Generic Writer: (setf library-version) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: library-version ((report report)) ¶

Writer Method: (setf library-version) ((report report)) ¶

The library’s version.

Source

assess.lisp.

Target Slot

library-version.

Generic Reader: license (object) ¶

Generic Writer: (setf license) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: license ((report report)) ¶

Writer Method: (setf license) ((report report)) ¶

The library’s license.

Source

assess.lisp.

Target Slot

license.

Generic Reader: location (object) ¶

Generic Writer: (setf location) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: location ((component-definition component-definition)) ¶

Writer Method: (setf location) ((component-definition component-definition)) ¶

The component’s location (a namestring).

Source

asdf.lisp.

Target Slot

location.

Generic Reader: macro (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: macro ((macro-definition macro-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: maintainers (object) ¶

Generic Writer: (setf maintainers) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: maintainers ((system-definition system-definition)) ¶

Writer Method: (setf maintainers) ((system-definition system-definition)) ¶

The list of parsed maintainer contacts.
See ‘parse-contact-string’ for more information.

Source

asdf.lisp.

Target Slot

maintainers.

Generic Reader: methods (object) ¶

Generic Writer: (setf methods) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: methods ((generic-function-definition generic-function-definition)) ¶

Writer Method: (setf methods) ((generic-function-definition generic-function-definition)) ¶

The list of method definitions for this definition’s generic function.

Source

symbol.lisp.

Target Slot

methods.

Generic Reader: module (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: module ((module-definition module-definition)) ¶

automatically generated reader method

Source

asdf.lisp.

Target Slot

object.

Generic Function: name (definition) ¶

The definition’s name.
This is the native Lisp name for the definition’s corresponding object. It’s either a string (for ASDF components and packages), a symbol, or a list of the form (setf symbol).

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Methods

Method: name ((definition component-definition)) ¶

Return component DEFINITION’s component name.

Source

asdf.lisp.

Method: name ((definition package-definition)) ¶

Return package DEFINITION’s package name.

Source

package.lisp.

Method: name :around ((definition alias-definition)) ¶

Wrap alias DEFINITION’s name in a SETF list when appropriate.

Source

symbol.lisp.

Method: name :around ((definition funcoid-definition)) ¶

Wrap funcoid DEFINITION’s name in a SETF list when appropriate.

Source

symbol.lisp.

Method: name ((definition symbol-definition)) ¶

Return symbol DEFINITION’s symbol.

Source

symbol.lisp.

Generic Reader: object (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: object ((definition definition)) ¶

The corresponding Lisp object, or NIL.
Only constants, special variables, symbol macros, and aliases lack such an object.

Source

definition.lisp.

Target Slot

object.

Generic Reader: owner (object) ¶

Generic Writer: (setf owner) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: owner ((slot-definition slot-definition)) ¶

Writer Method: (setf owner) ((slot-definition slot-definition)) ¶

The definition for the owner of this definition’s slot.

Source

symbol.lisp.

Target Slot

owner.

Reader Method: owner ((method-definition method-definition)) ¶

Writer Method: (setf owner) ((method-definition method-definition)) ¶

The generic function definition for this definition’s method.

Source

symbol.lisp.

Target Slot

owner.

Generic Reader: parent (object) ¶

Generic Writer: (setf parent) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: parent ((component-definition component-definition)) ¶

Writer Method: (setf parent) ((component-definition component-definition)) ¶

The parent definition for this definition’s component.

Source

asdf.lisp.

Target Slot

parent.

Generic Function: private-definitions (object) ¶

Return OBJECT’s private definitions.

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Methods

Method: private-definitions ((definition package-definition)) ¶

Return package DEFINITION’s private definitions.

Source

package.lisp.

Method: private-definitions (object) ¶

Return OBJECT’s private definitions from its definitions list. This is the default method for heterogeneous definitions lists.

Generic Function: public-definitions (object) ¶

Return OBJECT’s public definitions.

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Methods

Method: public-definitions ((definition package-definition)) ¶

Return package DEFINITION’s public definitions.

Source

package.lisp.

Method: public-definitions (object) ¶

Return OBJECT’s public definitions from its definitions list. This is the default method for heterogeneous definitions lists.

Generic Reader: readers (object) ¶

Generic Writer: (setf readers) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: readers ((slot-definition slot-definition)) ¶

Writer Method: (setf readers) ((slot-definition slot-definition)) ¶

The list of definitions for this definition’s slot readers.

Source

symbol.lisp.

Target Slot

readers.

Generic Reader: referee (object) ¶

Generic Writer: (setf referee) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: referee ((alias-definition alias-definition)) ¶

Writer Method: (setf referee) ((alias-definition alias-definition)) ¶

The original definition this definition aliases.

Source

symbol.lisp.

Target Slot

referee.

Generic Reader: setfp (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: setfp ((alias-definition alias-definition)) ¶

Whether this is a setf alias definition.

Source

symbol.lisp.

Target Slot

setf.

Reader Method: setfp ((funcoid-definition funcoid-definition)) ¶

Whether this is a setf definition.

Source

symbol.lisp.

Target Slot

setf.

Generic Reader: slot (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: slot ((slot-definition slot-definition)) ¶

automatically generated reader method

Source

symbol.lisp.

Target Slot

object.

Generic Reader: source-file (object) ¶

Generic Writer: (setf source-file) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: source-file ((definition definition)) ¶

Writer Method: (setf source-file) ((definition definition)) ¶

The source file definition for this definition’s object.

Source

definition.lisp.

Target Slot

source-file.

Generic Reader: specializers (object) ¶

Generic Writer: (setf specializers) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: specializers ((method-definition method-definition)) ¶

Writer Method: (setf specializers) ((method-definition method-definition)) ¶

The specializers of this definition’s method.
This is a list of either class definitions (for regular specializers), or raw EQL specializers.

Source

symbol.lisp.

Target Slot

specializers.

Generic Reader: standalone-combinator (object) ¶

Generic Writer: (setf standalone-combinator) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: standalone-combinator ((short-combination-definition short-combination-definition)) ¶

Writer Method: (setf standalone-combinator) ((short-combination-definition short-combination-definition)) ¶

The corresponding standalone combinator definition, or NIL.
This is a function or macro definition. Note that if this definition is unavailable, it means that the method combination itself cannot be used (yet).

Source

symbol.lisp.

Target Slot

standalone-combinator.

Generic Reader: standalone-reader (object) ¶

Generic Writer: (setf standalone-reader) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: standalone-reader ((expander-definition expander-definition)) ¶

Writer Method: (setf standalone-reader) ((expander-definition expander-definition)) ¶

A standalone reader definition for this definition’s expander, or NIL.
If it exists, it’s a definition for a function or macro with the same signature as that of the expander’s access-fn. Note that the Common Lisp standard does not impose any actual relation between the setf expander and its access-fn. In fact, the access-fn may not even exist at all. However, if it does, it is very likely that it is a reader for the place updated by this setf expander.

Source

symbol.lisp.

Target Slot

standalone-reader.

Generic Reader: standalone-writer (object) ¶

Generic Writer: (setf standalone-writer) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: standalone-writer ((short-expander-definition short-expander-definition)) ¶

Writer Method: (setf standalone-writer) ((short-expander-definition short-expander-definition)) ¶

A standalone writer definition for this definition’s expander, or NIL. This is a function or macro definition. Note that if this definition is unavailable, it means that the expander itself cannot be used (yet).

Source

symbol.lisp.

Target Slot

standalone-writer.

Generic Reader: structure-type (object) ¶

Generic Writer: (setf structure-type) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: structure-type ((typed-structure-definition typed-structure-definition)) ¶

Writer Method: (setf structure-type) ((typed-structure-definition typed-structure-definition)) ¶

The structure type, either LIST or VECTOR.

Source

symbol.lisp.

Target Slot

type.

Generic Reader: system (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: system ((system-definition system-definition)) ¶

automatically generated reader method

Source

asdf.lisp.

Target Slot

object.

Generic Reader: system-name (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: system-name ((report report)) ¶

The main system’s name, coerced to a string.

Source

assess.lisp.

Target Slot

system-name.

Generic Reader: tagline (object) ¶

Generic Writer: (setf tagline) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: tagline ((report report)) ¶

Writer Method: (setf tagline) ((report report)) ¶

The reference manual’s tagline.

Source

assess.lisp.

Target Slot

tagline.

Generic Reader: target-slot (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: target-slot ((accessor-mixin accessor-mixin)) ¶

The target slot definition for this definition’s accessor.

Source

symbol.lisp.

Target Slot

target-slot.

Generic Reader: uid (object) ¶

Generic Writer: (setf uid) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: uid ((definition definition)) ¶

Writer Method: (setf uid) ((definition definition)) ¶

This definition’s UID.

Source

definition.lisp.

Target Slot

uid.

Generic Reader: use-list (object) ¶

Generic Writer: (setf use-list) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: use-list ((package-definition package-definition)) ¶

Writer Method: (setf use-list) ((package-definition package-definition)) ¶

The definitions use-list for this definition’s package.

Source

package.lisp.

Target Slot

use-list.

Generic Reader: used-by-list (object) ¶

Generic Writer: (setf used-by-list) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: used-by-list ((package-definition package-definition)) ¶

Writer Method: (setf used-by-list) ((package-definition package-definition)) ¶

The definitions used-by-list for this definition’s package.

Source

package.lisp.

Target Slot

used-by-list.

Generic Function: value-type (definition) ¶

Return slot DEFINITION’s value type.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Methods

Method: value-type ((definition typed-structure-slot-definition)) ¶

Return typed structure slot DEFINITION’s value type.

Method: value-type ((definition clos-slot-definition)) ¶

Return CLOS slot DEFINITION’s value type.

Generic Reader: writers (object) ¶

Generic Writer: (setf writers) (object) ¶

Package

net.didierverna.declt.assess.

Methods

Reader Method: writers ((slot-definition slot-definition)) ¶

Writer Method: (setf writers) ((slot-definition slot-definition)) ¶

The list of definitions for this definition’s slot writers.

Source

symbol.lisp.

Target Slot

writers.

---