The net.didierverna.declt Reference Manual

This is the net.didierverna.declt Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:03:52 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 net.didierverna.declt

A reference manual generator for Common Lisp libraries

Long Name

Documentation Extractor from Common Lisp to Texinfo

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/typesetting.php#declt

Source Control

https://github.com/didierverna/declt

License

BSD

Long Description

Declt (pronounce dec’let) is a reference manual generator for Common Lisp. It extracts and formats documentation from ASDF systems, including the system itself, its local dependencies (subsystems), components, packages and an extensive list of definitions (variables, functions etc.). The formatted documentation comes with full indexing and cross-references.

Reference manuals are generated in Texinfo format which can subsequently be converted into info, HTML, DVI, PostScript or PDF.

If Feature

:sbcl

Dependencies
Source

net.didierverna.declt.asd.


2.2 net.didierverna.declt.setup

Declt’s preload setup

Long Name

Documentation Extractor from Common Lisp to Texinfo, setup library

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/typesetting.php#declt

Source Control

https://github.com/didierverna/declt

License

BSD

Long Description

The Declt setup library provides support for various preload configuration parameters and meta-utilities. For a more complete description of Declt, see the ‘net.didierverna.declt’ system.

Dependency

named-readtables (system).

Source

net.didierverna.declt.setup.asd.

Child Components

2.3 net.didierverna.declt.core

Declt’s core functionality

Long Name

Documentation Extractor from Common Lisp to Texinfo, core library

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/typesetting.php#declt

Source Control

https://github.com/didierverna/declt

License

BSD

Long Description

The Declt core library provides the main functionality of Declt. For a more complete description of Declt, see the ‘net.didierverna.declt’ system.

If Feature

:sbcl

Dependencies
Source

net.didierverna.declt.core.asd.

Child Components

2.4 net.didierverna.declt.assess

Declt’s information gathering pipeline stage

Long Name

Documentation Extractor from Common Lisp to Texinfo, assessment library

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/typesetting.php#declt

Source Control

https://github.com/didierverna/declt

License

BSD

Long Description

The Declt assessment library collects information from ASDF systems by introspection, and produces an abstract representation, independent from both the final manual’s organization and the output format. For a more complete description of Declt, see the ‘net.didierverna.declt’ system.

If Feature

:sbcl

Dependencies
Source

net.didierverna.declt.assess.asd.

Child Components

3 Modules

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


3.1 net.didierverna.declt.setup/src

Dependency

package.lisp (file).

Source

net.didierverna.declt.setup.asd.

Parent Component

net.didierverna.declt.setup (system).

Child Components

3.2 net.didierverna.declt.core/src

Dependency

package.lisp (file).

Source

net.didierverna.declt.core.asd.

Parent Component

net.didierverna.declt.core (system).

Child Components

3.3 net.didierverna.declt.core/src/util

Source

net.didierverna.declt.core.asd.

Parent Component

src (module).

Child Component

misc.lisp (file).


3.4 net.didierverna.declt.core/src/doc

Dependency

util (module).

Source

net.didierverna.declt.core.asd.

Parent Component

src (module).

Child Components

3.5 net.didierverna.declt.assess/src

Dependency

package.lisp (file).

Source

net.didierverna.declt.assess.asd.

Parent Component

net.didierverna.declt.assess (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 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.6 net.didierverna.declt.setup/src/configuration.lisp

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Public Interface
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

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
Internals

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

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

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

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

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

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

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

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.

Public Interface

nickname-package (function).


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

Source

net.didierverna.declt.assess.asd.

Parent Component

src (module).

Internals

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
Internals

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
Internals

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
Internals

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
Internals

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

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
Internals

5 Packages

Packages are listed by definition order.


5.1 net.didierverna.declt.assess

The Declt assessment library’s package.

Source

package.lisp.

Nickname

assess

Use List
Used By List

net.didierverna.declt.

Public Interface
Internals

5.2 net.didierverna.declt.setup

The Declt setup library’s package.

Source

package.lisp.

Use List

common-lisp.

Used By List
Public Interface
Internals

5.3 net.didierverna.declt

The Declt library’s package.

Source

package.lisp.

Nickname

declt

Use List
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *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 (:ASSESS by default) to the :NET.DIDIERVERNA.DECLT.ASSESS package.

Package

net.didierverna.declt.assess.

Source

package.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.

Package

net.didierverna.declt.assess.

Methods

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.


6.1.5 Standalone methods

Method: initialize-instance :after ((definition package-definition) &key)

Compute DEFINITION’s package lists of external and internal symbols.

Source

package.lisp.

Method: initialize-instance :after ((definition system-definition) &key)

Extract author and maintainer contacts.

Source

asdf.lisp.

Method: initialize-instance :after ((definition component-definition) &key)

Compute component DEFINITION’s location.

Source

asdf.lisp.

Method: initialize-instance :after ((definition typed-structure-definition) &key packages pathnames)

Compute typed structure DEFINITION’s type, element type, and slots.

Source

symbol.lisp.

Method: initialize-instance :before ((definition system-file-definition) &key system)

Create and store a fake ASDF comoponent representing the system file.

Source

asdf.lisp.

Method: initialize-instance :after ((definition clos-classoid-mixin) &key packages pathnames)

Compute CLOS classoid DEFINITION’s slot definitions.

Source

symbol.lisp.

Method: initialize-instance :after ((definition classoid-definition) &key packages pathnames)

Compute classoid DEFINITION’s foreign status.

Source

symbol.lisp.

Method: make-instance ((class abstract-class) &rest initargs)
Source

util.lisp.

Method: print-object ((report report) stream)

Show REPORT’s library name.

Source

assess.lisp.

Method: print-object ((definition definition) stream)

Show DEFINITION’s name.

Source

definition.lisp.

Method: validate-superclass ((class standard-class) (superclass abstract-class))
Package

sb-mop.

Source

util.lisp.

Method: validate-superclass ((class abstract-class) (superclass standard-class))
Package

sb-mop.

Source

util.lisp.


6.1.6 Classes

Class: abstract-class

The Abstract Class meta-class.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Direct superclasses

standard-class.

Direct methods
Class: accessor-method-definition

Abstract root class for accessor methods.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct subclasses
Class: accessor-mixin

Mixin class for accessor definitions.
An accessor is a funcoid which reads or writes a target slot in a classoid. More specifically, these are ordinary functions for structure slots, and methods for classes or conditions slots.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: target-slot

The target slot definition for this definition’s accessor.

Initargs

:target-slot

Readers

target-slot.

Writers

This slot is read-only.

Class: alias-definition

Abstract root class for alias definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

symbol-definition.

Direct subclasses
Direct methods
Direct slots
Slot: setf

Whether this is a setf alias definition.

Package

common-lisp.

Initargs

:setf

Readers

setfp.

Writers

This slot is read-only.

Slot: referee

The original definition this definition aliases.

Readers

referee.

Writers

(setf referee).

Class: c-file-definition

The class of ASDF C file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

source-file-definition.

Class: cl-source-file.asd

A fake ASDF Lisp file component class for system files.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

cl-source-file.

Direct slots
Slot: type
Package

common-lisp.

Initform

"asd"

Class: class-definition

The class for class definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: object
Readers

definition-class.

Writers

This slot is read-only.

Slot: direct-superclassoids
Readers

direct-superclasses.

Writers

(setf direct-superclasses).

Slot: direct-subclassoids
Readers

direct-subclasses.

Writers

(setf direct-subclasses).

Class: classoid-definition

Abstract root class for classoid definitions. These are conditions, structures, and classes.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

symbol-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Initargs

:classoid

Readers

classoid.

Writers

This slot is read-only.

Slot: direct-slots

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

Readers

direct-slots.

Writers

(setf direct-slots).

Class: clos-classoid-mixin

Mixin for CLOS-based classoids.
These are conditions, ordinary structures, and classes.
All CLOS classoid mixin definitions respond to the following public protocols, which see:
- ‘direct-default-initargs’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: direct-superclassoids

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

Readers

direct-superclassoids.

Writers

(setf direct-superclassoids).

Slot: direct-subclassoids

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

Readers

direct-subclassoids.

Writers

(setf direct-subclassoids).

Slot: direct-methods

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

Readers

direct-methods.

Writers

(setf direct-methods).

Class: clos-slot-definition

The class of CLOS slot definitions.
All CLOS slot definitions respond to the following public protocols, which see:
- ‘allocation’,
- ‘initform’,
- ‘initargs’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

slot-definition.

Direct methods
Class: clos-structure-definition

The class of CLOS structure definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: direct-superclassoids
Readers

direct-superstructures.

Writers

(setf direct-superstructures).

Slot: direct-subclassoids
Readers

direct-substructures.

Writers

(setf direct-substructures).

Class: combination-definition

Root class for method combination definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Initargs

:combination

Readers

combination.

Writers

This slot is read-only.

Slot: clients

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

Readers

clients.

Writers

(setf clients).

Class: compiler-macro-alias-definition

The class of compiler macro alias definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

alias-definition.

Direct methods
Class: compiler-macro-definition

The class of compiler macro definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct methods
Direct slots
Slot: object
Initargs

:compiler-macro

Readers

definition-compiler-macro.

Writers

This slot is read-only.

Class: component-definition

Abstract root class for ASDF components.
All component definitions respond to the following public protocols, which see:
- ‘description’
- ‘long-description’
- ‘definition-version’
- ‘if-feature’.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Readers

component.

Writers

This slot is read-only.

Slot: location

The component’s location (a namestring).

Readers

location.

Writers

(setf location).

Slot: parent

The parent definition for this definition’s component.

Readers

parent.

Writers

(setf parent).

Slot: dependencies

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

Readers

dependencies.

Writers

(setf dependencies).

Class: condition-definition

The class of condition definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: object
Readers

definition-condition.

Writers

This slot is read-only.

Slot: direct-superclassoids
Readers

direct-superconditions.

Writers

(setf direct-superconditions).

Slot: direct-subclassoids
Readers

direct-subconditions.

Writers

(setf direct-subconditions).

Class: constant-definition

The class of constant definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

variable-definition.

Direct methods
Class: definition

Abstract root class for all definitions.
All definitions respond to the following public protocols, which see: - ‘name’,
- ‘docstring’.

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: object

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

Initargs

:object

Readers

object.

Writers

This slot is read-only.

Slot: uid

This definition’s UID.

Readers

uid.

Writers

(setf uid).

Slot: source-file

The source file definition for this definition’s object.

Readers

source-file.

Writers

(setf source-file).

Slot: foreign

Whether this definition is foreign.

Initargs

:foreign

Readers

foreignp.

Writers

(setf foreignp).

Class: doc-file-definition

The class of ASDF doc file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

static-file-definition.

Direct subclasses

html-file-definition.

Class: expander-definition

Abstract root class for setf expander definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Initargs

:expander

Readers

expander.

Writers

This slot is read-only.

Slot: setf
Package

common-lisp.

Initform

t

Slot: standalone-reader

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.

Readers

standalone-reader.

Writers

(setf standalone-reader).

Class: file-definition

The class of ASDF file definitions.
All file definitions respond to the following public protocols, which see: - ‘extension’.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

component-definition.

Direct subclasses

source-file-definition.

Direct methods
Direct slots
Slot: object
Initargs

:file

Readers

file.

Writers

This slot is read-only.

Class: funcoid-definition

Abstract root class for functional definitions.
These are (compiler) macros, (generic) functions, methods, setf expanders, method combinations, and types.
All funcoid definitions respond to the following public protocols, which see: - ‘lambda-list’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

symbol-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Readers

funcoid.

Writers

This slot is read-only.

Slot: setf

Whether this is a setf definition.

Package

common-lisp.

Initargs

:setf

Readers

setfp.

Writers

This slot is read-only.

Class: function-alias-definition

The class of non-setf function alias definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

alias-definition.

Direct methods
Class: function-definition

Abstract root class for functions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

setfable-funcoid-definition.

Direct subclasses
Direct methods

definition-function.

Direct slots
Slot: object
Initargs

:function

Readers

definition-function.

Writers

This slot is read-only.

Class: generic-accessor-definition

Abstract root class for generic accessor functions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

generic-function-definition.

Direct subclasses
Class: generic-function-definition

The class of generic function definitions.
All generic function definitions respond to the following public protocols, which see:
- ‘combination-options’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

function-definition.

Direct subclasses

generic-accessor-definition.

Direct methods
Direct slots
Slot: object
Initargs

:generic

Readers

generic.

Writers

This slot is read-only.

Slot: methods

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

Readers

methods.

Writers

(setf methods).

Slot: combination

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

Readers

combination.

Writers

(setf combination).

Class: generic-reader-definition

The class of generic reader function definitions.
A generic function is considered to be a reader function when all its mehtods are reader methods.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

generic-accessor-definition.

Direct methods
Class: generic-writer-definition

The class of generic writer function definitions.
A generic function is considered to be a writer function when all its mehtods are writer methods.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

generic-accessor-definition.

Direct methods
Class: html-file-definition

The class of ASDF HTML file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

doc-file-definition.

Class: java-file-definition

The class of ASDF Java file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

source-file-definition.

Class: lisp-file-definition

The class of ASDF Lisp file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

source-file-definition.

Direct subclasses

system-file-definition.

Direct methods
Direct slots
Slot: definitions

The list of definitions for this definition’s file.

Readers

definitions.

Writers

(setf definitions).

Class: long-combination-definition

Class for long method combination definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

combination-definition.

Class: long-expander-definition

The class of long form setf expanders definitions.
This class is shared by expanders created with either the long form of DEFSETF, or DEFINE-SETF-EXPANDER.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

expander-definition.

Direct methods
Class: macro-alias-definition

The class of macro alias definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

alias-definition.

Direct methods
Class: macro-definition

The class of macro definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

setfable-funcoid-definition.

Direct methods
Direct slots
Slot: object
Initargs

:macro

Readers

macro.

Writers

This slot is read-only.

Class: method-definition

Abstract root class for method definitions.
All method definitions respond to the following public protocols, which see: - ‘qualifiers’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct subclasses

accessor-method-definition.

Direct methods
Direct slots
Slot: object
Initargs

:method

Readers

definition-method.

Writers

This slot is read-only.

Slot: owner

The generic function definition for this definition’s method.

Readers

owner.

Writers

(setf owner).

Slot: specializers

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

Readers

specializers.

Writers

(setf specializers).

Class: module-definition

The class of ASDF module definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

component-definition.

Direct subclasses

system-definition.

Direct methods
Direct slots
Slot: object
Initargs

:module

Readers

module.

Writers

This slot is read-only.

Slot: children

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

Readers

children.

Writers

(setf children).

Class: ordinary-accessor-definition

Abstract root class for ordinary accessor functions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses
Direct subclasses
Class: ordinary-function-definition

The class of ordinary functions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

function-definition.

Direct subclasses

ordinary-accessor-definition.

Direct methods
Class: ordinary-reader-definition

The class of ordinary reader definitions.
An ordinary reader is an ordinary function that reads a slot in a structure.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

ordinary-accessor-definition.

Direct methods
Class: ordinary-writer-definition

The class of ordinary writer definitions.
An ordinary writer is an ordinary function that writes a slot in a structure.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

ordinary-accessor-definition.

Direct methods
Direct slots
Slot: setf
Package

common-lisp.

Initform

t

Class: package-definition

The class of package definitions.
All package definitions respond to the following public protocols, which see:
- ‘nicknames’.

Package

net.didierverna.declt.assess.

Source

package.lisp.

Direct superclasses

definition.

Direct methods
Direct slots
Slot: object
Initargs

:package

Readers

definition-package.

Writers

This slot is read-only.

Slot: external-symbols

The list of corresponding external symbols.

Readers

external-symbols.

Writers

(setf external-symbols).

Slot: internal-symbols

The list of corresponding internal symbols.

Readers

internal-symbols.

Writers

(setf internal-symbols).

Slot: use-list

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

Readers

use-list.

Writers

(setf use-list).

Slot: used-by-list

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

Readers

used-by-list.

Writers

(setf used-by-list).

Slot: definitions

The list of corresponding definitions.

Readers

definitions.

Writers

(setf definitions).

Class: reader-method-definition

The class of reader method definitions.
A reader method is a method that reads a slot in a class or condition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

accessor-method-definition.

Direct methods

category-name.

Class: report

The Report class.
This is the class holding all extracted documentation information.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Direct methods
Direct slots
Slot: system-name

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

Initargs

:system-name

Readers

system-name.

Writers

This slot is read-only.

Slot: library-name

The library’s name.

Readers

library-name.

Writers

(setf library-name).

Slot: tagline

The reference manual’s tagline.

Readers

tagline.

Writers

(setf tagline).

Slot: library-version

The library’s version.

Readers

library-version.

Writers

(setf library-version).

Slot: contacts

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.

Readers

contacts.

Writers

(setf contacts).

A copyright years string.

Readers

copyright-years.

Writers

(setf copyright-years).

Slot: license

The library’s license.

Readers

license.

Writers

(setf license).

Slot: introduction

Contents for an introduction chapter.

Readers

introduction.

Writers

(setf introduction).

Slot: conclusion

Contents for a conclusion chapter.

Readers

conclusion.

Writers

(setf conclusion).

Slot: definitions

The list of definitions.

Readers

definitions.

Writers

(setf definitions).

Class: setfable-funcoid-definition

Abstract root class for setfable funcoids.
These are (generic) functions and macros. A funcoid is setfable when it may be related to one or more setf expanders. There are two kinds of relation to a setf expander: 1. the funcoid’ signature is the same as that of an expander’s access-fn, and 2. a short form setf expander expands to it (i.e., it has this funcoid as its update-fn).

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: expander-for

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.

Readers

expander-for.

Writers

(setf expander-for).

Slot: expanders-to

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.

Readers

expanders-to.

Writers

(setf expanders-to).

Class: short-combination-definition

The class of short method combination definitions.
All short method combination definitions respond to the following public protocols, which see:
- ‘identity-with-one-argument’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

combination-definition.

Direct methods
Direct slots
Slot: standalone-combinator

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).

Readers

standalone-combinator.

Writers

(setf standalone-combinator).

Class: short-expander-definition

The class of short form setf expanders definitions.
Short form setf expanders simply expand to a globally defined function or macro.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

expander-definition.

Direct methods
Direct slots
Slot: standalone-writer

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).

Readers

standalone-writer.

Writers

(setf standalone-writer).

Class: slot-definition

Abstract root class for slots.
All slot definitions respond to the following public protocols, which see: - ‘value-type’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

varoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Initargs

:slot

Readers

slot.

Writers

This slot is read-only.

Slot: owner

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

Readers

owner.

Writers

(setf owner).

Slot: readers

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

Readers

readers.

Writers

(setf readers).

Slot: writers

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

Readers

writers.

Writers

(setf writers).

Class: source-file-definition

The class of ASDF source file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

file-definition.

Direct subclasses
Class: special-definition

The class of special variable definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

variable-definition.

Direct methods
Class: static-file-definition

The class of ASDF static file definitions.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

source-file-definition.

Direct subclasses

doc-file-definition.

Class: structure-definition

Abstract root class for structures.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

classoid-definition.

Direct subclasses
Direct methods
Direct slots
Slot: object
Readers

definition-structure.

Writers

This slot is read-only.

Class: symbol-definition

Abstract root class for definitions named by symbols.
All symbol definitions respond to the following public protocols, which see: - ‘publicp’.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

definition.

Direct subclasses
Direct methods
Direct slots
Slot: symbol

The symbol naming this definition.

Package

common-lisp.

Initargs

:symbol

Readers

definition-symbol.

Writers

This slot is read-only.

Slot: home-package

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.

Readers

home-package.

Writers

(setf home-package).

Class: symbol-macro-definition

The class of symbol macro definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

varoid-definition.

Direct methods
Class: system-definition

The class of ASDF system definitions.
All system definitions respond to the following public protocols, which see: - ‘long-name’,
- ‘mailto’,
- ‘homepage’,
- ‘source-control’,
- ‘bug-tracker’,
- ‘license-name’.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

module-definition.

Direct methods
Direct slots
Slot: object
Initargs

:system

Readers

system.

Writers

This slot is read-only.

Slot: parent
Slot: maintainers

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

Readers

maintainers.

Writers

(setf maintainers).

Slot: authors

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

Readers

authors.

Writers

(setf authors).

Slot: defsystem-dependencies

The list of defsystem dependency definitions.

Readers

defsystem-dependencies.

Writers

(setf defsystem-dependencies).

Class: system-file-definition

The class of ASDF system file definitions.
This class represents ASDF system files as Lisp files. Because system files are not components, we use an ad-hoc fake component class for them, ‘cl-source-file.asd’, which see.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Direct superclasses

lisp-file-definition.

Direct methods

initialize-instance.

Class: type-definition

The class of type definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

funcoid-definition.

Direct methods
Direct slots
Slot: object
Initargs

:expander

Readers

expander.

Writers

This slot is read-only.

Class: typed-structure-definition

The class of typed structure definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

structure-definition.

Direct methods
Direct slots
Slot: type

The structure type, either LIST or VECTOR.

Package

common-lisp.

Initargs

:type

Readers

structure-type.

Writers

(setf structure-type).

Slot: element-type

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

Initargs

:element-type

Readers

element-type.

Writers

(setf element-type).

Class: typed-structure-slot-definition

The class of typed structure slot definitions.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

slot-definition.

Direct methods
Class: variable-definition

Abstract root class for constant and special variables.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

varoid-definition.

Direct subclasses
Direct methods

docstring.

Class: varoid-definition

Abstract root class for simply valued symbol definitions. These are constants, special variables, and symbol macros.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

symbol-definition.

Direct subclasses
Direct methods
Class: writer-method-definition

The class of writer method definitions.
A writer method is a method that writes a slot in a class or condition.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Direct superclasses

accessor-method-definition.

Direct methods

category-name.


6.1.7 Types

Type: non-empty-string ()
Package

net.didierverna.declt.setup.

Source

util.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: *blanks*

A list of blank characters and their associated revealed representation. Each element in this list is of the form (#BLANK . #REPLACEMENT).

Package

net.didierverna.declt.

Source

doc.lisp.

Special Variable: *categories*

The list of definition categories.
Each category is of the form (TITLE FILTER).
- TITLE (a string) serves as the section title.
- FILTER can be either a definition type (symbol), in which case definitions of that type a retained, or a predicate function of one (definition) argument, which should return T if the definition is to be retained.

Package

net.didierverna.declt.

Source

symbol.lisp.

Special Variable: *configuration*

The Declt configuration settings.
This variable contains a property list of configuration options. Current options are:
- :swank-eval-in-emacs (Boolean)

See Section 4.1 of the user manual for more information.

Package

net.didierverna.declt.setup.

Source

configuration.lisp.

Special Variable: *fragile-characters*

An association list of Texinfo fragile (anchor) characters. Elements are the form (CHAR . ALT) where CHAR is the fragile (anchor) character and ALT is an alternative Unicode character.

Package

net.didierverna.declt.

Source

texi.lisp.

Special Variable: *licenses*
Package

net.didierverna.declt.assess.

Source

license.lisp.

Special Variable: *section-names*

The numbered, unumbered and appendix section names sorted by level.

Package

net.didierverna.declt.

Source

texi.lisp.

Special Variable: *special-characters*

An association list of Texinfo special characters.
Elements are the form (CHAR . COMMAND) where CHAR is the special character and COMMAND is the name of the corresponding Texinfo alphabetic command.

Package

net.didierverna.declt.

Source

texi.lisp.

Special Variable: *stabilized*

Whether the stabilization process is over.
This variable is set to NIL whenever new definitions are created during the process. Stabilization is run over and over again until nothing moves anymore.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.


6.2.2 Macros

Macro: deffn ((category name lambda-list &optional qualifiers) &body body)

Execute BODY as part of a @deffn {CATEGORY} {NAME} [QUALIFIERS] LAMBDA-LIST. CATEGORY, NAME, QUALIFIERS, and LAMBDA-LIST are escaped for Texinfo prior to rendering. LAMBDA-LIST should be provided by ‘safe-lambda-list’ or ‘safe-specializers’, which see. BODY should render on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Macro: defindent (symbol indent)

Wrapper around ‘clindent’ to avoid quoting SYMBOL and INDENT.

Package

net.didierverna.declt.setup.

Source

readtable.lisp.

Macro: deftp ((category name &optional lambda-list) &body body)

Execute BODY as part of a @deftp {CATEGORY} {NAME} [LAMBDA-LIST] environment. CATEGORY, NAME, and LAMBDA-LIST are escaped for Texinfo prior to rendering. LAMBDA-LIST should be provided by ‘safe-lambda-list’, which see.
BODY should render on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Macro: defvr (category name &body body)

Execute BODY as part of a @defvr {CATEGORY} {NAME} environment. CATEGORY and NAME are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Macro: destabilize (definitions expression)

Invalidate the stabilization process by adding a new definition. EXPRESSION should evaluate to a new definition. ENDPUSH that definition to DEFINITIONS (a symbol), mark the stabilization process as dirty, and return that definition.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Macro: item ((&optional title) &body body)

Execute BODY as part of an @item [TITLE]. BODY should render on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Macro: itemize ((&optional kind) &body body)

Execute BODY as part of an @itemize KIND environment. KIND should be a string designator. It defaults to @bullet. BODY should render on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Macro: multitable ((&rest fractions) &body body)

Execute BODY as part of a @multitable @columnFRACTIONS environment. BODY should render on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Macro: render-to-string (&body body)

Execute BODY with *standard-output* redirected to a string. Return that string.

Package

net.didierverna.declt.

Source

texi.lisp.

Macro: table ((&optional kind) &body body)

Execute BODY as part of a @table KIND environment.
KIND should be a string designator. It defaults to @strong. BODY should render on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.


6.2.3 Ordinary functions

Function: %deffn (x category name lambda-list &optional qualifiers)

Render a @deffn[x] {CATEGORY} {NAME} [QUALIFIERS] LAMBDA-LIST line. Rendering is done on *standard-output*. CATEGORY, NAME, QUALIFIERS, and LAMBDA-LIST are escaped for Texinfo prior to rendering. LAMBDA-LIST should be provided by ‘safe-lambda-list’ or ‘safe-specializers’, which see.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: %version (type major minor status level name)
Package

net.didierverna.declt.setup.

Source

version.lisp.

Function: @anchor (anchor)

Render ANCHOR as an @anchor on a standalone line. ANCHOR is escaped for Texinfo prior to rendering. Rendering is done on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @deffn (category name lambda-list &optional qualifiers)

Render a @deffn {CATEGORY} {NAME} [QUALIFIERS] LAMBDA-LIST line. Rendering is done on *standard-output*. CATEGORY, NAME, QUALIFIERS, and LAMBDA-LIST are escaped for Texinfo prior to rendering. LAMBDA-LIST should be provided by ‘safe-lambda-list’ or ‘safe-specializers’, which see.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @deffnx (category name lambda-list &optional qualifiers)

Render a @deffnx {CATEGORY} {NAME} [QUALIFIERS] LAMBDA-LIST line. Rendering is done on *standard-output*. CATEGORY, NAME, QUALIFIERS, and LAMBDA-LIST are escaped for Texinfo prior to rendering. LAMBDA-LIST should be provided by ‘safe-lambda-list’ or ‘safe-specializers’, which see.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @deftp (category name &optional lambda-list)

Render a @deftp {CATEGORY} {NAME} [LAMBDA-LIST] line on *standard-output*. CATEGORY, NAME, and LAMBDA-LIST are escaped for Texinfo prior to rendering. LAMBDA-LIST should be provided by ‘safe-lambda-list’, which see.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @defvr (category name)

Render a @defvr {CATEGORY} {NAME} line on *standard-output*. CATEGORY and NAME are escaped for Texinfo prior to rendering.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @end (environment)

Render and @end ENVIRONMENT line on *standard-output*. ENVIRONMENT should be a string designator.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @item (&optional title)

Render an @item [TITLE] line on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @itemize (&optional kind)

Render an @itemize KIND line on *standard-output*.
KIND should be a string designator. It defaults to @bullet.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @multitable (&rest fractions)

Render a @multitable @columnFRACTIONS line on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @ref (anchor label)

Render ANCHOR as an @ref with online and printed LABEL.
Both ANCHOR and LABEL are escaped for Texinfo prior to rendering. LABEL is rendered in teletype.
Rendering is done on *standard-output*.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: @table (&optional kind)

Render a @table KIND line on *standard-output*.
KIND should be a string designator. It defaults to @strong.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: add-categories-node (parent context status definitions)

Add the STATUS DEFINITIONS categories nodes to PARENT in CONTEXT.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: add-category-node (parent context status category definitions)

Add the STATUS CATEGORY node to PARENT for DEFINITIONS in CONTEXT.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: add-child (parent child)

Add CHILD node to PARENT node and return CHILD.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: add-definitions-node (parent report context)

Add REPORT’s definitions node to PARENT in CONTEXT.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: add-files-node (parent report context)

Add REPORT’s files node to PARENT in CONTEXT.

Package

net.didierverna.declt.

Source

asdf.lisp.

Function: add-modules-node (parent report context)

Add REPORT’s modules node to PARENT in CONTEXT.

Package

net.didierverna.declt.

Source

asdf.lisp.

Function: add-packages-node (parent report context)

Add REPORT’s packages node to PARENT in CONTEXT.

Package

net.didierverna.declt.

Source

package.lisp.

Function: add-systems-node (parent report context)

Add REPORT’s systems node to PARENT in CONTEXT.

Package

net.didierverna.declt.

Source

asdf.lisp.

Function: anchor (definition)

Render DEFINITION’s anchoring command on *STANDARD-OUTPUT*.

Package

net.didierverna.declt.

Source

doc.lisp.

Function: anchor-and-index (definition)

Render DEFINITION’s anchoring and indexing commands on *STANDARD-OUTPUT*.

Package

net.didierverna.declt.

Source

doc.lisp.

Function: anchor-name (definition)

Return DEFINITION’s anchor name, that is, "(<UID>)".

Package

net.didierverna.declt.

Source

doc.lisp.

Function: clindent (symbol indent)

Send SYMBOL’s INDENTation information to Emacs.
Emacs will set the ’common-lisp-indent-function property.
If INDENT is a symbol, use its indentation definition. Otherwise, INDENT is considered as an indentation definition.

Package

net.didierverna.declt.setup.

Source

readtable.lisp.

Function: components (module type)

Return the list of all (sub)TYPE components found in MODULE’s tree.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: copy-node (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Function: current-time-string ()

Return the current time as a string.

Package

net.didierverna.declt.

Source

misc.lisp.

Function: declt-1 (report &rest keys &key locations default-values foreign-definitions declt-notice output-directory file-name info-name info-category)
Package

net.didierverna.declt.

Source

declt.lisp.

Function: definition-source-by-name (definition type)

Return DEFINITION’s source for TYPE.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: domesticp (symbol pathname packages pathnames)

Return T if a definition for SYMBOL originating in PATHNAME is domestic.
A definition is considered domestic under the following conditions:
- its originating PATHNAME is known (non NIL) and one of domestic PATHNAMES, - its originating PATHNAME is unknown, but the SYMBOL’s home package is one of domestic PACKAGES.
Note that a definition for a domestic symbol, but originating in a foreign source file is considered foreign.

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Function: escape (string)

When STRING, escape it for Texinfo.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: escape-anchor (string)

Escape STRING for use as a Texinfo anchor name.
In addition to regular escaping, periods, commas, colons, and parenthesis are replaced with alternative Unicode characters.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: escape-label (string)

Escape STRING for use as a Texinfo anchor label.
In addition to regular escaping, colons are replaced with alternative Unicode characters.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: escape-lambda-list (lambda-list)

Escape safe LAMBDA-LIST for Texinfo.
This function expects a value from ‘safe-lambda-list’, which see. It returns a string properly escaped for Texinfo, apart from &-constructs which retain their original form, and @ref’s and @t’s which are already properly set.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: file-components (module)

Return the list of all file components found in MODULE’s tree.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: file-node (definition context)

Create and return a file DEFINITION node in CONTEXT.

Package

net.didierverna.declt.

Source

asdf.lisp.

Function: finalize (definitions packages pathnames)

Finalize DEFINITIONS in domestic PACKAGES and PATHNAMES. For more information, see ‘stabilize’ and ‘freeze’.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Function: find-definition (object definitions)

Find a definition for OBJECT in DEFINITIONS.

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Function: first-word-length (string)

Return the length of the first word in STRING. Initial whitespace characters are skipped.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: freeze (definitions)

Freeze DEFINITIONS.
Currently, this means:
- computing the definitions UIDs,
- potentially upgrading generic definitions to reader or writer definitions.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Function: funcoid-name (funcoid)

Return FUNCOID’s name, or NIL.
FUNCOID may be a function, a macro function, or a compiler macro function. Lambda expression are not considered as proper names, so NIL is returned.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: i-reader (stream subchar arg)

Construct a call to ‘defindent’ by reading an argument list from STREAM. This dispatch macro character function is installed on #i in the NET.DIDIERVERNA.DECLT named readtable.

Package

net.didierverna.declt.setup.

Source

readtable.lisp.

Function: index (definition)

Render DEFINITION’s indexing command on *STANDARD-OUTPUT*.

Package

net.didierverna.declt.

Source

doc.lisp.

Function: itemize-list (list &key renderer kind format key)

Render a LIST of items as part of an @itemize KIND environment.
KIND should be a string designator. It defaults to @bullet.
If RENDERER is non-nil, it must be a function of one argument (every LIST element) that performs the rendering on *standard-output* directly.

Otherwise, the rendering is done by calling format, as explained below. - FORMAT is the format string to use for every LIST element. It defaults to "~A".
- KEY is a function of one argument (every LIST element) used to provide the necessary arguments to the FORMAT string. If multiple arguments are needed, they should be returned by KEY as multiple values.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: load-system (system-name)

Load ASDF SYSTEM-NAME in a manner suitable to extract documentation. Return the corresponding ASDF system.
SYSTEM-NAME is an ASDF system designator.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: long-title (definition)

Return a long title for DEFINITION.
It is of the form "The <qualified safe name> <type name>".

Package

net.didierverna.declt.

Source

doc.lisp.

Function: make-all-file-definitions (definitions)

Return a list of all file definitions for system DEFINITIONS.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: make-all-module-definitions (definitions)

Return a list of all module definitions for system DEFINITIONS.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: make-all-package-definitions (file-definitions system-definitions)

Return a list of all package definitions for FILE- and SYSTEM-DEFINITIONS. This list contains definitions for packages defined in the corresponding files, or for which the source is not found, but the name is of the form SYSTEM/... (case insensitive) for one of the corresponding systems.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: make-all-symbol-definitions (packages pathnames all-symbols-p)

Return a list of all domestic symbol definitions.
If ALL-SYMBOLS-P, introspect all accessible symbols in the current Lisp environment. Otherwise (the default), limit introspection to the symbols from domestic PACKAGES.
Domesticity is defined in relation to domestic PACKAGES and PATHNAMES; see ‘domesticp’.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: make-all-system-definitions (system)

Return a list of all system definitions for SYSTEM.
The only guarantee is that the definition for SYSTEM comes first. The other considered systems are those found recursively in SYSTEM’s dependencies, and located under SYSTEM’s directory.
See ‘subsystems’ for more information.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: make-classoid-definition (symbol classoid packages pathnames)

Make a new CLASSOID definition for SYMBOL.
Also create all slots definitions. The foreign status of the new classoid and its slots is computed from domestic PACKAGES and PATHNAMES.
The concrete class of the new definition (structure, class, or condition) depends on the kind of CLASSOID.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-clos-slot-definition (slot &optional foreign)

Make a new CLOS SLOT definition, possibly FOREIGN.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-combination-definition (symbol combination &optional foreign)

Make a new method COMBINATION definition for SYMBOL, possibly FOREIGN. The concrete class of the new definition depends on the COMBINATION type.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-compiler-macro-alias-definition (symbol &optional setf)

Make a new compiler macro alias definition for (possibly SETF) SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-compiler-macro-definition (symbol compiler-macro &rest keys &key setf foreign)

Make a new COMPILER-MACRO definition for SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-constant-definition (symbol)

Make a new constant definition for SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-context (&rest keys &key locations default-values foreign-definitions declt-notice)

Make a new rendering context.
The following keys are available.
- LOCATIONS: whether to hyperlink definitions to their locations. Currently supported values are NIL (the default), and :file-system. - DEFAULT-VALUES: whether to render default / standard values. Defaults to NIL.
- FOREIGN-DEFINITIONS: whether to render foreign definitions. Defaults to NIL.
- DECLT-NOTICE: whether to add a small credit paragraph to Declt. Possible values are NIL, :short, or :long (the default).

Package

net.didierverna.declt.

Source

doc.lisp.

Function: make-expander-definition (symbol expander &optional foreign)

Make a new setf EXPANDER definition for SYMBOL, possibly foreign.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-file-definition (file &optional foreign)

Make a new FILE definition.
The concrete class of the new definition depends on the kind of FILE.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: make-function-alias-definition (symbol &optional setf)

make a new function alias definition for (possibly SETF) SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-generic-function-definition (symbol generic &rest keys &key setf foreign)

Make a new GENERIC function definition for (SETF) SYMBOL, possibly FOREIGN.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-macro-alias-definition (symbol)

Make a new macro alias definition for SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-macro-definition (symbol macro &optional foreign)

Make a new MACRO definition for SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-method-definition (method &optional foreign)

Make a new METHOD definition, possibly FOREIGN.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-module-definition (module &optional foreign)

Make a new MODULE definition.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: make-node (&key name synopsis section-type section-name next previous up children before-menu-contents after-menu-contents)
Package

net.didierverna.declt.

Source

texi.lisp.

Function: make-ordinary-function-definition (symbol function &rest keys &key setf foreign)

Make a new ordinary FUNCTION definition for (SETF) SYMBOL, possibly FOREIGN.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-package-definition (package &optional foreign)

Make a new PACKAGE definition, possibly FOREIGN.

Package

net.didierverna.declt.assess.

Source

package.lisp.

Function: make-report (system-name)

Make a new report for SYSTEM-NAME (an ASDF system designator).

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: make-special-definition (symbol)

Make a new special variable definition for SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-symbol-definitions (symbol packages pathnames)

Make and return a list of all existing domestic definitions for SYMBOL. Domesticity is defined in relation to domestic PACKAGES and PATHNAMES; see ‘domesticp’.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: make-symbol-macro-definition (symbol)

Make a new symbol macro definition for SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-system-definition (system &optional foreign)

Make a new SYSTEM definition.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: make-system-file-definition (system)

Make a new system file definition for SYSTEM.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: make-system-file-definitions (systems)

Make a list of system file definitions for SYSTEMS.
Multiple systems may be defined in the same file. There is however only one definition for each file.

Package

net.didierverna.declt.assess.

Source

asdf.lisp.

Function: make-type-definition (symbol expander)

Make a new type definition for SYMBOL.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: make-typed-structure-slot-definition (slot &optional foreign)

Make a new typed structure SLOT definition, possibly FOREIGN.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: merge-expander-p (definition expander)

Return T if function DEFINITION and setf EXPANDER can be documented jointly.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: merge-generic-writer (reader writer)

Check if WRITER generic definition can be documented jointly with READER. If so, return the generalized Boolean value of ‘merge-methods’, which see.

Merging is only attempted on generic functions defined exclusively via slot :accessor keywords. For merging to actually occur, there must not exist any property specific to only one definition, or different between the two (no related expander information, same method combination, same docstring, etc.). The only exception is their lambda lists.

The same conditions apply to methods, which definitions are also merged. Only unqualified methods must exist. Standalone reader and writer methods are still permitted.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: merge-methods (reader writer)

Attempt to merge READER and WRITER generic definitions methods. See ‘merge-generic-writer’ for the exact conditions under which merging may occur. If merging is possible, return a list of three values:
1. a list of the form ((READER-METHOD . WRITER-METHOD) ...) for associated reader and writer methods,
2. a list of standalone readers,
3. a list of standalone writers,
Otherwise, return NIL.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: merge-ordinary-writer (reader writer)

Return WRITER if it can be documented jointly with READER.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: method-name (method)

Return METHOD’s canonical name.
Return a second value of T if METHOD is in fact a SETF one.

Package

net.didierverna.declt.assess.

Source

symbol.lisp.

Function: module-components (module)

Return the list of all module components found in MODULE’s tree.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: new-funcoid-definition (name packages pathnames)

Return a new macro or function definition for NAME, or NIL. PACKAGES and PATHNAMES are used to determine domesticity.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Function: new-generic-definition (generic packages pathnames)

Make a new foreign GENERIC function definition. PACKAGES and PATHNAMES are used to determine domesticity.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Reader: node-after-menu-contents (instance)
Writer: (setf node-after-menu-contents) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

after-menu-contents.

Reader: node-before-menu-contents (instance)
Writer: (setf node-before-menu-contents) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

before-menu-contents.

Reader: node-children (instance)
Writer: (setf node-children) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

children.

Reader: node-name (instance)
Writer: (setf node-name) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

name.

Reader: node-next (instance)
Writer: (setf node-next) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

next.

Function: node-p (object)
Package

net.didierverna.declt.

Source

texi.lisp.

Reader: node-previous (instance)
Writer: (setf node-previous) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

previous.

Reader: node-section-name (instance)
Writer: (setf node-section-name) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

section-name.

Reader: node-section-type (instance)
Writer: (setf node-section-type) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

section-type.

Reader: node-synopsis (instance)
Writer: (setf node-synopsis) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

synopsis.

Reader: node-up (instance)
Writer: (setf node-up) (instance)
Package

net.didierverna.declt.

Source

texi.lisp.

Target Slot

up.

Function: one-liner-p (string)

Return T if STRING is non empty and does not span multiple lines.

Package

net.didierverna.declt.assess.

Source

util.lisp.

Function: package-external-symbols (package)

Return the list of PACKAGE’s external symbols.

Package

net.didierverna.declt.assess.

Source

package.lisp.

Function: package-internal-symbols (package)

Return the lists of PACKAGE’s internal and external symbols as two values.

Package

net.didierverna.declt.assess.

Source

package.lisp.

Function: package-symbols (package)

Return the list of symbols from home PACKAGE.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: parse-contact(s) (contact(s))

Parse CONTACT(S) as either a contact string, or a list of such. Return a list of parsed contacts. See ‘parse-contact-string’ for more information.

Package

net.didierverna.declt.assess.

Source

util.lisp.

Function: parse-contact-string (string)

Parse STRING of the form "My Name <my@address>".
Both name and address are optional. If only an address is provided, the angle brackets may be omitted.
If neither a name nor an address can be extracted, return NIL. Otherwise, return the list ("My Name" . "my@address"). In such a case, either the CAR or the CDR may be null, but not both.

Package

net.didierverna.declt.assess.

Source

util.lisp.

Function: read-next-line (stream)

Read one line from STREAM.
Return a list of two values:
- the line itself, or STREAM,
- whether a newline character is missing at the end of the line.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: reference (definition context &optional short punctuation)

Render a possibly SHORT DEFINITION’s reference in CONTEXT.
Rendering is done on *STANDARD-OUTPUT*.
When DEFINITION is foreign and CONTEXT disables their rendering, the produced reference is just text. Otherwise, an actual link is created.
Unless SHORT, the DEFINITION type is advertised after the reference itself. When SHORT, the reference is followed by a PUNCTUATION character (a dot by default) or NIL.

Package

net.didierverna.declt.

Source

doc.lisp.

Function: release-status-number (release-status)
Package

net.didierverna.declt.setup.

Source

version.lisp.

Function: render-definition-core (definition context)

Render DEFINITION’s documentation core in CONTEXT.
More specifically, render DEFINITION’s package and source file references.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: render-dependencies (dependencies context &optional prefix)

Render COMPONENT’s DEPENDENCIES in CONTEXT, optionally PREFIXing the title.

Package

net.didierverna.declt.

Source

asdf.lisp.

Function: render-dependency (dependency context)

Render a resolved DEPENDENCY specification in CONTEXT. See ‘resolve-dependency-specification’ for more information.

Package

net.didierverna.declt.

Source

asdf.lisp.

Function: render-docstring (item)

Render ITEM’s documentation string. Rendering is done on *standard-output*.

Package

net.didierverna.declt.

Source

doc.lisp.

Function: render-header (report file-name info-name info-category declt-notice current-time-string)

Render the header of the Texinfo file.

Package

net.didierverna.declt.

Source

declt.lisp.

Function: render-headline (definition)

Render a headline for DEFINITION. Also anchor and index it.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: render-node (node level)

Render NODE at LEVEL and all its children at LEVEL+1.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: render-package-reference (definition context &optional force)

Render a reference to DEFINITION’s home package definition in CONTEXT. When FORCE, render a reference to the Common Lisp package, even if CONTEXT says otherwise.
Possibly render an "uninterned" mention instead of an actual reference, when there is no home package to reference.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: render-references (title definitions context &optional short)

Render an enTITLEd list of [SHORT] references to DEFINITIONS in CONTEXT. See ‘reference’ for the meaning of SHORT. The list is rendered in an itemized table item, unless there is only one definition in which case it appears directly as the table item’s contents.
Rendering is done on *standard-output*.

Package

net.didierverna.declt.

Source

doc.lisp.

Function: render-text (text)

Render TEXT for Texinfo.
Rendering is done on *standard-output*.
The rendering takes care of escaping the text for Texinfo, and attempts to embellish the output by detecting potential paragraphs from standalone lines.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: render-top-node (node)

Render the whole nodes hierarchy starting at toplevel NODE.

Package

net.didierverna.declt.

Source

texi.lisp.

Function: reorder-dependency-def (dependency-def)

Reorder information in DEPENDENCY-DEF so that the system is always first. More specifically:
- simple component names are returned as-is,
- :version expressions are returned as (system :version version-specifier), - :feature expressions are returned as (... :feature feature-expression), - :require expressions are returned as (system :require).

Note that because a feature expression is defined recursively, the first element in the reordered list may be another reordered sub-list rather than a simple component name directly. In any case, the system name will always be in the deepest first position.

Package

net.didierverna.declt.assess.

Source

util.lisp.

Function: reordered-dependency-def-system (reordered-dependency-def)

Extract the system name from REORDERED-DEPENDENCY-DEF. See ‘reorder-dependency-def’ for more information.

Package

net.didierverna.declt.assess.

Source

util.lisp.

Function: resolve-dependency-specification (specification component definitions foreign)

Resolve dependency SPECIFICATION for (FOREIGN) COMPONENT in DEFINITIONS. SPECIFICATION must already be reordered (see ‘reorder-dependency-def’ for more information). The specification’s component name is replaced with its corresponding definition. A foreign definition may be created in the process.

If such a definition is neither found, nor created, return NIL. Otherwise, return a list of the updated specification (suitable to MAPCAN).

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Function: reveal (string)

Return a copy of STRING with blanks revealed.
If STRING is empty or null, use the empty set symbol. Otherwise, each blank character is replaced with a visible Unicode representation. See ‘*blanks*’ for more information.

Package

net.didierverna.declt.

Source

doc.lisp.

Function: safe-lambda-list (lambda-list &optional safe-specializers)

Return a safe LAMBDA-LIST, suitable to pass to Texinfo.
The original lambda-list’s structure is preserved, but all symbols are converted to revealed strings, and initform / supplied-p data is removed. &whole, &environment, and &aux parts are removed as they don’t provide any information on the funcoid’s usage. SAFE-SPECIALIZERS is provided for method LAMBDA-LISTs. See ‘safe-specializers’ for more information. Mandatory arguments associated with a non-nil safe specializer are listed together.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: safe-specializers (definition context)

Return a list of safe specializers for method DEFINITION in CONTEXT.
A safe specializer is the printed form of either a reference to a class definition, or an EQL specializer’s type name.

Unless the CONTEXT specifies otherwise, T specializers are replaced by NIL to indicate that they are not to be advertized.

For setf and writer definitions, only the specializers rest is used, as these methods get the new value as their first argument.

Package

net.didierverna.declt.

Source

symbol.lisp.

Function: select-keys (keys &rest selected)

Return a new property list from KEYS with only SELECTED ones.

Package

net.didierverna.declt.

Source

declt.lisp.

Function: source-by-name (name type)

Return source pathname for NAMEd object of TYPE.

Package

net.didierverna.declt.assess.

Source

util.lisp.

Function: source-by-object (object)

Return OBJECT’s source pathname.

Package

net.didierverna.declt.assess.

Source

util.lisp.

Function: stabilize-clos-classoid-slot (definition definitions packages pathnames)

Compute CLOS classoid slot DEFINITION’s reader and writer definitions. This function is used for regular class and condition slots.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Function: stabilize-clos-structure-slot (definition definitions packages pathnames)

Compute CLOS structure slot DEFINITION’s reader and writer definitions.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Function: sub-component-p (component directory)

Return T if COMPONENT can be found under DIRECTORY.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: subsystem (name system directory)

Return NAME’d SYSTEM dependency if found under DIRECTORY, or nil.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: subsystems (system directory)

Return the list of SYSTEM and all its dependencies found under DIRECTORY. All dependencies are descended recursively. Both :defsystem-depends-on and :depends-on are included. Potential duplicates are removed.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: system-dependencies (system)

Return all system names from SYSTEM dependencies. This includes both :defsystem-depends-on and :depends-on.

Package

net.didierverna.declt.assess.

Source

assess.lisp.

Function: validate-email (string)

Check that STRING is of the form nonblank@nonblank, after trimming. Return that string, or issue a warning and return NIL.

Package

net.didierverna.declt.assess.

Source

util.lisp.


6.2.4 Generic functions

Generic Function: category-name (definition)

Return DEFINITION’s category name.

Package

net.didierverna.declt.

Source

doc.lisp.

Methods
Method: category-name ((definition system-definition))

Return "system"

Source

asdf.lisp.

Method: category-name ((definition module-definition))

Return "module"

Source

asdf.lisp.

Method: category-name ((definition file-definition))

Return "file"

Source

asdf.lisp.

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

Return "package".

Source

package.lisp.

Method: category-name ((definition alias-definition))

Return the category name of alias DEFINITION’s referee.

Source

symbol.lisp.

Method: category-name ((definition slot-definition))

Return "slot".

Source

symbol.lisp.

Method: category-name ((definition class-definition))

Return "class".

Source

symbol.lisp.

Method: category-name ((definition condition-definition))

Return "condition".

Source

symbol.lisp.

Method: category-name ((definition structure-definition))

Return "structure".

Source

symbol.lisp.

Method: category-name ((definition writer-method-definition))

Return "writer method".

Source

symbol.lisp.

Method: category-name ((definition reader-method-definition))

Return "reader method".

Source

symbol.lisp.

Method: category-name ((definition method-definition))

Return "method".

Source

symbol.lisp.

Method: category-name ((definition combination-definition))

Return "method combination".

Source

symbol.lisp.

Method: category-name ((definition generic-writer-definition))

Return "generic writer".

Source

symbol.lisp.

Method: category-name ((definition generic-reader-definition))

Return "generic reader".

Source

symbol.lisp.

Method: category-name ((definition generic-function-definition))

Return "generic function".

Source

symbol.lisp.

Method: category-name ((definition ordinary-writer-definition))

Return "writer".

Source

symbol.lisp.

Method: category-name ((definition ordinary-reader-definition))

Return "reader".

Source

symbol.lisp.

Method: category-name ((definition ordinary-function-definition))

Return "function".

Source

symbol.lisp.

Method: category-name ((expander expander-definition))

Return "setf expander".

Source

symbol.lisp.

Method: category-name ((definition type-definition))

Return "type".

Source

symbol.lisp.

Method: category-name ((definition compiler-macro-definition))

Return "compiler macro".

Source

symbol.lisp.

Method: category-name ((definition macro-definition))

Return "macro".

Source

symbol.lisp.

Method: category-name ((definition symbol-macro-definition))

Return "symbol macro".

Source

symbol.lisp.

Method: category-name ((definition special-definition))

Return "special variable".

Source

symbol.lisp.

Method: category-name ((definition constant-definition))

Return "constant".

Source

symbol.lisp.

Generic Reader: declt-notice (object)
Package

net.didierverna.declt.

Methods
Reader Method: declt-notice ((context context))

whether to add a small credit paragraph about Declt. Possible values are NIL, :short, or :long (the default).

Source

doc.lisp.

Target Slot

declt-notice.

Generic Reader: default-values (object)
Package

net.didierverna.declt.

Methods
Reader Method: default-values ((context context))

Whether to render default / standard values.

Source

doc.lisp.

Target Slot

default-values.

Generic Function: document (definition context &key inline writer merged-methods merge-expander &allow-other-keys)

Render DEFINITION’s documentation in CONTEXT.

Package

net.didierverna.declt.

Source

doc.lisp.

Method Combination

document.

Methods
Method: document :open ((definition system-definition) context &key)

Render DEFINITION’s system-specific bits in CONTEXT.

Source

asdf.lisp.

Method: document :close ((definition module-definition) context &key)

Render module DEFINITION’s references in CONTEXT.

Source

asdf.lisp.

Method: document :close ((definition lisp-file-definition) context &key)

Render lisp file DEFINITION’s references in CONTEXT.

Source

asdf.lisp.

Method: document ((definition component-definition) context &key)

Render ASDF component DEFINITION’s documentation in CONTEXT.

Source

asdf.lisp.

Method: document :around ((definition component-definition) context &key)

Anchor, index and document component DEFINITION in CONTEXT. Documentation is done in a @table environment.

Source

asdf.lisp.

Method: document ((definition package-definition) context &key)

Render package DEFINITION’s documentation in context.

Source

package.lisp.

Method: document ((definition alias-definition) context &key)

Render alias DEFINITION’s documentation in CONTEXT.

Source

symbol.lisp.

Method: document ((definition typed-structure-slot-definition) context &key)

Render typed structure slot DEFINITION’s documentation in CONTEXT. More specifically, render DEFINITION’s reader and writer references.

Source

symbol.lisp.

Method: document ((definition clos-slot-definition) context &key)

Render CLOS slot DEFINITION’s documentation in CONTEXT.
More specifically, render DEFINITION’s reader and writer references.

Source

symbol.lisp.

Method: document ((definition slot-definition) context &key)

Render slot DEFINITION’s documentation in context.
More specifically, render DEFINITION’s value type, and for CLOS slots render allocation, initform, and initargs.

Source

symbol.lisp.

Method: document ((definition typed-structure-definition) context &key)

Render typed structure DEFINITION’s type documentation in CONTEXT.

Source

symbol.lisp.

Method: document ((definition clos-classoid-mixin) context &key)

Render CLOS classoid mixin DEFINITION’s documentation in CONTEXT. More specifically, render DEFINITION’s direct superclasses, subclasses, methods, and initargs references.

Source

symbol.lisp.

Method: document :close ((definition classoid-definition) context &key)

Close classoid DEFINITION’s documentation environment in CONTEXT. More specifically:
- close the @table environment,
- close the @deftp environment.

Source

symbol.lisp.

Method: document ((definition classoid-definition) context &key)

Render classoid DEFINITION’s direct slots references in CONTEXT.

Source

symbol.lisp.

Method: document :open ((definition classoid-definition) context &key)

Open classoid DEFINITION’s documentation environment in CONTEXT. More specifically:
- open a @deftp environment,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITIONS’s core documentation.

Source

symbol.lisp.

Method: document :open ((definition method-definition) context &key inline writer)

Open method DEFINITION’s documentation in CONTEXT.
More specifically:
- open a @deffn environment, possibly merging a WRITER method,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITION’s source file.
When INLINE, the method definition is documented within its owner’s documentation. In such a case, the package reference is not rendered (as it is the same as the owner’s), and the source file is only referenced if different from that of the owner’s.

Source

symbol.lisp.

Method: document ((definition short-combination-definition) context &key)

Render short method combination DEFINITION’s documentation in CONTEXT.

Source

symbol.lisp.

Method: document ((definition combination-definition) context &key)

Render method combination DEFINITION’s client references in CONTEXT.

Source

symbol.lisp.

Method: document :around ((definition generic-writer-definition) context &key)

Prevent generic writer DEFINITION from being documented when merging.

Source

symbol.lisp.

Method: document :around ((definition generic-reader-definition) context &rest args &key)

Check for potential writer merging with generic reader DEFINITION.

Source

symbol.lisp.

Method: document :close ((definition generic-function-definition) context &key merged-methods)

Close generic function DEFINITION’s documentation.
More specifically:
- render DEFINITION’s method references, possibly merging readers and writers, - close the @table environment,
- close the @deffn environment.

Source

symbol.lisp.

Method: document ((definition generic-function-definition) context &key)

Render generic function DEFINITION’s combination reference in CONTEXT.

Source

symbol.lisp.

Method: document :around ((definition ordinary-writer-definition) context &key)

Prevent ordinary writer DEFINITION from being documented when merging.

Source

symbol.lisp.

Method: document :around ((definition ordinary-reader-definition) context &rest args &key)

Check for potential writer merging with ordinary reader DEFINITION.

Source

symbol.lisp.

Method: document ((definition short-expander-definition) context &key)

Render short expander DEFINITION’s standalone writer reference in CONTEXT.

Source

symbol.lisp.

Method: document ((definition expander-definition) context &key)

Render setf expander DEFINITION’s standalone reader reference in CONTEXT.

Source

symbol.lisp.

Method: document :around ((definition long-expander-definition) context &key)

Prevent long expander DEFINITION from being documented when merging.

Source

symbol.lisp.

Method: document :close ((definition type-definition) context &key)

Close type DEFINITION’s documentation environment in CONTEXT. More specifically:
- close the @table environment,
- close the @deftp environment.

Source

symbol.lisp.

Method: document :open ((definition type-definition) context &key)

Open type DEFINITION’s documentation environment in CONTEXT. More specifically:
- open a @deftp environment,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITION’s core.

Source

symbol.lisp.

Method: document ((definition accessor-mixin) context &key)

Render accessor mixin DEFINITION’s target slot reference in CONTEXT.

Source

symbol.lisp.

Method: document ((definition setfable-funcoid-definition) context &key merge-expander)

Render setfable funcoid DEFINITION’s expanders information in CONTEXT. More specifically:
- render a reference to a set expander for DEFINITION, unless the definitions are merged,
- render references to all setf expanders expanding to DEFINITION.

Source

symbol.lisp.

Method: document :open ((definition setfable-funcoid-definition) context &key merge-expander writer)

Open setfable funcoid DEFINITION’s documentation environment in CONTEXT. More specifically:
- open a @deffn environment, possibly merging a related setf expander or writer,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITION’s core documentation.

Source

symbol.lisp.

Method: document :around ((definition setfable-funcoid-definition) context &rest args &key)

Check for potential expander merging of setfable funcoid DEFINITION.

Source

symbol.lisp.

Method: document :close ((definition funcoid-definition) context &key)

Close funcoid DEFINITION’s documentation environment in CONTEXT. More specifically:
- close the @table environment,
- close the @deffn environment.

Source

symbol.lisp.

Method: document :open ((definition funcoid-definition) context &key)

Open funcoid DEFINITION’s documentation environment in CONTEXT. More specifically:
- open a @deffn environment,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITION’s core documentation.
This is the default method.

Source

symbol.lisp.

Method: document :close ((definition varoid-definition) context &key)

Close varoid DEFINITION’s documentation environment in CONTEXT. More specifically:
- close the @table environment,
- close the @defvr environment.

Source

symbol.lisp.

Method: document ((definition varoid-definition) context &key)

Render varoid DEFINITION’s documentation in CONTEXT.
More specifically, render DEFINITION’s package and source file references. As a special exception, slots don’t reference their package, unless it differs from the slot’s owner package, and never reference their source file, which is the same as their owner.

Source

symbol.lisp.

Method: document :open ((definition varoid-definition) context &key)

Open varoid DEFINITIONS’s documentation environment in CONTEXT. More specifically:
- open a @defvr environment,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment.

Source

symbol.lisp.

Method: document :around (definition context &key)

Check whether to render foreign DEFINITIONs.

Generic Reader: external-symbols (object)
Generic Writer: (setf external-symbols) (object)
Package

net.didierverna.declt.assess.

Methods
Reader Method: external-symbols ((package-definition package-definition))
Writer Method: (setf external-symbols) ((package-definition package-definition))

The list of corresponding external symbols.

Source

package.lisp.

Target Slot

external-symbols.

Generic Reader: foreign-definitions (object)
Package

net.didierverna.declt.

Methods
Reader Method: foreign-definitions ((context context))

Whether to render foreign definitions.

Source

doc.lisp.

Target Slot

foreign-definitions.

Generic Function: index-command-name (definition)

Return DEFINITION’s index command name.

Package

net.didierverna.declt.

Source

doc.lisp.

Methods
Method: index-command-name ((definition system-definition))

Return "systemindex"

Source

asdf.lisp.

Method: index-command-name ((definition module-definition))

Return "moduleindex"

Source

asdf.lisp.

Method: index-command-name ((definition file-definition))

Return "fileindex"

Source

asdf.lisp.

Method: index-command-name ((definition package-definition))

Return "packageindex".

Source

package.lisp.

Method: index-command-name ((definition alias-definition))

Return the index command name of alias DEFINITION’s referee.

Source

symbol.lisp.

Method: index-command-name ((definition slot-definition))

Return "slotsubindex".

Source

symbol.lisp.

Method: index-command-name ((definition class-definition))

Return "classsubindex".

Source

symbol.lisp.

Method: index-command-name ((definition condition-definition))

Return "conditionsubindex".

Source

symbol.lisp.

Method: index-command-name ((definition structure-definition))

Return "structuresubindex".

Source

symbol.lisp.

Method: index-command-name ((definition method-definition))

Return "methodsubindex".

Source

symbol.lisp.

Method: index-command-name ((definition combination-definition))

Return "combinationsubindex".

Source

symbol.lisp.

Method: index-command-name ((definition generic-function-definition))

Return "genericsubindex".

Source

symbol.lisp.

Method: index-command-name ((definition ordinary-function-definition))

Return "functionsubindex".

Source

symbol.lisp.

Method: index-command-name ((expander expander-definition))

Return "expandersubindex".

Source

symbol.lisp.

Method: index-command-name ((definition type-definition))

Return "typesubindex".

Source

symbol.lisp.

Method: index-command-name ((definition compiler-macro-definition))

Return "compilermacrosubindex".

Source

symbol.lisp.

Method: index-command-name ((definition macro-definition))

Return "macrosubindex".

Source

symbol.lisp.

Method: index-command-name ((definition symbol-macro-definition))

Return "symbolmacrosubindex".

Source

symbol.lisp.

Method: index-command-name ((definition special-definition))

Return "specialsubindex".

Source

symbol.lisp.

Method: index-command-name ((definition constant-definition))

Return "constantsubindex".

Source

symbol.lisp.

Generic Reader: internal-symbols (object)
Generic Writer: (setf internal-symbols) (object)
Package

net.didierverna.declt.assess.

Methods
Reader Method: internal-symbols ((package-definition package-definition))
Writer Method: (setf internal-symbols) ((package-definition package-definition))

The list of corresponding internal symbols.

Source

package.lisp.

Target Slot

internal-symbols.

Generic Reader: locations (object)
Package

net.didierverna.declt.

Methods
Reader Method: locations ((context context))

Whether to hyperlink definitions to their locations.
Currently supported values are NIL (the default), and :file-system.

Source

doc.lisp.

Target Slot

locations.

Generic Function: safe-name (definition &optional qualified)

Return DEFINITION’s safe name, possibly QUALIFIED.
Safe names have blank characters replaced with visible Unicode symbols. See ‘reveal’ for more information.

Package

net.didierverna.declt.

Source

doc.lisp.

Methods
Method: safe-name :around ((definition file-definition) &optional qualify)

Append DEFINITION’s file extension at the end, when applicable.

Source

asdf.lisp.

Method: safe-name ((definition component-definition) &optional qualified)

Reveal component DEFINITION’s name, possibly QUALIFIED.
A QUALIFIED component’s name is of the form "path/to/component", each element being the name of a component’s parent.

Source

asdf.lisp.

Method: safe-name :around ((definition slot-definition) &optional qualified)

When QUALIFIED, prepend slot DEFINITION’s classoid safe name.

Source

symbol.lisp.

Method: safe-name :around ((definition method-definition) &optional qualified)

When QUALIFIED, append method DEFINITION’s qualifiers and specializers.

Source

symbol.lisp.

Method: safe-name ((definition symbol-definition) &optional qualified)

Reveal symbol DEFINITION’s name, possibly QUALIFIED.
A QUALIFIED name is of the form "package:[:]symbol", maybe in a setf list. Uninterned symbols are denoted by the ∅ package.

Source

symbol.lisp.

Method: safe-name ((definition definition) &optional qualified)

Reveal unqualifiable DEFINITION’s name. This is the default method.

Generic Function: source-pathname (definition)

Return DEFINITION’s source pathname.

Package

net.didierverna.declt.assess.

Source

definition.lisp.

Methods
Method: source-pathname ((definition component-definition))

Return component DEFINITION’s source pathname.
This actually is the corresponding system’s source file.

Source

asdf.lisp.

Method: source-pathname ((definition alias-definition))

Return NIL.
Aliases are defined dynamically so it’s impossible to locate the code being executed.

Source

symbol.lisp.

Method: source-pathname ((definition slot-definition))

Return slot DEFINITION’s owner source pathname.

Source

symbol.lisp.

Method: source-pathname ((definition combination-definition))

Return method combination DEFINITION’s source pathname.

Source

symbol.lisp.

Method: source-pathname ((definition expander-definition))

Return setf expander DEFINITION’s source pathname.

Source

symbol.lisp.

Method: source-pathname ((definition type-definition))

Return type DEFINITION’s source pathname.

Source

symbol.lisp.

Method: source-pathname ((definition symbol-macro-definition))

Return symbol macro DEFINITION’s source pathname.

Source

symbol.lisp.

Method: source-pathname ((definition special-definition))

Return special DEFINITION’s source pathname.

Source

symbol.lisp.

Method: source-pathname ((definition constant-definition))

Return constant DEFINITION’s source pathname.

Source

symbol.lisp.

Method: source-pathname (definition)

Return DEFINITION’s object source pathname (this is the default method).

Generic Function: stabilize (definition definitions packages pathnames)

Stabilize DEFINITION in DEFINITIONS and domestic PACKAGES and PATHNAMES.

Package

net.didierverna.declt.assess.

Source

finalize.lisp.

Method Combination

progn.

Options

:most-specific-first

Methods
Method: stabilize progn ((definition system-definition) definitions packages pathnames)

Compute system DEFINITION’s defsystem dependency definitions. Those definitions are guaranteed to be in the original system’s order.

Method: stabilize progn ((definition module-definition) definitions packages pathnames)

Compute module DEFINITION’s child definitions.
Those definitions are guaranteed to be in the module’s original order.

Method: stabilize progn ((definition lisp-file-definition) definitions packages pathnames)

Compute Lisp file DEFINITION’s definitions list.

Method: stabilize progn ((definition component-definition) definitions packages pathnames)

Compute component DEFINITION’s parent and dependency definitions. Those definitions are guaranteed to be in the original component’s order.

Method: stabilize progn ((definition package-definition) definitions packages pathnames)

Compute package DEFINITION’s use, used-by, and definitions lists. New foreign package definitions may be created and added at the end of DEFINITIONS in the process.

Method: stabilize progn ((definition function-alias-definition) definitions packages pathnames)

Compute simple function alias DEFINITION’s referee.

Method: stabilize progn ((definition compiler-macro-alias-definition) definitions packages pathnames)

Compute compiler macro alias DEFINITION’s referee.

Method: stabilize progn ((definition macro-alias-definition) definitions packages pathnames)

Compute macro alias DEFINITION’s referee.

Method: stabilize progn ((definition typed-structure-slot-definition) definitions packages pathnames)

Compute typed structure slot DEFINITION’s reader and writer definitions.

Method: stabilize progn ((definition clos-slot-definition) definitions packages pathnames)

Compute CLOS slot DEFINITION’s reader and writer definitions.

Method: stabilize progn ((definition clos-classoid-mixin) definitions packages pathnames)

Compute classoid DEFINITION’s super/sub classoids, and method definitions.

Method: stabilize progn ((definition method-definition) definitions packages pathnames)

Compute method DEFINITION’s owner, and specializer references.

Method: stabilize progn ((definition short-combination-definition) definitions packages pathnames)

Compute short combination DEFINITION’s standalone combinator definition.

Method: stabilize progn ((definition combination-definition) definitions packages pathnames)

Compute method combination DEFINITION’s users.

Method: stabilize progn ((definition generic-function-definition) definitions packages pathnames)

Compute generic function DEFINITION’s methods, and combination definition.

Method: stabilize progn ((definition short-expander-definition) definitions packages pathnames)

Compute short setf expander DEFINITION’s standalone writer definition.

Method: stabilize progn ((definition expander-definition) definitions packages pathnames)

Compute setf expander DEFINTIION’s standalone reader definition.

Method: stabilize progn ((definition setfable-funcoid-definition) definitions packages pathnames)

Compute DEFINITION’s expander-for and expanders-to references.

Method: stabilize progn ((definition symbol-definition) definitions packages pathnames)

Compute symbol DEFINITION’s home package definition.
New foreign package definitions may be created and added at the end of DEFINITIONS in the process.

Method: stabilize progn ((definition definition) definitions packages pathnames)

Compute DEFINITION’s source file definition.


6.2.5 Method combinations

Method Combination: document ()

The documentation protocol’s method combination.
This method combination provides the following four method groups:
- around methods (optional, :around qualifier),
- opening methods (optional, :open qualifier),
- body methods (no qualifier),
- closing methods (optional, :close qualifier).

Around methods behave like those of the standard method combination, except that they are ordered most specific last. They can be used to conditionalize the actual rendering of documentation, for example in order to filter out definitions that are merged with others.

The main methods block behaves as follows.
- The most specific opening method, if any, is executed.
- All body methods (if any) are executed sequentially in most specific last order.
- Finally, the most specific closing method, if any, is executed.

No method group requires the existence of an applicable method, but for each generic call, there must of course be at least one applicable method, regardless of the group.

Package

net.didierverna.declt.

Source

doc.lisp.

Client Functions

6.2.6 Structures

Structure: node

The NODE structure.
This structure holds Texinfo nodes.

Package

net.didierverna.declt.

Source

texi.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: name
Package

net.didierverna.declt.assess.

Readers

node-name.

Writers

(setf node-name).

Slot: synopsis
Readers

node-synopsis.

Writers

(setf node-synopsis).

Slot: section-type
Initform

:numbered

Readers

node-section-type.

Writers

(setf node-section-type).

Slot: section-name
Readers

node-section-name.

Writers

(setf node-section-name).

Slot: next
Readers

node-next.

Writers

(setf node-next).

Slot: previous
Readers

node-previous.

Writers

(setf node-previous).

Slot: up
Readers

node-up.

Writers

(setf node-up).

Slot: children
Package

net.didierverna.declt.assess.

Readers

node-children.

Writers

(setf node-children).

Slot: before-menu-contents
Readers

node-before-menu-contents.

Writers

(setf node-before-menu-contents).

Slot: after-menu-contents
Readers

node-after-menu-contents.

Writers

(setf node-after-menu-contents).


6.2.7 Classes

Class: context

The class of rendering contexts.

Package

net.didierverna.declt.

Source

doc.lisp.

Direct methods
Direct slots
Slot: locations

Whether to hyperlink definitions to their locations.
Currently supported values are NIL (the default), and :file-system.

Initargs

:locations

Readers

locations.

Writers

This slot is read-only.

Slot: default-values

Whether to render default / standard values.

Initargs

:default-values

Readers

default-values.

Writers

This slot is read-only.

Slot: foreign-definitions

Whether to render foreign definitions.

Initargs

:foreign-definitions

Readers

foreign-definitions.

Writers

This slot is read-only.

Slot: declt-notice

whether to add a small credit paragraph about Declt. Possible values are NIL, :short, or :long (the default).

Initform

:long

Initargs

:declt-notice

Readers

declt-notice.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

%
%deffn: Private ordinary functions
%version: Private ordinary functions

(
(setf authors): Public generic functions
(setf authors): Public generic functions
(setf children): Public generic functions
(setf children): Public generic functions
(setf clients): Public generic functions
(setf clients): Public generic functions
(setf combination): Public generic functions
(setf combination): Public generic functions
(setf conclusion): Public generic functions
(setf conclusion): Public generic functions
(setf contacts): Public generic functions
(setf contacts): Public generic functions
(setf copyright-years): Public generic functions
(setf copyright-years): Public generic functions
(setf definitions): Public generic functions
(setf definitions): Public generic functions
(setf definitions): Public generic functions
(setf definitions): Public generic functions
(setf defsystem-dependencies): Public generic functions
(setf defsystem-dependencies): Public generic functions
(setf dependencies): Public generic functions
(setf dependencies): Public generic functions
(setf direct-methods): Public generic functions
(setf direct-methods): Public generic functions
(setf direct-slots): Public generic functions
(setf direct-slots): Public generic functions
(setf direct-subclasses): Public generic functions
(setf direct-subclasses): Public generic functions
(setf direct-subclassoids): Public generic functions
(setf direct-subclassoids): Public generic functions
(setf direct-subconditions): Public generic functions
(setf direct-subconditions): Public generic functions
(setf direct-substructures): Public generic functions
(setf direct-substructures): Public generic functions
(setf direct-superclasses): Public generic functions
(setf direct-superclasses): Public generic functions
(setf direct-superclassoids): Public generic functions
(setf direct-superclassoids): Public generic functions
(setf direct-superconditions): Public generic functions
(setf direct-superconditions): Public generic functions
(setf direct-superstructures): Public generic functions
(setf direct-superstructures): Public generic functions
(setf element-type): Public generic functions
(setf element-type): Public generic functions
(setf expander-for): Public generic functions
(setf expander-for): Public generic functions
(setf expanders-to): Public generic functions
(setf expanders-to): Public generic functions
(setf external-symbols): Private generic functions
(setf external-symbols): Private generic functions
(setf foreignp): Public generic functions
(setf foreignp): Public generic functions
(setf home-package): Public generic functions
(setf home-package): Public generic functions
(setf internal-symbols): Private generic functions
(setf internal-symbols): Private generic functions
(setf introduction): Public generic functions
(setf introduction): Public generic functions
(setf library-name): Public generic functions
(setf library-name): Public generic functions
(setf library-version): Public generic functions
(setf library-version): Public generic functions
(setf license): Public generic functions
(setf license): Public generic functions
(setf location): Public generic functions
(setf location): Public generic functions
(setf maintainers): Public generic functions
(setf maintainers): Public generic functions
(setf methods): Public generic functions
(setf methods): Public generic functions
(setf node-after-menu-contents): Private ordinary functions
(setf node-before-menu-contents): Private ordinary functions
(setf node-children): Private ordinary functions
(setf node-name): Private ordinary functions
(setf node-next): Private ordinary functions
(setf node-previous): Private ordinary functions
(setf node-section-name): Private ordinary functions
(setf node-section-type): Private ordinary functions
(setf node-synopsis): Private ordinary functions
(setf node-up): Private ordinary functions
(setf owner): Public generic functions
(setf owner): Public generic functions
(setf owner): Public generic functions
(setf parent): Public generic functions
(setf parent): Public generic functions
(setf readers): Public generic functions
(setf readers): Public generic functions
(setf referee): Public generic functions
(setf referee): Public generic functions
(setf source-file): Public generic functions
(setf source-file): Public generic functions
(setf specializers): Public generic functions
(setf specializers): Public generic functions
(setf standalone-combinator): Public generic functions
(setf standalone-combinator): Public generic functions
(setf standalone-reader): Public generic functions
(setf standalone-reader): Public generic functions
(setf standalone-writer): Public generic functions
(setf standalone-writer): Public generic functions
(setf structure-type): Public generic functions
(setf structure-type): Public generic functions
(setf tagline): Public generic functions
(setf tagline): Public generic functions
(setf uid): Public generic functions
(setf uid): Public generic functions
(setf use-list): Public generic functions
(setf use-list): Public generic functions
(setf used-by-list): Public generic functions
(setf used-by-list): Public generic functions
(setf writers): Public generic functions
(setf writers): Public generic functions

@
@anchor: Private ordinary functions
@deffn: Private ordinary functions
@deffnx: Private ordinary functions
@deftp: Private ordinary functions
@defvr: Private ordinary functions
@end: Private ordinary functions
@item: Private ordinary functions
@itemize: Private ordinary functions
@multitable: Private ordinary functions
@ref: Private ordinary functions
@table: Private ordinary functions

A
add-categories-node: Private ordinary functions
add-category-node: Private ordinary functions
add-child: Private ordinary functions
add-definitions-node: Private ordinary functions
add-files-node: Private ordinary functions
add-modules-node: Private ordinary functions
add-packages-node: Private ordinary functions
add-systems-node: Private ordinary functions
allocation: Public ordinary functions
anchor: Private ordinary functions
anchor-and-index: Private ordinary functions
anchor-name: Private ordinary functions
assess: Public ordinary functions
authors: Public generic functions
authors: Public generic functions

B
bug-tracker: Public ordinary functions

C
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
category-name: Private generic functions
children: Public generic functions
children: Public generic functions
classoid: Public generic functions
classoid: Public generic functions
clients: Public generic functions
clients: Public generic functions
clindent: Private ordinary functions
combination: Public generic functions
combination: Public generic functions
combination: Public generic functions
combination-options: Public ordinary functions
component: Public generic functions
component: Public generic functions
component-definition-p: Public ordinary functions
components: Private ordinary functions
conclusion: Public generic functions
conclusion: Public generic functions
configuration: Public ordinary functions
configure: Public ordinary functions
contacts: Public generic functions
contacts: Public generic functions
copy-node: Private ordinary functions
copyright-years: Public generic functions
copyright-years: Public generic functions
current-time-string: Private ordinary functions

D
declare-valid-superclass: Public macros
declt: Public ordinary functions
declt-1: Private ordinary functions
declt-notice: Private generic functions
declt-notice: Private generic functions
defabstract: Public macros
default-values: Private generic functions
default-values: Private generic functions
deffn: Private macros
defindent: Private macros
definition-class: Public generic functions
definition-class: Public generic functions
definition-compiler-macro: Public generic functions
definition-compiler-macro: Public generic functions
definition-condition: Public generic functions
definition-condition: Public generic functions
definition-function: Public generic functions
definition-function: Public generic functions
definition-method: Public generic functions
definition-method: Public generic functions
definition-package: Public generic functions
definition-package: Public generic functions
definition-source-by-name: Private ordinary functions
definition-structure: Public generic functions
definition-structure: Public generic functions
definition-symbol: Public generic functions
definition-symbol: Public generic functions
definition-version: Public ordinary functions
definitions: Public generic functions
definitions: Public generic functions
definitions: Public generic functions
definitions: Public generic functions
defsystem-dependencies: Public generic functions
defsystem-dependencies: Public generic functions
deftp: Private macros
defvr: Private macros
dependencies: Public generic functions
dependencies: Public generic functions
description: Public ordinary functions
destabilize: Private macros
direct-default-initargs: Public ordinary functions
direct-methods: Public generic functions
direct-methods: Public generic functions
direct-slots: Public generic functions
direct-slots: Public generic functions
direct-subclasses: Public generic functions
direct-subclasses: Public generic functions
direct-subclassoids: Public generic functions
direct-subclassoids: Public generic functions
direct-subconditions: Public generic functions
direct-subconditions: Public generic functions
direct-substructures: Public generic functions
direct-substructures: Public generic functions
direct-superclasses: Public generic functions
direct-superclasses: Public generic functions
direct-superclassoids: Public generic functions
direct-superclassoids: Public generic functions
direct-superconditions: Public generic functions
direct-superconditions: Public generic functions
direct-superstructures: Public generic functions
direct-superstructures: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private generic functions
document: Private method combinations
domesticp: Private ordinary functions

E
element-type: Public generic functions
element-type: Public generic functions
endpush: Public macros
escape: Private ordinary functions
escape-anchor: Private ordinary functions
escape-label: Private ordinary functions
escape-lambda-list: Private ordinary functions
expander: Public generic functions
expander: Public generic functions
expander: Public generic functions
expander-for: Public generic functions
expander-for: Public generic functions
expanders-to: Public generic functions
expanders-to: Public generic functions
extension: Public ordinary functions
external-symbols: Private generic functions
external-symbols: Private generic functions

F
file: Public generic functions
file: Public generic functions
file-components: Private ordinary functions
file-definition-p: Public ordinary functions
file-node: Private ordinary functions
finalize: Private ordinary functions
find*: Public ordinary functions
find-definition: Private ordinary functions
first-word-length: Private ordinary functions
foreign-definitions: Private generic functions
foreign-definitions: Private generic functions
foreignp: Public generic functions
foreignp: Public generic functions
freeze: Private ordinary functions
funcoid: Public generic functions
funcoid: Public generic functions
funcoid-name: Private ordinary functions
Function, %deffn: Private ordinary functions
Function, %version: Private ordinary functions
Function, (setf node-after-menu-contents): Private ordinary functions
Function, (setf node-before-menu-contents): Private ordinary functions
Function, (setf node-children): Private ordinary functions
Function, (setf node-name): Private ordinary functions
Function, (setf node-next): Private ordinary functions
Function, (setf node-previous): Private ordinary functions
Function, (setf node-section-name): Private ordinary functions
Function, (setf node-section-type): Private ordinary functions
Function, (setf node-synopsis): Private ordinary functions
Function, (setf node-up): Private ordinary functions
Function, @anchor: Private ordinary functions
Function, @deffn: Private ordinary functions
Function, @deffnx: Private ordinary functions
Function, @deftp: Private ordinary functions
Function, @defvr: Private ordinary functions
Function, @end: Private ordinary functions
Function, @item: Private ordinary functions
Function, @itemize: Private ordinary functions
Function, @multitable: Private ordinary functions
Function, @ref: Private ordinary functions
Function, @table: Private ordinary functions
Function, add-categories-node: Private ordinary functions
Function, add-category-node: Private ordinary functions
Function, add-child: Private ordinary functions
Function, add-definitions-node: Private ordinary functions
Function, add-files-node: Private ordinary functions
Function, add-modules-node: Private ordinary functions
Function, add-packages-node: Private ordinary functions
Function, add-systems-node: Private ordinary functions
Function, allocation: Public ordinary functions
Function, anchor: Private ordinary functions
Function, anchor-and-index: Private ordinary functions
Function, anchor-name: Private ordinary functions
Function, assess: Public ordinary functions
Function, bug-tracker: Public ordinary functions
Function, clindent: Private ordinary functions
Function, combination-options: Public ordinary functions
Function, component-definition-p: Public ordinary functions
Function, components: Private ordinary functions
Function, configuration: Public ordinary functions
Function, configure: Public ordinary functions
Function, copy-node: Private ordinary functions
Function, current-time-string: Private ordinary functions
Function, declt: Public ordinary functions
Function, declt-1: Private ordinary functions
Function, definition-source-by-name: Private ordinary functions
Function, definition-version: Public ordinary functions
Function, description: Public ordinary functions
Function, direct-default-initargs: Public ordinary functions
Function, domesticp: Private ordinary functions
Function, escape: Private ordinary functions
Function, escape-anchor: Private ordinary functions
Function, escape-label: Private ordinary functions
Function, escape-lambda-list: Private ordinary functions
Function, extension: Public ordinary functions
Function, file-components: Private ordinary functions
Function, file-definition-p: Public ordinary functions
Function, file-node: Private ordinary functions
Function, finalize: Private ordinary functions
Function, find*: Public ordinary functions
Function, find-definition: Private ordinary functions
Function, first-word-length: Private ordinary functions
Function, freeze: Private ordinary functions
Function, funcoid-name: Private ordinary functions
Function, homepage: Public ordinary functions
Function, i-reader: Private ordinary functions
Function, identity-with-one-argument: Public ordinary functions
Function, if-feature: Public ordinary functions
Function, index: Private ordinary functions
Function, initargs: Public ordinary functions
Function, initform: Public ordinary functions
Function, itemize-list: Private ordinary functions
Function, license-name: Public ordinary functions
Function, lisp-file-definition-p: Public ordinary functions
Function, load-system: Private ordinary functions
Function, long-description: Public ordinary functions
Function, long-name: Public ordinary functions
Function, long-title: Private ordinary functions
Function, mailto: Public ordinary functions
Function, make-all-file-definitions: Private ordinary functions
Function, make-all-module-definitions: Private ordinary functions
Function, make-all-package-definitions: Private ordinary functions
Function, make-all-symbol-definitions: Private ordinary functions
Function, make-all-system-definitions: Private ordinary functions
Function, make-classoid-definition: Private ordinary functions
Function, make-clos-slot-definition: Private ordinary functions
Function, make-combination-definition: Private ordinary functions
Function, make-compiler-macro-alias-definition: Private ordinary functions
Function, make-compiler-macro-definition: Private ordinary functions
Function, make-constant-definition: Private ordinary functions
Function, make-context: Private ordinary functions
Function, make-expander-definition: Private ordinary functions
Function, make-file-definition: Private ordinary functions
Function, make-function-alias-definition: Private ordinary functions
Function, make-generic-function-definition: Private ordinary functions
Function, make-macro-alias-definition: Private ordinary functions
Function, make-macro-definition: Private ordinary functions
Function, make-method-definition: Private ordinary functions
Function, make-module-definition: Private ordinary functions
Function, make-node: Private ordinary functions
Function, make-ordinary-function-definition: Private ordinary functions
Function, make-package-definition: Private ordinary functions
Function, make-report: Private ordinary functions
Function, make-special-definition: Private ordinary functions
Function, make-symbol-definitions: Private ordinary functions
Function, make-symbol-macro-definition: Private ordinary functions
Function, make-system-definition: Private ordinary functions
Function, make-system-file-definition: Private ordinary functions
Function, make-system-file-definitions: Private ordinary functions
Function, make-type-definition: Private ordinary functions
Function, make-typed-structure-slot-definition: Private ordinary functions
Function, mapcat: Public ordinary functions
Function, merge-expander-p: Private ordinary functions
Function, merge-generic-writer: Private ordinary functions
Function, merge-methods: Private ordinary functions
Function, merge-ordinary-writer: Private ordinary functions
Function, method-definition-p: Public ordinary functions
Function, method-name: Private ordinary functions
Function, module-components: Private ordinary functions
Function, module-definition-p: Public ordinary functions
Function, new-funcoid-definition: Private ordinary functions
Function, new-generic-definition: Private ordinary functions
Function, nickname-package: Public ordinary functions
Function, nickname-package: Public ordinary functions
Function, nicknames: Public ordinary functions
Function, node-after-menu-contents: Private ordinary functions
Function, node-before-menu-contents: Private ordinary functions
Function, node-children: Private ordinary functions
Function, node-name: Private ordinary functions
Function, node-next: Private ordinary functions
Function, node-p: Private ordinary functions
Function, node-previous: Private ordinary functions
Function, node-section-name: Private ordinary functions
Function, node-section-type: Private ordinary functions
Function, node-synopsis: Private ordinary functions
Function, node-up: Private ordinary functions
Function, non-empty-string-p: Public ordinary functions
Function, one-liner-p: Private ordinary functions
Function, package-definition-p: Public ordinary functions
Function, package-external-symbols: Private ordinary functions
Function, package-internal-symbols: Private ordinary functions
Function, package-symbols: Private ordinary functions
Function, parse-contact(s): Private ordinary functions
Function, parse-contact-string: Private ordinary functions
Function, publicp: Public ordinary functions
Function, qualifiers: Public ordinary functions
Function, read-next-line: Private ordinary functions
Function, reader-method-definition-p: Public ordinary functions
Function, reference: Private ordinary functions
Function, release-status-number: Private ordinary functions
Function, render-definition-core: Private ordinary functions
Function, render-dependencies: Private ordinary functions
Function, render-dependency: Private ordinary functions
Function, render-docstring: Private ordinary functions
Function, render-header: Private ordinary functions
Function, render-headline: Private ordinary functions
Function, render-node: Private ordinary functions
Function, render-package-reference: Private ordinary functions
Function, render-references: Private ordinary functions
Function, render-text: Private ordinary functions
Function, render-top-node: Private ordinary functions
Function, reorder-dependency-def: Private ordinary functions
Function, reordered-dependency-def-system: