The bytecurry.asdf-ext Reference Manual

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

The bytecurry.asdf-ext Reference Manual

This is the bytecurry.asdf-ext Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 03:24:04 2022 GMT+0.

Table of Contents


1 Introduction

bytecurry.asdf-ext

ASDF extensions

Some ASDF extensions. At the moment there are two packages:


2 Systems

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


2.1 bytecurry.asdf-ext

ASDF extension(s) for generating atdoc documentation.

Maintainer

Thayne McCombs

Author

Thayne McCombs

Contact

bytecurry.software@gmail.com

License

MIT

Defsystem Dependency

asdf-package-system (system).

Dependency

bytecurry.asdf-ext/interface (system).

Source

bytecurry.asdf-ext.asd.


2.2 bytecurry.asdf-ext/interface

Maintainer

Thayne McCombs

Author

Thayne McCombs

Contact

bytecurry.software@gmail.com

License

MIT

Dependencies
Source

bytecurry.asdf-ext.asd.


2.3 bytecurry.asdf-ext/doc-op

Maintainer

Thayne McCombs

Author

Thayne McCombs

Contact

bytecurry.software@gmail.com

License

MIT

Dependency

asdf (system).

Source

bytecurry.asdf-ext.asd.


2.4 bytecurry.asdf-ext/atdoc

Maintainer

Thayne McCombs

Author

Thayne McCombs

Contact

bytecurry.software@gmail.com

License

MIT

Dependencies
Source

bytecurry.asdf-ext.asd.


3 Files

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


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

3.1 Lisp


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

Source

bytecurry.asdf-ext.asd.

Parent Component

bytecurry.asdf-ext (system).

ASDF Systems

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

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
Internals

4 Packages

Packages are listed by definition order.


4.1 bytecurry.asdf-ext/doc-op

Source

file-type.lisp.

Nickname

asdf-doc-op

Use List
  • asdf/interface.
  • common-lisp.
Used By List

bytecurry.asdf-ext/interface.

Public Interface

4.2 bytecurry.asdf-ext/atdoc

Source

file-type.lisp.

Use List
  • asdf/interface.
  • common-lisp.
Used By List

bytecurry.asdf-ext/interface.

Public Interface
Internals

4.3 bytecurry.asdf-ext/interface

Source

file-type.lisp.

Nickname

bytecurry.asdf-ext

Use List

5 Definitions

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


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

5.1 Public Interface


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
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
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
Direct slots
Slot: selfward-operation
Package

asdf/action.

Allocation

:class

Initform

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


5.2 Internals


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

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.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   (  
A   C   D   F   G   I   M   O   P   S  
Index Entry  Section

(
(setf atdoc-packages): Private generic functions
(setf atdoc-packages): Private generic functions

A
atdoc-docs-title: Private ordinary functions
atdoc-packages: Private generic functions
atdoc-packages: Private generic functions

C
component-depends-on: Public standalone methods

D
document-system: Public ordinary functions

F
Function, atdoc-docs-title: Private ordinary functions
Function, document-system: Public ordinary functions

G
Generic Function, (setf atdoc-packages): Private generic functions
Generic Function, atdoc-packages: Private generic functions

I
initialize-instance: Public standalone methods
input-files: Public standalone methods

M
Method, (setf atdoc-packages): Private generic functions
Method, atdoc-packages: Private generic functions
Method, component-depends-on: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, input-files: Public standalone methods
Method, output-files: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, source-file-type: Public standalone methods

O
output-files: Public standalone methods

P
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods

S
source-file-type: Public standalone methods

Jump to:   (  
A   C   D   F   G   I   M   O   P   S  

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

A.4 Data types

Jump to:   A   B   C   D   F   P   S  
Index Entry  Section

A
atdoc-docs: Public classes
atdoc-html: Public classes

B
bytecurry.asdf-ext: The bytecurry․asdf-ext system
bytecurry.asdf-ext.asd: The bytecurry․asdf-ext/bytecurry․asdf-ext․asd file
bytecurry.asdf-ext/atdoc: The bytecurry․asdf-ext/atdoc system
bytecurry.asdf-ext/atdoc: The bytecurry․asdf-ext/atdoc package
bytecurry.asdf-ext/doc-op: The bytecurry․asdf-ext/doc-op system
bytecurry.asdf-ext/doc-op: The bytecurry․asdf-ext/doc-op package
bytecurry.asdf-ext/interface: The bytecurry․asdf-ext/interface system
bytecurry.asdf-ext/interface: The bytecurry․asdf-ext/interface package

C
Class, atdoc-docs: Public classes
Class, atdoc-html: Public classes
Class, doc-op: Public classes

D
doc-op: Public classes

F
File, bytecurry.asdf-ext.asd: The bytecurry․asdf-ext/bytecurry․asdf-ext․asd file
File, file-type.lisp: The bytecurry․asdf-ext/interface/file-type․lisp file
File, file-type.lisp: The bytecurry․asdf-ext/doc-op/file-type․lisp file
File, file-type.lisp: The bytecurry․asdf-ext/atdoc/file-type․lisp file
file-type.lisp: The bytecurry․asdf-ext/interface/file-type․lisp file
file-type.lisp: The bytecurry․asdf-ext/doc-op/file-type․lisp file
file-type.lisp: The bytecurry․asdf-ext/atdoc/file-type․lisp file

P
Package, bytecurry.asdf-ext/atdoc: The bytecurry․asdf-ext/atdoc package
Package, bytecurry.asdf-ext/doc-op: The bytecurry․asdf-ext/doc-op package
Package, bytecurry.asdf-ext/interface: The bytecurry․asdf-ext/interface package

S
System, bytecurry.asdf-ext: The bytecurry․asdf-ext system
System, bytecurry.asdf-ext/atdoc: The bytecurry․asdf-ext/atdoc system
System, bytecurry.asdf-ext/doc-op: The bytecurry․asdf-ext/doc-op system
System, bytecurry.asdf-ext/interface: The bytecurry․asdf-ext/interface system

Jump to:   A   B   C   D   F   P   S