The bytecurry.asdf-ext Reference Manual

Table of Contents

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 2.3 "Robert April" on Wed Mar 14 03:00:37 2018 GMT+0.


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

1 Introduction

bytecurry.asdf-ext

ASDF extensions

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


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

2 Systems

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


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

2.1 bytecurry.asdf-ext

Maintainer

Thayne McCombs

Author

Thayne McCombs

Contact

bytecurry.software@gmail.com

License

MIT

Description

ASDF extension(s) for generating atdoc documentation.

Defsystem Dependency

asdf-package-system

Dependency

bytecurry.asdf-ext/interface (system)

Source

bytecurry.asdf-ext.asd (file)


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

2.2 bytecurry.asdf-ext/interface

Dependencies
Source

bytecurry.asdf-ext.asd (file)

Component

lisp.lisp (file)


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

2.3 bytecurry.asdf-ext/atdoc

Dependencies
Source

bytecurry.asdf-ext.asd (file)

Component

lisp.lisp (file)


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

2.4 bytecurry.asdf-ext/doc-op

Dependency

asdf

Source

bytecurry.asdf-ext.asd (file)

Component

lisp.lisp (file)


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

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


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 bytecurry.asdf-ext.asd

Location

bytecurry.asdf-ext.asd

Systems

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

bytecurry.asdf-ext/interface (system)

Location

interface.lisp

Packages

bytecurry.asdf-ext/interface


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 bytecurry.asdf-ext/atdoc/lisp.lisp

Parent

bytecurry.asdf-ext/atdoc (system)

Location

atdoc.lisp

Packages

bytecurry.asdf-ext/atdoc

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 bytecurry.asdf-ext/doc-op/lisp.lisp

Parent

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

Location

doc-op.lisp

Packages

bytecurry.asdf-ext/doc-op

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 bytecurry.asdf-ext/interface

Source

lisp.lisp (file)

Nickname

bytecurry.asdf-ext

Use List

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

4.2 bytecurry.asdf-ext/atdoc

Source

lisp.lisp (file)

Use List
Used By List

bytecurry.asdf-ext/interface

Exported Definitions
Internal Definitions

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

4.3 bytecurry.asdf-ext/doc-op

Source

lisp.lisp (file)

Nickname

asdf-doc-op

Use List
Used By List

bytecurry.asdf-ext/interface

Exported Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 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

lisp.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Classes

Class: atdoc-docs ()

Operation to create atdoc documentation for a system.

Package

bytecurry.asdf-ext/atdoc

Source

lisp.lisp (file)

Direct superclasses

child-component (class)

Direct subclasses

atdoc-html (class)

Direct methods
  • component-depends-on (method)
  • perform (method)
  • perform (method)
  • source-file-type (method)
  • atdoc-packages (method)
  • atdoc-packages (method)
Direct slots
Slot: packages
Initargs

:packages

Readers

atdoc-packages (generic function)

Writers

(setf atdoc-packages) (generic function)

Slot: title
Initargs

:title

Class: atdoc-html ()

Component to generate HTML documentation with atdoc.

Package

bytecurry.asdf-ext/atdoc

Source

lisp.lisp (file)

Direct superclasses

atdoc-docs (class)

Direct methods
  • output-files (method)
  • input-files (method)
  • perform (method)
  • initialize-instance (method)
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)

Initargs

:css

Initform

:default

Slot: include-slot-definitions-p
Type

boolean

Initargs

:include-slot-definitions

Slot: include-internal-symbols-p
Type

boolean

Initargs

:include-internal-symbols-p

Initform

t

Class: doc-op ()
Package

bytecurry.asdf-ext/doc-op

Source

lisp.lisp (file)

Direct superclasses
  • downward-operation (class)
  • selfward-operation (class)
Direct methods
  • output-files (method)
  • input-files (method)
  • perform (method)
  • component-depends-on (method)
  • perform (method)
Direct slots
Slot: selfward-operation
Allocation

:class

Initform

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


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: atdoc-docs-title COMP

Get the title to use for the atdoc documentations.

Package

bytecurry.asdf-ext/atdoc

Source

lisp.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Generic functions

Generic Function: atdoc-packages OBJECT
Generic Function: (setf atdoc-packages) NEW-VALUE OBJECT
Package

bytecurry.asdf-ext/atdoc

Methods
Method: atdoc-packages (ATDOC-DOCS atdoc-docs)

automatically generated reader method

Source

lisp.lisp (file)

Method: (setf atdoc-packages) NEW-VALUE (ATDOC-DOCS atdoc-docs)

automatically generated writer method

Source

lisp.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   B   F   L  
Index Entry  Section

B
bytecurry.asdf-ext.asd: The bytecurry<dot>asdf-ext<dot>asd file
bytecurry.asdf-ext/atdoc/lisp.lisp: The bytecurry<dot>asdf-ext/atdoc/lisp<dot>lisp file
bytecurry.asdf-ext/doc-op/lisp.lisp: The bytecurry<dot>asdf-ext/doc-op/lisp<dot>lisp file
bytecurry.asdf-ext/interface/lisp.lisp: The bytecurry<dot>asdf-ext/interface/lisp<dot>lisp file

F
File, Lisp, bytecurry.asdf-ext.asd: The bytecurry<dot>asdf-ext<dot>asd file
File, Lisp, bytecurry.asdf-ext/atdoc/lisp.lisp: The bytecurry<dot>asdf-ext/atdoc/lisp<dot>lisp file
File, Lisp, bytecurry.asdf-ext/doc-op/lisp.lisp: The bytecurry<dot>asdf-ext/doc-op/lisp<dot>lisp file
File, Lisp, bytecurry.asdf-ext/interface/lisp.lisp: The bytecurry<dot>asdf-ext/interface/lisp<dot>lisp file

L
Lisp File, bytecurry.asdf-ext.asd: The bytecurry<dot>asdf-ext<dot>asd file
Lisp File, bytecurry.asdf-ext/atdoc/lisp.lisp: The bytecurry<dot>asdf-ext/atdoc/lisp<dot>lisp file
Lisp File, bytecurry.asdf-ext/doc-op/lisp.lisp: The bytecurry<dot>asdf-ext/doc-op/lisp<dot>lisp file
Lisp File, bytecurry.asdf-ext/interface/lisp.lisp: The bytecurry<dot>asdf-ext/interface/lisp<dot>lisp file

Jump to:   B   F   L  

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

A.2 Functions

Jump to:   (  
A   D   F   G   M  
Index Entry  Section

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

A
atdoc-docs-title: Internal functions
atdoc-packages: Internal generic functions
atdoc-packages: Internal generic functions

D
document-system: Exported functions

F
Function, atdoc-docs-title: Internal functions
Function, document-system: Exported functions

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

M
Method, (setf atdoc-packages): Internal generic functions
Method, atdoc-packages: Internal generic functions

Jump to:   (  
A   D   F   G   M  

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

A.3 Variables

Jump to:   C   I   P   S   T  
Index Entry  Section

C
css: Exported classes

I
include-internal-symbols-p: Exported classes
include-slot-definitions-p: Exported classes

P
packages: Exported classes

S
selfward-operation: Exported classes
single-page-p: Exported classes
Slot, css: Exported classes
Slot, include-internal-symbols-p: Exported classes
Slot, include-slot-definitions-p: Exported classes
Slot, packages: Exported classes
Slot, selfward-operation: Exported classes
Slot, single-page-p: Exported classes
Slot, title: Exported classes

T
title: Exported classes

Jump to:   C   I   P   S   T  

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

A.4 Data types

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

A
atdoc-docs: Exported classes
atdoc-html: Exported classes

B
bytecurry.asdf-ext: The bytecurry<dot>asdf-ext system
bytecurry.asdf-ext/atdoc: The bytecurry<dot>asdf-ext/atdoc system
bytecurry.asdf-ext/atdoc: The bytecurry<dot>asdf-ext/atdoc package
bytecurry.asdf-ext/doc-op: The bytecurry<dot>asdf-ext/doc-op system
bytecurry.asdf-ext/doc-op: The bytecurry<dot>asdf-ext/doc-op package
bytecurry.asdf-ext/interface: The bytecurry<dot>asdf-ext/interface system
bytecurry.asdf-ext/interface: The bytecurry<dot>asdf-ext/interface package

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

D
doc-op: Exported classes

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

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

Jump to:   A   B   C   D   P   S