3.1.1 bytecurry.asdf-ext/bytecurry.asdf-ext.asd

Source

bytecurry.asdf-ext.asd.

Parent Component

bytecurry.asdf-ext (system).

ASDF Systems

• bytecurry.asdf-ext.
• bytecurry.asdf-ext/interface.
• bytecurry.asdf-ext/doc-op.
• bytecurry.asdf-ext/atdoc.

3.1.2 bytecurry.asdf-ext/interface/file-type.lisp

Source

bytecurry.asdf-ext.asd.

Parent Component

bytecurry.asdf-ext/interface (system).

Packages

bytecurry.asdf-ext/interface.

3.1.3 bytecurry.asdf-ext/doc-op/file-type.lisp

Source

bytecurry.asdf-ext.asd.

Parent Component

bytecurry.asdf-ext/doc-op (system).

Packages

bytecurry.asdf-ext/doc-op.

Public Interface

• doc-op (class).
• document-system (function).
• perform (method).

3.1.4 bytecurry.asdf-ext/atdoc/file-type.lisp

Source

bytecurry.asdf-ext.asd.

Parent Component

bytecurry.asdf-ext/atdoc (system).

Packages

bytecurry.asdf-ext/atdoc.

Public Interface

• atdoc-docs (class).
• atdoc-html (class).
• component-depends-on (method).
• initialize-instance (method).
• input-files (method).
• output-files (method).
• perform (method).
• perform (method).
• perform (method).
• source-file-type (method).

Internals

• atdoc-docs-title (function).
• atdoc-packages (reader method).
• (setf atdoc-packages) (writer method).

5.1.1 Ordinary functions

Function: document-system (system &rest args &key force force-not verbose version &allow-other-keys) ¶

Shorthand for ‘(asdf:operate ’asdf:doc-op system)’ see OPERATE for details.

Package

bytecurry.asdf-ext/doc-op.

Source

file-type.lisp.

5.1.2 Standalone methods

Method: component-depends-on ((op doc-op) (c atdoc-docs)) ¶

Package

asdf/action.

Source

file-type.lisp.

Method: initialize-instance :after ((instance atdoc-html) &rest initargs) ¶

Source

file-type.lisp.

Method: input-files ((op doc-op) (c atdoc-html)) ¶

Package

asdf/action.

Source

file-type.lisp.

Method: output-files ((op doc-op) (c atdoc-html)) ¶

Package

asdf/action.

Source

file-type.lisp.

Method: perform ((op doc-op) (c atdoc-html)) ¶

Package

asdf/action.

Source

file-type.lisp.

Method: perform ((o doc-op) (c component)) ¶

Package

asdf/action.

Source

file-type.lisp.

Method: perform ((op load-op) (c atdoc-docs)) ¶

Package

asdf/action.

Source

file-type.lisp.

Method: perform ((op compile-op) (c atdoc-docs)) ¶

Package

asdf/action.

Source

file-type.lisp.

Method: source-file-type ((comp atdoc-docs) sys) ¶

The pathname of the docs should be the directory to store the documentation in.

Package

asdf/component.

Source

file-type.lisp.

5.1.3 Classes

Class: atdoc-docs ¶

Operation to create atdoc documentation for a system.

Package

bytecurry.asdf-ext/atdoc.

Source

file-type.lisp.

Direct superclasses

child-component.

Direct subclasses

atdoc-html.

Direct methods

• (setf atdoc-packages).
• atdoc-packages.
• component-depends-on.
• perform.
• perform.
• source-file-type.

Direct slots

Slot: packages ¶

Initargs

:packages

Readers

atdoc-packages.

Writers

(setf atdoc-packages).

Slot: title ¶

Initargs

:title

Class: atdoc-html ¶

Component to generate HTML documentation with atdoc.

Package

bytecurry.asdf-ext/atdoc.

Source

file-type.lisp.

Direct superclasses

atdoc-docs.

Direct methods

• initialize-instance.
• input-files.
• output-files.
• perform.

Direct slots

Slot: single-page-p ¶

Type

boolean

Initargs

:single-page-p

Slot: css ¶

This is used for the css argument to @code{generate-html-documentation}.
It can be a symbol, string, or pathname.

If it is a symbol, then the downcased name of symbol will name be used as the name of a stylesheet in the css directory of the atdoc installation. Otherwise, the the path is resolved relative to the path of the parent component (usually the system) with a type of "css".
In the latter case path resolution works the same way as for other source files.

Type

(or symbol string pathname)

Initform

:default

Initargs

:css

Slot: include-slot-definitions-p ¶

Type

boolean

Initargs

:include-slot-definitions

Slot: include-internal-symbols-p ¶

Type

boolean

Initform

t

Initargs

:include-internal-symbols-p

Class: doc-op ¶

Package

bytecurry.asdf-ext/doc-op.

Source

file-type.lisp.

Direct superclasses

• downward-operation.
• selfward-operation.

Direct methods

• component-depends-on.
• input-files.
• output-files.
• perform.
• perform.

Direct slots

Slot: selfward-operation ¶

Package

asdf/action.

Allocation

:class

Initform

(quote asdf/lisp-action:load-op)

5.2.1 Ordinary functions

Function: atdoc-docs-title (comp) ¶

Get the title to use for the atdoc documentations.

Package

bytecurry.asdf-ext/atdoc.

Source

file-type.lisp.

5.2.2 Generic functions

Generic Reader: atdoc-packages (object) ¶

Package

bytecurry.asdf-ext/atdoc.

Methods

Reader Method: atdoc-packages ((atdoc-docs atdoc-docs)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

packages.

Generic Writer: (setf atdoc-packages) (object) ¶

Package

bytecurry.asdf-ext/atdoc.

Methods

Writer Method: (setf atdoc-packages) ((atdoc-docs atdoc-docs)) ¶

automatically generated writer method

Source

file-type.lisp.

Target Slot

packages.