The tinaa Reference Manual

This is the tinaa Reference Manual, version 0.5.11, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:07:59 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 tinaa

Maintainer

Gary Warren King <>

Author

Gary Warren King <>

Home Page

http://www.cliki.net/asdf-system-connections

License

Basically BSD, see file COPYING for details

Version

0.5.11

Dependencies
  • defsystem-compatibility (system)., at least version "0.1.2"
  • metatilities (system)., at least version "0.6.6"
  • lml2 (system).
  • trivial-shell (system).
  • cl-graph (system).
  • anaphora (system).
  • dynamic-classes (system).
  • cl-containers (system)., at least version "0.11.5"
Source

tinaa.asd.

Child Components

2 Modules

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


2.1 tinaa/dev

Source

tinaa.asd.

Parent Component

tinaa (system).

Child Components

2.2 tinaa/website

Source

tinaa.asd.

Parent Component

tinaa (system).

Child Component

source (module).


2.3 tinaa/website/source

Source

tinaa.asd.

Parent Component

website (module).

Child Component

index.md (file).


3 Files

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


3.1 Lisp


3.1.1 tinaa/tinaa.asd

Source

tinaa.asd.

Parent Component

tinaa (system).

ASDF Systems

tinaa.


3.1.2 tinaa/dev/package.lisp

Source

tinaa.asd.

Parent Component

dev (module).

Packages

tinaa.


3.1.3 tinaa/dev/class-defs.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.4 tinaa/dev/api.lisp

Dependency

package.lisp (file).

Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.5 tinaa/dev/macros.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Internals

3.1.6 tinaa/dev/utilities.lisp

Dependency

macros.lisp (file).

Source

tinaa.asd.

Parent Component

dev (module).

Internals

3.1.7 tinaa/dev/definitions.lisp

Dependency

package.lisp (file).

Source

tinaa.asd.

Parent Component

dev (module).

Public Interface

*css-file* (special variable).

Internals

3.1.8 tinaa/dev/files-and-urls.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Internals

3.1.9 tinaa/dev/tinaa.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.10 tinaa/dev/generate-output.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.11 tinaa/dev/doc-package.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.12 tinaa/dev/doc-class.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.13 tinaa/dev/doc-variable.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.14 tinaa/dev/doc-function.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.15 tinaa/dev/doc-symbol.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface

make-part (method).

Internals

3.1.16 tinaa/dev/doc-asdf-system.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.17 tinaa/dev/build-indexes.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.18 tinaa/dev/permuted-index.lisp

Dependency

build-indexes.lisp (file).

Source

tinaa.asd.

Parent Component

dev (module).

Public Interface

display-part (method).

Internals

3.1.19 tinaa/dev/build-contents.lisp

Dependency

package.lisp (file).

Source

tinaa.asd.

Parent Component

dev (module).

Internals

3.1.20 tinaa/dev/graph-parts.lisp

Dependencies
Source

tinaa.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.21 tinaa/dev/templates.lisp

Dependency

tinaa.lisp (file).

Source

tinaa.asd.

Parent Component

dev (module).


3.1.22 tinaa/dev/epilogue.lisp

Dependency

tinaa.lisp (file).

Source

tinaa.asd.

Parent Component

dev (module).


3.2 Static


3.2.1 tinaa/dev/notes.text

Source

tinaa.asd.

Parent Component

dev (module).


3.2.2 tinaa/dev/tinaa.css

Source

tinaa.asd.

Parent Component

dev (module).


3.2.3 tinaa/website/source/index.md

Source

tinaa.asd.

Parent Component

source (module).


4 Packages

Packages are listed by definition order.


4.1 tinaa

A simple, yet extensible, Common Lisp documentation package.

Source

package.lisp.

Nickname

doclisp

Use List
  • anaphora.
  • common-lisp.
  • defsystem-compatibility.
  • lisp-markup-language-2.
  • metabang.bind.
  • metabang.cl-containers.
  • metabang.moptilities.
  • metabang.utilities.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *css-file*

If set, this should point to the CSS file that Tinaa should use.

Package

tinaa.

Source

definitions.lisp.


5.1.2 Ordinary functions

Function: document-system (system-kind system-name destination &rest args &key show-parts-without-documentation? write-files? page-writer-class)

Create TINAA documentation for a system. System-kind should be ’package or some other value for which it makes sense (e.g., an ’asdf-system if ASDFis loaded...). System-name is the identifier of the
system. Destination is the location in the file system where you want the documentation to go. Finally, you can pass in other arguments that are specific to the kind of system you are documenting.

Note that system-kind will be coerced into a symbol interned in the Tinaa package because this makes Tinaa easier to use. If you happen to write your own system-kind, it will need to be a class defined in the Tinaa package.

Package

tinaa.

Source

generate-output.lisp.


5.1.3 Generic functions

Generic Function: display-part (page-writer part mode &key spaces &allow-other-keys)

Output information about a part. Example modes are :subpart-list, :detail, :summary.

Package

tinaa.

Source

api.lisp.

Methods
Method: display-part ((writer simple-page-writer) (part basic-doclisp-part) (mode (eql :permuted-index)) &key spaces &allow-other-keys)
Source

permuted-index.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-symbol) (mode (eql :index)) &key &allow-other-keys)
Source

build-indexes.lisp.

Method: display-part ((writer simple-page-writer) (part basic-doclisp-part) (mode (eql :index)) &key &allow-other-keys)
Source

build-indexes.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-file) (mode (eql :table-summary)) &key &allow-other-keys)
Source

doc-asdf-system.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-asdf-system) (mode (eql :detail)) &key &allow-other-keys)
Source

doc-asdf-system.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-method) (mode (eql :table-summary)) &key &allow-other-keys)
Source

doc-function.lisp.

Method: display-part ((writer simple-page-writer) (part basic-doclisp-part) (mode (eql :function)) &key &allow-other-keys)
Source

doc-function.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-generic-function) (mode (eql :detail)) &key &allow-other-keys)
Source

doc-function.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-function) (mode (eql :detail)) &key &allow-other-keys)
Source

doc-function.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-variable) (mode (eql :detail)) &key &allow-other-keys)
Source

doc-variable.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-slot) (mode (eql :table-summary)) &key &allow-other-keys)
Source

doc-class.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-class) (mode (eql :detail)) &key &allow-other-keys)
Source

doc-class.lisp.

Method: display-part ((writer simple-page-writer) (part doclisp-package) (mode (eql :detail)) &key &allow-other-keys)
Source

doc-package.lisp.

Method: display-part ((writer simple-page-writer) (part basic-doclisp-part) (mode (eql :table-summary)) &key &allow-other-keys)
Source

generate-output.lisp.

Method: display-part ((writer simple-page-writer) (part basic-doclisp-part) (mode (eql :name+type)) &key &allow-other-keys)
Source

tinaa.lisp.

Method: display-part ((writer simple-page-writer) (part basic-doclisp-part) (mode (eql :name)) &key &allow-other-keys)
Source

tinaa.lisp.

Method: display-part :around ((writer simple-page-writer) part mode &key &allow-other-keys)
Source

class-defs.lisp.

Generic Reader: instance (object)
Package

tinaa.

Methods
Reader Method: instance ((basic-doclisp-part basic-doclisp-part))

An instance of this part.

Source

class-defs.lisp.

Target Slot

instance.

Generic Function: make-part (parent kind name &key &allow-other-keys)

Make a part named ’name’ of kind ’kind’ whose parent is ’parent’.

Package

tinaa.

Source

api.lisp.

Methods
Method: make-part (parent (kind (eql tinaa::file)) name &rest args &key &allow-other-keys)
Source

doc-asdf-system.lisp.

Method: make-part (parent (kind (eql tinaa::asdf-system)) name &rest args &key &allow-other-keys)
Source

doc-asdf-system.lisp.

Method: make-part (parent (kind (eql symbol)) name &rest args &key &allow-other-keys)
Source

doc-symbol.lisp.

Method: make-part (parent (kind (eql tinaa::macro)) name &rest args &key &allow-other-keys)
Source

doc-function.lisp.

Method: make-part (parent (kind (eql method)) name &rest args &key &allow-other-keys)
Source

doc-function.lisp.

Method: make-part (parent (kind (eql generic-function)) name &rest args &key &allow-other-keys)
Source

doc-function.lisp.

Method: make-part (parent (kind (eql function)) name &rest args &key &allow-other-keys)
Source

doc-function.lisp.

Method: make-part (parent (kind (eql tinaa::constant)) name &rest args &key &allow-other-keys)
Source

doc-variable.lisp.

Method: make-part (parent (kind (eql variable)) name &rest args &key &allow-other-keys)
Source

doc-variable.lisp.

Method: make-part (parent (kind (eql tinaa::slot)) name &rest args &key &allow-other-keys)
Source

doc-class.lisp.

Method: make-part (parent (kind (eql condition)) name &rest args &key &allow-other-keys)
Source

doc-class.lisp.

Method: make-part (parent (kind (eql class)) name &rest args &key &allow-other-keys)
Source

doc-class.lisp.

Method: make-part (parent (kind (eql package)) name &rest args &key &allow-other-keys)
Source

doc-package.lisp.

Method: make-part :around (parent kind name &key &allow-other-keys)
Source

tinaa.lisp.

Method: make-part (parent kind name &rest args &key &allow-other-keys)
Source

tinaa.lisp.

Generic Reader: parents (object)
Package

tinaa.

Methods
Reader Method: parents ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

parents.

Generic Writer: (setf parents) (object)
Package

tinaa.

Methods
Writer Method: (setf parents) ((basic-doclisp-part basic-doclisp-part))

automatically generated writer method

Source

class-defs.lisp.

Target Slot

parents.

Generic Function: part-documentation (part)

Returns whatever documentation is available for part using the Common Lisp documentation function.

Package

tinaa.

Source

api.lisp.

Methods
Method: part-documentation ((part doclisp-asdf-system))
Source

doc-asdf-system.lisp.

Method: part-documentation ((part doclisp-function))
Source

doc-function.lisp.

Method: part-documentation ((part doclisp-variable))
Source

doc-variable.lisp.

Method: part-documentation ((part doclisp-slot))
Source

doc-class.lisp.

Method: part-documentation ((part doclisp-condition))
Source

doc-class.lisp.

Method: part-documentation ((part doclisp-class))
Source

doc-class.lisp.

Method: part-documentation ((part doclisp-package))
Source

doc-package.lisp.

Method: part-documentation ((part basic-doclisp-part))
Source

tinaa.lisp.

Generic Function: partname-list (part part-kind)

Returns a list of the names of the subparts of part of type ’part-kind’. Usually, these will be symbols but they could be strings too.

Package

tinaa.

Source

api.lisp.

Methods
Method: partname-list ((part doclisp-asdf-system) (part-name (eql tinaa::other-dependency)))
Source

doc-asdf-system.lisp.

Method: partname-list ((part doclisp-asdf-system) (part-name (eql tinaa::direct-dependency)))
Source

doc-asdf-system.lisp.

Method: partname-list ((part doclisp-asdf-system) (part-name (eql tinaa::file)))
Source

doc-asdf-system.lisp.

Method: partname-list ((part doclisp-asdf-system) (part-name (eql tinaa::other-file)))
Source

doc-asdf-system.lisp.

Method: partname-list ((part doclisp-asdf-system) (part-name (eql tinaa::direct-file)))
Source

doc-asdf-system.lisp.

Method: partname-list ((part doclisp-asdf-system) (part-name (eql tinaa::other-package)))
Source

doc-asdf-system.lisp.

Method: partname-list ((part doclisp-asdf-system) (part-name (eql tinaa::direct-package)))
Source

doc-asdf-system.lisp.

Method: partname-list ((part doclisp-class) (part-name (eql tinaa::subclass)))
Source

doc-class.lisp.

Method: partname-list ((part doclisp-class) (part-name (eql tinaa::superclass)))
Source

doc-class.lisp.

Method: partname-list ((part doclisp-class) (part-name (eql class)))
Source

doc-class.lisp.

Method: partname-list ((part doclisp-class) (part-name (eql tinaa::slot)))
Source

doc-class.lisp.

Method: partname-list ((part doclisp-class) (part-name (eql tinaa::other-method)))
Source

doc-class.lisp.

Method: partname-list ((part doclisp-class) (part-name (eql tinaa::direct-method)))
Source

doc-class.lisp.

Method: partname-list ((part doclisp-class) (part-name (eql method)))
Source

doc-class.lisp.

Method: partname-list ((part doclisp-package) (part-name (eql symbol)))
Source

doc-package.lisp.

Method: partname-list ((part doclisp-package) (part-name (eql tinaa::macro)))
Source

doc-package.lisp.

Method: partname-list ((part doclisp-package) (part-name (eql generic-function)))
Source

doc-package.lisp.

Method: partname-list ((part doclisp-package) (part-name (eql function)))
Source

doc-package.lisp.

Method: partname-list ((part doclisp-package) (part-name (eql tinaa::constant)))
Source

doc-package.lisp.

Method: partname-list ((part doclisp-package) (part-name (eql variable)))
Source

doc-package.lisp.

Method: partname-list ((part doclisp-package) (part-name (eql condition)))
Source

doc-package.lisp.

Method: partname-list ((part doclisp-package) (part-name (eql class)))
Source

doc-package.lisp.

Method: partname-list :around (part part-kind)
Source

class-defs.lisp.

Generic Function: subpart-kinds (assembly)

Returns a list of the kinds of the subparts of assembly. This is a list of instances of subpart-kind.

Package

tinaa.

Source

api.lisp.

Methods
Method: subpart-kinds ((part doclisp-asdf-system))
Source

doc-asdf-system.lisp.

Method: subpart-kinds ((part doclisp-condition))
Source

doc-class.lisp.

Method: subpart-kinds ((part doclisp-class))
Source

doc-class.lisp.

Method: subpart-kinds ((part doclisp-package))
Source

doc-package.lisp.

Method: subpart-kinds ((part basic-doclisp-part))
Source

tinaa.lisp.

Method: subpart-kinds :around ((assembly doclisp-assembly))
Source

tinaa.lisp.


5.1.4 Standalone methods

Method: edge->dot ((thing direct-package-edge) stream)
Package

cl-graph.

Source

graph-parts.lisp.

Method: initialize-instance :after ((object doclisp-assembly) &key)
Source

class-defs.lisp.

Method: initialize-instance :after ((object basic-doclisp-part) &key)
Source

class-defs.lisp.

Method: initialize-instance :after ((object doclisp-asdf-system) &key)
Source

doc-asdf-system.lisp.

Method: initialize-instance :after ((object subpart-kind) &key)
Source

class-defs.lisp.

Method: initialize-instance :after ((object doclisp-package) &key)
Source

doc-package.lisp.

Method: initialize-instance :after ((object doclisp-condition) &key)
Source

doc-class.lisp.

Method: initialize-instance :after ((object doclisp-class) &key)
Source

doc-class.lisp.

Reader Method: parent ((condition cannot-make-part))
Package

metabang.utilities.

Source

class-defs.lisp.

Target Slot

parent.

Reader Method: parent ((condition part-kind-unknown-error))
Package

metabang.utilities.

Source

class-defs.lisp.

Target Slot

parent.

Method: print-object ((system basic-doclisp-part) stream)
Source

tinaa.lisp.

Method: print-object ((object subpart-kind) stream)
Source

class-defs.lisp.

Method: vertex->dot ((thing tinaa-package-vertex) stream)
Package

cl-graph.

Source

graph-parts.lisp.


5.1.5 Conditions

Condition: cannot-make-part

This error is signaled when a part cannot be created.

Package

tinaa.

Source

class-defs.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: parent
Package

metabang.utilities.

Initform

(quote nil)

Initargs

:parent

Readers

parent.

Writers

This slot is read-only.

Slot: kind
Initform

(quote nil)

Initargs

:kind

Readers

kind.

Writers

This slot is read-only.

Slot: name
Package

metabang.utilities.

Initform

(quote nil)

Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: reason
Initform

(quote nil)

Initargs

:reason

Readers

reason.

Writers

This slot is read-only.


5.1.6 Classes

Class: doclisp-assembly

A part with sub-parts.

Package

tinaa.

Source

class-defs.lisp.

Direct superclasses

basic-doclisp-part.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:page-writer-class(quote simple-page-writer)
Direct slots
Slot: subparts
Initform

(metabang.cl-containers:make-container (quote metabang.cl-containers:alist-container) :initial-element-fn (lambda nil (metabang.cl-containers:make-container (quote metabang.cl-containers:alist-container))))

Readers

subparts.

Writers

This slot is read-only.

Slot: page-writer-class
Initargs

:page-writer-class

Readers

page-writer-class.

Writers

This slot is read-only.

Slot: page-writer
Readers

page-writer.

Writers

This slot is read-only.

Class: doclisp-part

A part without pieces (a leaf).

Package

tinaa.

Source

class-defs.lisp.

Direct superclasses

basic-doclisp-part.

Direct subclasses

5.2 Internals


5.2.1 Special variables

Special Variable: *current-index*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *current-part*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *current-part-index*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *default-packages-to-ignore*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *document-file*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *document-root*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *document-stream*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *graph-image-format*

The image format to use for graph files

Package

tinaa.

Source

graph-parts.lisp.

Special Variable: *graph-size-in-inches*
Package

tinaa.

Source

graph-parts.lisp.

Special Variable: *graphviz-directory*

The location of the various GraphViz files. In particular, dot, neato, circo and twopi should live in this directory.

Package

tinaa.

Source

graph-parts.lisp.

Special Variable: *make-part-methods*

Used to help ensure that we don’t use up the stack trying to find a good method... Probably too baroque.

Package

tinaa.

Source

tinaa.lisp.

Special Variable: *output-calls*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *packages-to-document*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *required-index-contents*
Package

tinaa.

Source

build-indexes.lisp.

Special Variable: *root-part*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *short-documentation-length*

The number of characters of documentation to show in summaries.

Package

tinaa.

Source

definitions.lisp.

Special Variable: *tinaa-home-page*
Package

tinaa.

Source

definitions.lisp.

Special Variable: *tinaa-version*
Package

tinaa.

Source

definitions.lisp.


5.2.2 Macros

Macro: documenting (part &body body)
Package

tinaa.

Source

macros.lisp.

Macro: documenting-page ((part &key title force-contents-link?) &body body)
Package

tinaa.

Source

macros.lisp.

Macro: with-html-output ((stream) &body body)
Package

tinaa.

Source

macros.lisp.


5.2.3 Ordinary functions

Function: add-package-to-document (package-name)
Package

tinaa.

Source

tinaa.lisp.

Package

tinaa.

Source

generate-output.lisp.

Function: any-indexes-p (part)
Package

tinaa.

Source

build-indexes.lisp.

Function: build-index (writer part parts-to-index heading)
Package

tinaa.

Source

build-indexes.lisp.

Function: build-index-letters (symbol-list parts &key key)
Package

tinaa.

Source

build-indexes.lisp.

Function: build-license-page (part)
Package

tinaa.

Source

doc-asdf-system.lisp.

Function: build-part-graph (writer root &key depth)
Package

tinaa.

Source

graph-parts.lisp.

Function: build-permuted-index (main-part parts-to-index heading)

A permuted index includes each n-word entry up to n times, at points corresponding to the use of each word in the entry as the sort key. For example, a symbol FOO-BAR would occur twice, once under FOO and BAR. This allows you to use any word in the symbol’s name to search for that symbol.

Package

tinaa.

Source

permuted-index.lisp.

Function: canonical-package-id (package)
Package

tinaa.

Source

tinaa.lisp.

Function: class-graph->dot (graph)

Returns a string describing graph in DOT format.

Package

tinaa.

Source

doc-class.lisp.

Function: class-sorter (a b)
Package

tinaa.

Source

doc-package.lisp.

Function: class-uninteresting-p (class-name)
Package

tinaa.

Source

doc-class.lisp.

Function: conditionp (thing)

Returns true if and only if thing is a condition

Package

tinaa.

Source

doc-package.lisp.

Function: content-things-from-part (part)

Returns a list of < kind name url > triples for the subparts of part that should be displayed in the table of contents.

Package

tinaa.

Source

build-contents.lisp.

Function: display-arguments (arguments)
Package

tinaa.

Source

utilities.lisp.

Function: display-function (part)
Package

tinaa.

Source

utilities.lisp.

Function: display-list-of-potential-parts (part subpart-names subpart-kind)
Package

tinaa.

Source

generate-output.lisp.

Function: display-part-for-index (writer part string)
Package

tinaa.

Source

build-indexes.lisp.

Function: file-depth-below-root (url)
Package

tinaa.

Source

files-and-urls.lisp.

Function: filtered-package-symbols (part filter)
Package

tinaa.

Source

doc-package.lisp.

Function: find-name-and-email (string)

Returns (as multiple values) a name and e-mail address as parsed from a string. Handles only "name <mail>" right now. if the string isn’t in this from,then this function assumes that the string contains only a name. Also doesn’t handle group projects!

Package

tinaa.

Source

doc-asdf-system.lisp.

Function: graph-file-name-for-part (writer part &key pathname-type)
Package

tinaa.

Source

graph-parts.lisp.

Function: ignore-package-p (p)
Package

tinaa.

Source

tinaa.lisp.

Function: index-file-name (part index-name)
Package

tinaa.

Source

build-indexes.lisp.

Function: index-for-kind-p (part kind)
Package

tinaa.

Source

build-indexes.lisp.

Function: index-part-p (part)
Package

tinaa.

Source

build-indexes.lisp.

Function: interesting-subclasses (thing)
Package

tinaa.

Source

doc-class.lisp.

Function: interesting-superclasses (thing)
Package

tinaa.

Source

doc-class.lisp.

Function: lml-insert-file (file)
Package

tinaa.

Source

utilities.lisp.

Function: local-index-url (part index-name)
Package

tinaa.

Source

build-indexes.lisp.

Function: make-local-class-graph (class-part)
Package

tinaa.

Source

doc-class.lisp.

Function: make-string-of-size (size initial-element)
Package

tinaa.

Source

permuted-index.lisp.

Function: map-parts-from-leaves (part fn)
Package

tinaa.

Source

utilities.lisp.

Function: map-subpart-kinds (part fn)
Package

tinaa.

Source

utilities.lisp.

Function: maybe-display-part (parent name kind mode)
Package

tinaa.

Source

generate-output.lisp.

Function: method-sorter (m1 m2)
Package

tinaa.

Source

doc-function.lisp.

Function: nice-package-name (package)
Package

tinaa.

Source

doc-package.lisp.

Function: ns-tlp (pathname)
Package

tinaa.

Source

graph-parts.lisp.

Function: output-table-summary (writer part parts-per-row)
Package

tinaa.

Source

generate-output.lisp.

Function: packages-to-document ()
Package

tinaa.

Source

tinaa.lisp.

Function: packages-to-ignore ()
Package

tinaa.

Source

tinaa.lisp.

Function: part-can-have-documention-p (part)
Package

tinaa.

Source

tinaa.lisp.

Function: part-has-parents-p (part)
Package

tinaa.

Source

generate-output.lisp.

Function: part-symbol-name (part)
Package

tinaa.

Source

tinaa.lisp.

Function: parts-matching-symbol (symbol-part name-holder)

Returns a list of parts in name-holder than have the same name as symbol

Package

tinaa.

Source

permuted-index.lisp.

Function: parts-with-no-documentation (part)
Package

tinaa.

Source

tinaa.lisp.

Function: pathname->unix (pathname)
Package

tinaa.

Source

graph-parts.lisp.

Function: permuted-index-delimiter-p (ch)
Package

tinaa.

Source

permuted-index.lisp.

Function: permuted-index-locations (symbol delimiter-p)
Package

tinaa.

Source

permuted-index.lisp.

Function: princ-n-spaces (stream n)
Package

tinaa.

Source

permuted-index.lisp.

Function: relative-url (url)

Returns a URL that points to the same things as ‘url‘ but relative to (url *current-part*)

Package

tinaa.

Source

files-and-urls.lisp.

Function: root-parent (part)

Go up the parent chain until there are no parents... that’s the root.

Package

tinaa.

Source

tinaa.lisp.

Function: set-flags (part value)
Package

tinaa.

Source

utilities.lisp.

Function: slot-writer-name (writer)
Package

tinaa.

Source

doc-class.lisp.

Function: some-parent (part)
Package

tinaa.

Source

tinaa.lisp.

Function: stylesheet-url (part)
Package

tinaa.

Source

files-and-urls.lisp.

Function: subpart-info (part kind)
Package

tinaa.

Source

tinaa.lisp.

Function: symbol-count (package kind)
Package

tinaa.

Source

doc-package.lisp.

Function: symbol-name-tree (x)
Package

tinaa.

Source

doc-function.lisp.

Function: system-packages (part system-closure?)
Package

tinaa.

Source

doc-asdf-system.lisp.

Function: tinaa-home ()
Package

tinaa.

Source

tinaa.lisp.

Function: update-document-part-p (package)
Package

tinaa.

Source

doc-package.lisp.

Function: url->file (url &optional extension)

Returns a file spec for the url rooted at *document-root*. The URL must be delimited using forward slashes (#/). The *document-root* can be a logical pathname or a physical pathname on the current platform.

Package

tinaa.

Source

files-and-urls.lisp.

Function: url-name (url)
Package

tinaa.

Source

generate-output.lisp.

Function: write-css-file (writer destination &rest args &key if-exists &allow-other-keys)
Package

tinaa.

Source

generate-output.lisp.

Function: write-part-graph (writer part)
Package

tinaa.

Source

graph-parts.lisp.


5.2.4 Generic functions

Package

tinaa.

Methods
Source

files-and-urls.lisp.

Source

files-and-urls.lisp.

Generic Function: add-part-vertex (graph part)
Package

tinaa.

Methods
Method: add-part-vertex ((graph basic-graph) (part doclisp-asdf-system))
Source

graph-parts.lisp.

Method: add-part-vertex ((graph basic-graph) (part doclisp-package))
Source

graph-parts.lisp.

Method: add-part-vertex ((graph basic-graph) (part basic-doclisp-part))
Source

graph-parts.lisp.

Generic Reader: args (condition)
Package

tinaa.

Methods
Reader Method: args ((condition part-kind-unknown-error))
Source

class-defs.lisp.

Target Slot

args.

Generic Reader: author-mail (object)
Package

tinaa.

Methods
Reader Method: author-mail ((doclisp-asdf-system doclisp-asdf-system))

automatically generated reader method

Source

doc-asdf-system.lisp.

Target Slot

author-mail.

Generic Reader: author-name (object)
Package

tinaa.

Methods
Reader Method: author-name ((doclisp-asdf-system doclisp-asdf-system))

automatically generated reader method

Source

doc-asdf-system.lisp.

Target Slot

author-name.

Generic Function: build-contents-page (writer root top-level-things)
Package

tinaa.

Methods
Method: build-contents-page ((writer basic-page-writer) root top-level-things)
Source

build-contents.lisp.

Generic Function: build-documentation (writer part root &key erase-first? &allow-other-keys)
Package

tinaa.

Methods
Method: build-documentation :before ((writer page-writer-with-graphs) (part doclisp-assembly) root &key &allow-other-keys)
Source

graph-parts.lisp.

Method: build-documentation ((writer basic-page-writer) (part doclisp-assembly) root &key &allow-other-keys)
Source

generate-output.lisp.

Method: build-documentation :around ((writer basic-page-writer) (part doclisp-assembly) root &key erase-first?)
Source

generate-output.lisp.

Package

tinaa.

Source

api.lisp.

Methods
Source

build-indexes.lisp.

Source

build-indexes.lisp.

Generic Function: build-indexes (writer part)
Package

tinaa.

Methods
Method: build-indexes ((writer basic-page-writer) (part name-holder-mixin))
Source

build-indexes.lisp.

Method: build-indexes ((writer basic-page-writer) (part basic-doclisp-part))
Source

build-indexes.lisp.

Generic Reader: css-file (object)
Package

tinaa.

Methods
Reader Method: css-file ((basic-page-writer basic-page-writer))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

css-file.

Generic Writer: (setf css-file) (object)
Package

tinaa.

Methods
Writer Method: (setf css-file) ((basic-page-writer basic-page-writer))

automatically generated writer method

Source

class-defs.lisp.

Target Slot

css-file.

Generic Function: css-file-for-writer (writer)
Package

tinaa.

Methods
Method: css-file-for-writer ((writer basic-page-writer))
Source

generate-output.lisp.

Generic Function: depth-for-part (writer part)
Package

tinaa.

Methods
Method: depth-for-part (writer (part basic-doclisp-part))
Source

graph-parts.lisp.

Generic Function: direct-instance (slot)
Package

tinaa.

Methods
Method: direct-instance ((slot doclisp-slot))
Source

doc-class.lisp.

Generic Function: direct-parent (slot)
Package

tinaa.

Methods
Method: direct-parent ((slot doclisp-slot))
Source

doc-class.lisp.

Generic Writer: (setf direct-parent) (object)
Package

tinaa.

Methods
Writer Method: (setf direct-parent) ((doclisp-slot doclisp-slot))

automatically generated writer method

Source

doc-class.lisp.

Target Slot

direct-parent.

Generic Function: doclisp-footer (part &key force-contents-link?)
Package

tinaa.

Methods
Method: doclisp-footer (part &key force-contents-link?)
Source

generate-output.lisp.

Generic Function: doclisp-header (part &key force-contents-link?)
Package

tinaa.

Methods
Method: doclisp-header ((part basic-doclisp-part) &key force-contents-link?)
Source

generate-output.lisp.

Method: doclisp-header ((part (eql nil)) &key force-contents-link?)
Source

generate-output.lisp.

Generic Function: document-part-p (name-holder part)
Package

tinaa.

Source

api.lisp.

Methods
Method: document-part-p ((name-holder doclisp-package) (part basic-doclisp-part))
Source

doc-package.lisp.

Method: document-part-p ((name-holder doclisp-package) (part doclisp-package))
Source

doc-package.lisp.

Method: document-part-p ((name-holder name-holder-mixin) (part basic-doclisp-part))
Source

tinaa.lisp.

Generic Function: document-part-to-file (page-writer part)
Package

tinaa.

Source

api.lisp.

Methods
Method: document-part-to-file ((writer basic-page-writer) (part doclisp-package))
Source

doc-package.lisp.

Method: document-part-to-file ((writer basic-page-writer) (part basic-doclisp-part))
Source

generate-output.lisp.

Generic Function: document-system-part (system part stream)
Package

tinaa.

Source

api.lisp.

Generic Reader: document? (object)
Package

tinaa.

Methods
Reader Method: document? ((subpart-kind subpart-kind))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

document?.

Reader Method: document? ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

document?.

Generic Writer: (setf document?) (object)
Package

tinaa.

Methods
Writer Method: (setf document?) ((basic-doclisp-part basic-doclisp-part))

automatically generated writer method

Source

class-defs.lisp.

Target Slot

document?.

Generic Function: documentation-exists-p (part mode)
Package

tinaa.

Source

api.lisp.

Methods
Method: documentation-exists-p ((part doclisp-variable) (mode (eql :detail)))
Source

doc-variable.lisp.

Method: documentation-exists-p (part mode)
Source

class-defs.lisp.

Generic Function: edge-kinds-for-part-graph (writer root part)
Package

tinaa.

Methods
Method: edge-kinds-for-part-graph (writer (root doclisp-asdf-system) (part doclisp-class))
Source

graph-parts.lisp.

Method: edge-kinds-for-part-graph (writer (root doclisp-asdf-system) (part doclisp-asdf-system))
Source

graph-parts.lisp.

Method: edge-kinds-for-part-graph (writer root part)
Source

graph-parts.lisp.

Generic Reader: enough-filename (object)
Package

tinaa.

Methods
Reader Method: enough-filename ((doclisp-file doclisp-file))

automatically generated reader method

Source

doc-asdf-system.lisp.

Target Slot

enough-filename.

Generic Reader: filename (object)
Package

tinaa.

Methods
Reader Method: filename ((doclisp-file doclisp-file))

automatically generated reader method

Source

doc-asdf-system.lisp.

Target Slot

filename.

Generic Function: find-part (ancester kind name)

Returns a existing part if it can be found.

Package

tinaa.

Source

api.lisp.

Methods
Method: find-part ((part name-holder-mixin) kind name)
Source

tinaa.lisp.

Method: find-part (parent kind name)
Source

class-defs.lisp.

Generic Function: finish-grovel (part)
Package

tinaa.

Source

api.lisp.

Methods
Method: finish-grovel ((part doclisp-assembly))
Source

tinaa.lisp.

Method: finish-grovel ((part basic-doclisp-part))
Source

tinaa.lisp.

Generic Reader: flag? (object)
Package

tinaa.

Methods
Reader Method: flag? ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

flag?.

Generic Writer: (setf flag?) (object)
Package

tinaa.

Methods
Writer Method: (setf flag?) ((basic-doclisp-part basic-doclisp-part))

automatically generated writer method

Source

class-defs.lisp.

Target Slot

flag?.

Generic Function: graph-part-p (writer part)
Package

tinaa.

Source

graph-parts.lisp.

Methods
Method: graph-part-p (writer (part doclisp-class))
Method: graph-part-p (writer (part doclisp-asdf-system))
Method: graph-part-p (writer part)
Generic Function: grovel-part (part)
Package

tinaa.

Source

api.lisp.

Methods
Method: grovel-part ((main-part doclisp-assembly))
Source

tinaa.lisp.

Method: grovel-part ((part basic-doclisp-part))
Source

tinaa.lisp.

Generic Reader: header (object)
Package

tinaa.

Methods
Reader Method: header ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

header.

Generic Writer: (setf header) (object)
Package

tinaa.

Methods
Writer Method: (setf header) ((basic-doclisp-part basic-doclisp-part))

automatically generated writer method

Source

class-defs.lisp.

Target Slot

header.

Generic Reader: heading (object)
Package

tinaa.

Methods
Reader Method: heading ((subpart-kind subpart-kind))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

heading.

Generic Function: include-in-contents-p (part)
Package

tinaa.

Methods
Method: include-in-contents-p ((part name-holder-mixin))
Source

build-contents.lisp.

Method: include-in-contents-p (part)
Source

build-contents.lisp.

Generic Function: include-kind-in-index-p (part kind)

Returns true if part should include kind in it’s index.

Package

tinaa.

Source

api.lisp.

Methods
Method: include-kind-in-index-p ((part doclisp-package) kind)
Source

doc-package.lisp.

Method: include-kind-in-index-p ((part doclisp-package) (kind (eql method)))
Source

doc-package.lisp.

Method: include-kind-in-index-p ((part doclisp-package) (kind (eql symbol)))
Source

doc-package.lisp.

Method: include-kind-in-index-p ((part basic-doclisp-part) kind)
Source

tinaa.lisp.

Generic Function: index-kinds (part)

Returns a list describing what indexes to generate for this part. This list is a list of lists of subpart kinds. Each item in the list generates one index and the index will include all of these part kinds.

Package

tinaa.

Source

api.lisp.

Methods
Method: index-kinds ((part doclisp-asdf-system))
Source

doc-asdf-system.lisp.

Method: index-kinds ((part doclisp-package))
Source

doc-package.lisp.

Method: index-kinds ((part basic-doclisp-part))
Source

class-defs.lisp.

Method: index-kinds (part)
Generic Reader: index? (object)
Package

tinaa.

Methods
Reader Method: index? ((subpart-kind subpart-kind))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

index?.

Generic Reader: kind (condition)
Package

tinaa.

Methods
Reader Method: kind ((condition cannot-make-part))
Source

class-defs.lisp.

Target Slot

kind.

Reader Method: kind ((condition part-kind-unknown-error))
Source

class-defs.lisp.

Target Slot

kind.

Generic Reader: label (object)
Package

tinaa.

Methods
Reader Method: label ((tinaa-edge tinaa-edge))

automatically generated reader method

Source

graph-parts.lisp.

Target Slot

label.

Generic Function: layout-engine-for-part (writer part)
Package

tinaa.

Methods
Method: layout-engine-for-part (writer (part basic-doclisp-part))
Source

graph-parts.lisp.

Generic Function: layout-graph-to-file (graph layout-engine output-type output-base)
Package

tinaa.

Methods
Method: layout-graph-to-file (graph layout-engine output-type output-base)
Source

graph-parts.lisp.

Generic Reader: maintainer-mail (object)
Package

tinaa.

Methods
Reader Method: maintainer-mail ((doclisp-asdf-system doclisp-asdf-system))

automatically generated reader method

Source

doc-asdf-system.lisp.

Target Slot

maintainer-mail.

Generic Reader: maintainer-name (object)
Package

tinaa.

Methods
Reader Method: maintainer-name ((doclisp-asdf-system doclisp-asdf-system))

automatically generated reader method

Source

doc-asdf-system.lisp.

Target Slot

maintainer-name.

Package

tinaa.

Methods
Source

generate-output.lisp.

Package

tinaa.

Methods
Source

generate-output.lisp.

Generic Function: make-part-graph (writer part)
Package

tinaa.

Methods
Method: make-part-graph (writer (part doclisp-class))
Source

graph-parts.lisp.

Method: make-part-graph (writer (part doclisp-asdf-system))
Source

graph-parts.lisp.

Generic Function: make-root-pointing-url (part name)
Package

tinaa.

Methods
Method: make-root-pointing-url ((part basic-doclisp-part) name)
Source

files-and-urls.lisp.

Method: make-root-pointing-url ((part (eql nil)) name)
Source

files-and-urls.lisp.

Generic Function: make-system-part (system part-kind part-name &key)
Package

tinaa.

Source

api.lisp.

Generic Function: maybe-show-documentation (part)
Package

tinaa.

Methods
Method: maybe-show-documentation :before ((part doclisp-package))
Source

doc-package.lisp.

Method: maybe-show-documentation ((part basic-doclisp-part))
Source

generate-output.lisp.

Generic Function: name-holder (object)
Package

tinaa.

Methods
Method: name-holder ((part name-holder-mixin))
Source

tinaa.lisp.

Method: name-holder ((part (eql nil)))
Source

tinaa.lisp.

Reader Method: name-holder ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

name-holder.

Generic Function: output-table-summary-of-parts (writer part subpart-name heading)
Package

tinaa.

Source

api.lisp.

Methods
Method: output-table-summary-of-parts (writer part (subpart-name (eql tinaa::other-file)) heading)
Source

doc-asdf-system.lisp.

Method: output-table-summary-of-parts (writer part subpart-name heading)
Source

generate-output.lisp.

Generic Reader: page-writer (object)
Package

tinaa.

Methods
Reader Method: page-writer ((doclisp-assembly doclisp-assembly))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

page-writer.

Generic Reader: page-writer-class (object)
Package

tinaa.

Methods
Reader Method: page-writer-class ((doclisp-assembly doclisp-assembly))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

page-writer-class.

Generic Reader: part (object)
Package

tinaa.

Methods
Reader Method: part ((tinaa-part-vertex tinaa-part-vertex))

automatically generated reader method

Source

doc-class.lisp.

Target Slot

part.

Generic Reader: part-kind (object)
Package

tinaa.

Methods
Reader Method: part-kind ((subpart-kind subpart-kind))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

part-kind.

Reader Method: part-kind ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

part-kind.

Generic Function: part-kind-abbreviation (part)
Package

tinaa.

Methods
Method: part-kind-abbreviation (part)
Source

permuted-index.lisp.

Generic Function: part-name (part)

Returns the name of the part as a string

Package

tinaa.

Source

api.lisp.

Methods
Method: part-name ((part doclisp-file))
Source

doc-asdf-system.lisp.

Method: part-name ((part doclisp-function))
Source

doc-function.lisp.

Method: part-name ((part basic-doclisp-part))
Source

tinaa.lisp.

Generic Reader: part-type (object)
Package

tinaa.

Methods
Reader Method: part-type ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

part-type.

Generic Reader: reason (condition)
Package

tinaa.

Methods
Reader Method: reason ((condition cannot-make-part))
Source

class-defs.lisp.

Target Slot

reason.

Generic Reader: root-part (object)
Package

tinaa.

Methods
Reader Method: root-part ((tinaa-part-graph tinaa-part-graph))

automatically generated reader method

Source

doc-class.lisp.

Target Slot

root-part.

Generic Function: short-documentation (part)

Returns the first bit of the documentation for part.
Change *short-documentation-length* to determine how much is returned.

Package

tinaa.

Source

api.lisp.

Methods
Method: short-documentation ((part doclisp-asdf-system))
Source

doc-asdf-system.lisp.

Method: short-documentation ((part basic-doclisp-part))
Source

tinaa.lisp.

Generic Function: show-part-parents (part)

Generate HTML to show the parents of a part. Called for a part only when it actually has parents (using an around method).

Package

tinaa.

Source

api.lisp.

Methods
Method: show-part-parents ((part basic-doclisp-part))
Source

generate-output.lisp.

Method: show-part-parents :around ((part basic-doclisp-part))
Source

generate-output.lisp.

Generic Function: span-class-for-part-name (name-holder part)

Returns the class to be used when displaying the part’s name.

Package

tinaa.

Source

api.lisp.

Methods
Method: span-class-for-part-name ((name-holder doclisp-package) (part doclisp-symbol))
Source

doc-symbol.lisp.

Method: span-class-for-part-name (name-holder (part basic-doclisp-part))
Source

class-defs.lisp.

Generic Function: start-grovel (part)
Package

tinaa.

Methods
Method: start-grovel :before ((part doclisp-package))
Source

doc-package.lisp.

Method: start-grovel ((part basic-doclisp-part))
Source

tinaa.lisp.

Generic Function: string->html (string &optional max-length)
Package

tinaa.

Methods
Method: string->html ((string string) &optional max-length)
Source

utilities.lisp.

Method: string->html (string &optional max-length)
Source

utilities.lisp.

Generic Reader: subparts (object)
Package

tinaa.

Methods
Reader Method: subparts ((doclisp-assembly doclisp-assembly))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

subparts.

Generic Reader: symbol-kinds (object)
Package

tinaa.

Methods
Reader Method: symbol-kinds ((doclisp-package doclisp-package))

automatically generated reader method

Source

doc-package.lisp.

Target Slot

symbol-kinds.

Generic Writer: (setf symbol-kinds) (object)
Package

tinaa.

Methods
Writer Method: (setf symbol-kinds) ((doclisp-package doclisp-package))

automatically generated writer method

Source

doc-package.lisp.

Target Slot

symbol-kinds.

Generic Reader: system (object)
Package

tinaa.

Methods
Reader Method: system ((doclisp-file doclisp-file))

automatically generated reader method

Source

doc-asdf-system.lisp.

Target Slot

system.

Generic Function: system-files (part system-closure?)
Package

tinaa.

Methods
Method: system-files ((part doclisp-asdf-system) system-closure?)
Source

doc-asdf-system.lisp.

Method: system-files ((part symbol) system-closure?)
Source

doc-asdf-system.lisp.

Generic Reader: url (object)
Package

tinaa.

Methods
Reader Method: url ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Source

class-defs.lisp.

Target Slot

url.

Generic Writer: (setf url) (object)
Package

tinaa.

Methods
Writer Method: (setf url) ((basic-doclisp-part basic-doclisp-part))

automatically generated writer method

Source

class-defs.lisp.

Target Slot

url.

Generic Function: url-for-part (part)

Returns the url for the part, creating it if necessary.

Package

tinaa.

Source

api.lisp.

Methods
Method: url-for-part ((part name-holder-mixin))
Source

files-and-urls.lisp.

Method: url-for-part ((part basic-doclisp-part))
Source

files-and-urls.lisp.


5.2.5 Standalone methods

Reader Method: name ((condition cannot-make-part))
Package

metabang.utilities.

Source

class-defs.lisp.

Target Slot

name.

Reader Method: name ((basic-doclisp-part basic-doclisp-part))

automatically generated reader method

Package

metabang.utilities.

Source

class-defs.lisp.

Target Slot

name.

Reader Method: name ((condition part-kind-unknown-error))
Package

metabang.utilities.

Source

class-defs.lisp.

Target Slot

name.

Reader Method: name ((subpart-kind subpart-kind))

automatically generated reader method

Package

metabang.utilities.

Source

class-defs.lisp.

Target Slot

name.


5.2.6 Conditions

Condition: part-kind-unknown-error
Package

tinaa.

Source

class-defs.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: parent
Package

metabang.utilities.

Initargs

:parent

Readers

parent.

Writers

This slot is read-only.

Slot: kind
Initargs

:kind

Readers

kind.

Writers

This slot is read-only.

Slot: name
Package

metabang.utilities.

Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: args
Initargs

:args

Readers

args.

Writers

This slot is read-only.


5.2.7 Classes

Class: basic-doclisp-part
Package

tinaa.

Source

class-defs.lisp.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:header
Direct slots
Slot: name
Package

metabang.utilities.

Initform

""

Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: parents
Initargs

:parents

Readers

parents.

Writers

(setf parents).

Slot: instance

An instance of this part.

Initargs

:instance

Readers

instance.

Writers

This slot is read-only.

Slot: url
Readers

url.

Writers

(setf url).

Slot: flag?
Readers

flag?.

Writers

(setf flag?).

Slot: document?
Initargs

:document?

Readers

document?.

Writers

(setf document?).

Slot: header
Initform

""

Initargs

:header

Readers

header.

Writers

(setf header).

Slot: part-kind
Initform

""

Initargs

:part-kind

Readers

part-kind.

Writers

This slot is read-only.

Slot: name-holder
Initargs

:name-holder

Readers

name-holder.

Writers

This slot is read-only.

Slot: part-type
Initargs

:part-type

Readers

part-type.

Writers

This slot is read-only.

Class: basic-page-writer
Package

tinaa.

Source

class-defs.lisp.

Direct subclasses

simple-page-writer.

Direct methods
Direct slots
Slot: css-file
Initargs

:css-file

Readers

css-file.

Writers

(setf css-file).

Class: direct-dependency-edge
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses

tinaa-edge.

Class: direct-package-edge
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses

tinaa-edge.

Direct methods

edge->dot.

Class: doclisp-asdf-system
Package

tinaa.

Source

doc-asdf-system.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:headerasdf system
:part-kindasdf-system
:document?t
:part-type(quote asdf-system)
Direct slots
Slot: author-name
Readers

author-name.

Writers

This slot is read-only.

Slot: author-mail
Readers

author-mail.

Writers

This slot is read-only.

Slot: maintainer-name
Initargs

:maintainer-name

Readers

maintainer-name.

Writers

This slot is read-only.

Slot: maintainer-mail
Initargs

:maintainer-mail

Readers

maintainer-mail.

Writers

This slot is read-only.

Class: doclisp-class
Package

tinaa.

Source

doc-class.lisp.

Direct superclasses

doclisp-assembly.

Direct subclasses

doclisp-condition.

Direct methods
Direct Default Initargs
InitargValue
:headerclass
:part-kindclass
:part-type(quote class)
Class: doclisp-condition
Package

tinaa.

Source

doc-class.lisp.

Direct superclasses

doclisp-class.

Direct methods
Direct Default Initargs
InitargValue
:headercondition
:part-kindcondition
:part-type(quote condition)
Class: doclisp-constant
Package

tinaa.

Source

doc-variable.lisp.

Direct superclasses

doclisp-variable.

Direct Default Initargs
InitargValue
:headerconstant
:part-kindconstant
:part-type(quote constant)
Class: doclisp-file
Package

tinaa.

Source

doc-asdf-system.lisp.

Direct superclasses

basic-doclisp-part.

Direct methods
Direct Default Initargs
InitargValue
:headerfile
:part-kindfile
:document?t
:part-type(quote file)
Direct slots
Slot: system
Initargs

:system

Readers

system.

Writers

This slot is read-only.

Slot: filename
Initargs

:filename

Readers

filename.

Writers

This slot is read-only.

Slot: enough-filename
Initargs

:enough-filename

Readers

enough-filename.

Writers

This slot is read-only.

Class: doclisp-function
Package

tinaa.

Source

doc-function.lisp.

Direct superclasses

doclisp-part.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:headerfunction
:part-kindfunction
:part-type(quote function)
Class: doclisp-generic-function
Package

tinaa.

Source

doc-function.lisp.

Direct superclasses

doclisp-function.

Direct methods

display-part.

Direct Default Initargs
InitargValue
:headergeneric function
:part-kindgeneric function
:part-type(quote generic-function)
Class: doclisp-macro
Package

tinaa.

Source

doc-function.lisp.

Direct superclasses

doclisp-function.

Direct Default Initargs
InitargValue
:headermacro
:part-kindmacro
:part-type(quote macro)
Class: doclisp-method
Package

tinaa.

Source

doc-function.lisp.

Direct superclasses

doclisp-function.

Direct methods

display-part.

Direct Default Initargs
InitargValue
:headermethod
:part-kindmethod
:part-type(quote method)
Class: doclisp-package
Package

tinaa.

Source

doc-package.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:headerpackage
:part-kindpackage
:document?t
:part-type(quote package)
Direct slots
Slot: symbol-kinds
Initform

(list :internal :external)

Initargs

:symbol-kinds

Readers

symbol-kinds.

Writers

(setf symbol-kinds).

Class: doclisp-slot
Package

tinaa.

Source

doc-class.lisp.

Direct superclasses

doclisp-part.

Direct methods
Direct Default Initargs
InitargValue
:headerslot
:part-kindslot
:part-type(quote slot)
Direct slots
Slot: direct-parent
Writers

(setf direct-parent).

Class: doclisp-symbol
Package

tinaa.

Source

doc-symbol.lisp.

Direct superclasses

doclisp-part.

Direct methods
Direct Default Initargs
InitargValue
:headersymbol
:part-kindsymbol
:part-type(quote symbol)
Class: doclisp-variable
Package

tinaa.

Source

doc-variable.lisp.

Direct superclasses

doclisp-part.

Direct subclasses

doclisp-constant.

Direct methods
Direct Default Initargs
InitargValue
:headervariable
:part-kindvariable
:part-type(quote variable)
Class: name-holder-mixin
Package

tinaa.

Source

class-defs.lisp.

Direct subclasses
Direct methods
Class: other-dependency-edge
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses

tinaa-edge.

Class: other-package-edge
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses

tinaa-edge.

Class: page-writer-with-graphs
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses

simple-page-writer.

Direct methods

build-documentation.

Class: simple-page-writer
Package

tinaa.

Source

class-defs.lisp.

Direct superclasses

basic-page-writer.

Direct subclasses

page-writer-with-graphs.

Direct methods
Class: subpart-kind
Package

tinaa.

Source

class-defs.lisp.

Direct methods
Direct slots
Slot: name
Package

metabang.utilities.

Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: part-kind
Initargs

:part-kind

Readers

part-kind.

Writers

This slot is read-only.

Slot: heading
Initargs

:heading

Readers

heading.

Writers

This slot is read-only.

Slot: document?
Initform

t

Initargs

:document?

Readers

document?.

Writers

This slot is read-only.

Slot: index?
Initform

t

Initargs

:index?

Readers

index?.

Writers

This slot is read-only.

Class: tinaa-asdf-system-vertex
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses

tinaa-vertex.

Class: tinaa-edge
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses

dot-directed-edge.

Direct subclasses
Direct methods

label.

Direct slots
Slot: label
Initform

""

Initargs

:label

Readers

label.

Writers

This slot is read-only.

Class: tinaa-graph
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses
  • dot-graph-mixin.
  • graph-container.
Direct Default Initargs
InitargValue
:default-edge-class(quote tinaa-edge)
:dot-attributes(quasiquote (size (#s(comma :expr *graph-size-in-inches* :kind 0) #s(comma :expr *graph-size-in-inches* :kind 0))))
Class: tinaa-package-vertex
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses

tinaa-vertex.

Direct methods

vertex->dot.

Class: tinaa-part-graph
Package

tinaa.

Source

doc-class.lisp.

Direct superclasses

graph-container.

Direct methods

root-part.

Direct Default Initargs
InitargValue
:vertex-class(quote tinaa-part-vertex)
Direct slots
Slot: root-part
Initargs

:root-part

Readers

root-part.

Writers

This slot is read-only.

Class: tinaa-part-vertex
Package

tinaa.

Source

doc-class.lisp.

Direct superclasses

graph-container-vertex.

Direct methods

part.

Direct slots
Slot: part
Initargs

:part

Readers

part.

Writers

This slot is read-only.

Class: tinaa-vertex
Package

tinaa.

Source

graph-parts.lisp.

Direct superclasses
  • dot-vertex.
  • graph-container-vertex.
Direct subclasses

Appendix A Indexes


A.1 Concepts


A.2 Functions

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

(
(setf css-file): Private generic functions
(setf css-file): Private generic functions
(setf direct-parent): Private generic functions
(setf direct-parent): Private generic functions
(setf document?): Private generic functions
(setf document?): Private generic functions
(setf flag?): Private generic functions
(setf flag?): Private generic functions
(setf header): Private generic functions
(setf header): Private generic functions
(setf parents): Public generic functions
(setf parents): Public generic functions
(setf symbol-kinds): Private generic functions
(setf symbol-kinds): Private generic functions
(setf url): Private generic functions
(setf url): Private generic functions

A
add-contents-link: Private generic functions
add-contents-link: Private generic functions
add-contents-link: Private generic functions
add-package-to-document: Private ordinary functions
add-part-vertex: Private generic functions
add-part-vertex: Private generic functions
add-part-vertex: Private generic functions
add-part-vertex: Private generic functions
add-tinaa-link: Private ordinary functions
any-indexes-p: Private ordinary functions
args: Private generic functions
args: Private generic functions
author-mail: Private generic functions
author-mail: Private generic functions
author-name: Private generic functions
author-name: Private generic functions

B
build-contents-page: Private generic functions
build-contents-page: Private generic functions
build-documentation: Private generic functions
build-documentation: Private generic functions
build-documentation: Private generic functions
build-documentation: Private generic functions
build-index: Private ordinary functions
build-index-letters: Private ordinary functions
build-index-links: Private generic functions
build-index-links: Private generic functions
build-index-links: Private generic functions
build-indexes: Private generic functions
build-indexes: Private generic functions
build-indexes: Private generic functions
build-license-page: Private ordinary functions
build-part-graph: Private ordinary functions
build-permuted-index: Private ordinary functions

C
canonical-package-id: Private ordinary functions
class-graph->dot: Private ordinary functions
class-sorter: Private ordinary functions
class-uninteresting-p: Private ordinary functions
conditionp: Private ordinary functions
content-things-from-part: Private ordinary functions
css-file: Private generic functions
css-file: Private generic functions
css-file-for-writer: Private generic functions
css-file-for-writer: Private generic functions

D
depth-for-part: Private generic functions
depth-for-part: Private generic functions
direct-instance: Private generic functions
direct-instance: Private generic functions
direct-parent: Private generic functions
direct-parent: Private generic functions
display-arguments: Private ordinary functions
display-function: Private ordinary functions
display-list-of-potential-parts: Private ordinary functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part: Public generic functions
display-part-for-index: Private ordinary functions
doclisp-footer: Private generic functions
doclisp-footer: Private generic functions
doclisp-header: Private generic functions
doclisp-header: Private generic functions
doclisp-header: Private generic functions
document-part-p: Private generic functions
document-part-p: Private generic functions
document-part-p: Private generic functions
document-part-p: Private generic functions
document-part-to-file: Private generic functions
document-part-to-file: Private generic functions
document-part-to-file: Private generic functions
document-system: Public ordinary functions
document-system-part: Private generic functions
document?: Private generic functions
document?: Private generic functions
document?: Private generic functions
documentation-exists-p: Private generic functions
documentation-exists-p: Private generic functions
documentation-exists-p: Private generic functions
documenting: Private macros
documenting-page: Private macros

E
edge->dot: Public standalone methods
edge-kinds-for-part-graph: Private generic functions
edge-kinds-for-part-graph: Private generic functions
edge-kinds-for-part-graph: Private generic functions
edge-kinds-for-part-graph: Private generic functions
enough-filename: Private generic functions
enough-filename: Private generic functions

F
file-depth-below-root: Private ordinary functions
filename: Private generic functions
filename: Private generic functions
filtered-package-symbols: Private ordinary functions
find-name-and-email: Private ordinary functions
find-part: Private generic functions
find-part: Private generic functions
find-part: Private generic functions
finish-grovel: Private generic functions
finish-grovel: Private generic functions
finish-grovel: Private generic functions
flag?: Private generic functions
flag?: Private generic functions
Function, add-package-to-document: Private ordinary functions
Function, add-tinaa-link: Private ordinary functions
Function, any-indexes-p: Private ordinary functions
Function, build-index: Private ordinary functions
Function, build-index-letters: Private ordinary functions
Function, build-license-page: Private ordinary functions
Function, build-part-graph: Private ordinary functions
Function, build-permuted-index: Private ordinary functions
Function, canonical-package-id: Private ordinary functions
Function, class-graph->dot: Private ordinary functions
Function, class-sorter: Private ordinary functions
Function, class-uninteresting-p: Private ordinary functions
Function, conditionp: Private ordinary functions
Function, content-things-from-part: Private ordinary functions
Function, display-arguments: Private ordinary functions
Function, display-function: Private ordinary functions
Function, display-list-of-potential-parts: Private ordinary functions
Function, display-part-for-index: Private ordinary functions
Function, document-system: Public ordinary functions
Function, file-depth-below-root: Private ordinary functions
Function, filtered-package-symbols: Private ordinary functions
Function, find-name-and-email: Private ordinary functions
Function, graph-file-name-for-part: Private ordinary functions
Function, ignore-package-p: Private ordinary functions
Function, index-file-name: Private ordinary functions
Function, index-for-kind-p: Private ordinary functions
Function, index-part-p: Private ordinary functions
Function, interesting-subclasses: Private ordinary functions
Function, interesting-superclasses: Private ordinary functions
Function, lml-insert-file: Private ordinary functions
Function, local-index-url: Private ordinary functions
Function, make-local-class-graph: Private ordinary functions
Function, make-string-of-size: Private ordinary functions
Function, map-parts-from-leaves: Private ordinary functions
Function, map-subpart-kinds: Private ordinary functions
Function, maybe-display-part: Private ordinary functions
Function, method-sorter: Private ordinary functions
Function, nice-package-name: Private ordinary functions
Function, ns-tlp: Private ordinary functions
Function, output-table-summary: Private ordinary functions
Function, packages-to-document: Private ordinary functions
Function, packages-to-ignore: Private ordinary functions
Function, part-can-have-documention-p: Private ordinary functions
Function, part-has-parents-p: Private ordinary functions
Function, part-symbol-name: Private ordinary functions
Function, parts-matching-symbol: Private ordinary functions
Function, parts-with-no-documentation: Private ordinary functions
Function, pathname->unix: Private ordinary functions
Function, permuted-index-delimiter-p: Private ordinary functions
Function, permuted-index-locations: Private ordinary functions
Function, princ-n-spaces: Private ordinary functions
Function, relative-url: Private ordinary functions
Function, root-parent: Private ordinary functions
Function, set-flags: Private ordinary functions
Function, slot-writer-name: Private ordinary functions
Function, some-parent: Private ordinary functions
Function, stylesheet-url: Private ordinary functions
Function, subpart-info: Private ordinary functions
Function, symbol-count: Private ordinary functions
Function, symbol-name-tree: Private ordinary functions
Function, system-packages: Private ordinary functions
Function, tinaa-home: Private ordinary functions
Function, update-document-part-p: Private ordinary functions
Function, url->file: Private ordinary functions
Function, url-name: Private ordinary functions
Function, write-css-file: Private ordinary functions
Function, write-part-graph: Private ordinary functions

G
Generic Function, (setf css-file): Private generic functions
Generic Function, (setf direct-parent): Private generic functions
Generic Function, (setf document?): Private generic functions
Generic Function, (setf flag?): Private generic functions
Generic Function, (setf header): Private generic functions
Generic Function, (setf parents): Public generic functions
Generic Function, (setf symbol-kinds): Private generic functions
Generic Function, (setf url): Private generic functions
Generic Function, add-contents-link: Private generic functions
Generic Function, add-part-vertex: Private generic functions
Generic Function, args: Private generic functions
Generic Function, author-mail: Private generic functions
Generic Function, author-name: Private generic functions
Generic Function, build-contents-page: Private generic functions
Generic Function, build-documentation: Private generic functions
Generic Function, build-index-links: Private generic functions
Generic Function, build-indexes: Private generic functions
Generic Function, css-file: Private generic functions
Generic Function, css-file-for-writer: Private generic functions
Generic Function, depth-for-part: Private generic functions
Generic Function, direct-instance: Private generic functions
Generic Function, direct-parent: Private generic functions
Generic Function, display-part: Public generic functions
Generic Function, doclisp-footer: Private generic functions
Generic Function, doclisp-header: Private generic functions
Generic Function, document-part-p: Private generic functions
Generic Function, document-part-to-file: Private generic functions
Generic Function, document-system-part: Private generic functions
Generic Function, document?: Private generic functions
Generic Function, documentation-exists-p: Private generic functions
Generic Function, edge-kinds-for-part-graph: Private generic functions
Generic Function, enough-filename: Private generic functions
Generic Function, filename: Private generic functions
Generic Function, find-part: Private generic functions
Generic Function, finish-grovel: Private generic functions
Generic Function, flag?: Private generic functions
Generic Function, graph-part-p: Private generic functions
Generic Function, grovel-part: Private generic functions
Generic Function, header: Private generic functions
Generic Function, heading: Private generic functions
Generic Function, include-in-contents-p: Private generic functions
Generic Function, include-kind-in-index-p: Private generic functions
Generic Function, index-kinds: Private generic functions
Generic Function, index?: Private generic functions
Generic Function, instance: Public generic functions
Generic Function, kind: Private generic functions
Generic Function, label: Private generic functions
Generic Function, layout-engine-for-part: Private generic functions
Generic Function, layout-graph-to-file: Private generic functions
Generic Function, maintainer-mail: Private generic functions
Generic Function, maintainer-name: Private generic functions
Generic Function, make-link-for: Private generic functions
Generic Function, make-name-link-for: Private generic functions
Generic Function, make-part: Public generic functions
Generic Function, make-part-graph: Private generic functions
Generic Function, make-root-pointing-url: Private generic functions
Generic Function, make-system-part: Private generic functions
Generic Function, maybe-show-documentation: Private generic functions
Generic Function, name-holder: Private generic functions
Generic Function, output-table-summary-of-parts: Private generic functions
Generic Function, page-writer: Private generic functions
Generic Function, page-writer-class: Private generic functions
Generic Function, parents: Public generic functions
Generic Function, part: Private generic functions
Generic Function, part-documentation: Public generic functions
Generic Function, part-kind: Private generic functions
Generic Function, part-kind-abbreviation: Private generic functions
Generic Function, part-name: Private generic functions
Generic Function, part-type: Private generic functions
Generic Function, partname-list: Public generic functions
Generic Function, reason: Private generic functions
Generic Function, root-part: Private generic functions
Generic Function, short-documentation: Private generic functions
Generic Function, show-part-parents: Private generic functions
Generic Function, span-class-for-part-name: Private generic functions
Generic Function, start-grovel: Private generic functions
Generic Function, string->html: Private generic functions
Generic Function, subpart-kinds: Public generic functions
Generic Function, subparts: Private generic functions
Generic Function, symbol-kinds: Private generic functions
Generic Function, system: Private generic functions
Generic Function, system-files: Private generic functions
Generic Function, url: Private generic functions
Generic Function, url-for-part: Private generic functions
graph-file-name-for-part: Private ordinary functions
graph-part-p: Private generic functions
graph-part-p: Private generic functions
graph-part-p: Private generic functions
graph-part-p: Private generic functions
grovel-part: Private generic functions
grovel-part: Private generic functions
grovel-part: Private generic functions

H
header: Private generic functions
header: Private generic functions
heading: Private generic functions
heading: Private generic functions

I
ignore-package-p: Private ordinary functions
include-in-contents-p: Private generic functions
include-in-contents-p: Private generic functions
include-in-contents-p: Private generic functions
include-kind-in-index-p: Private generic functions
include-kind-in-index-p: Private generic functions
include-kind-in-index-p: Private generic functions
include-kind-in-index-p: Private generic functions
include-kind-in-index-p: Private generic functions
index-file-name: Private ordinary functions
index-for-kind-p: Private ordinary functions
index-kinds: Private generic functions
index-kinds: Private generic functions
index-kinds: Private generic functions
index-kinds: Private generic functions
index-kinds: Private generic functions
index-part-p: Private ordinary functions
index?: Private generic functions
index?: Private generic functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
instance: Public generic functions
instance: Public generic functions
interesting-subclasses: Private ordinary functions
interesting-superclasses: Private ordinary functions

K
kind: Private generic functions
kind: Private generic functions
kind: Private generic functions

L
label: Private generic functions
label: Private generic functions
layout-engine-for-part: Private generic functions
layout-engine-for-part: Private generic functions
layout-graph-to-file: Private generic functions
layout-graph-to-file: Private generic functions
lml-insert-file: Private ordinary functions
local-index-url: Private ordinary functions

M
Macro, documenting: Private macros
Macro, documenting-page: Private macros
Macro, with-html-output: Private macros
maintainer-mail: Private generic functions
maintainer-mail: Private generic functions
maintainer-name: Private generic functions
maintainer-name: Private generic functions
make-link-for: Private generic functions
make-link-for: Private generic functions
make-local-class-graph: Private ordinary functions
make-name-link-for: Private generic functions
make-name-link-for: Private generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part: Public generic functions
make-part-graph: Private generic functions
make-part-graph: Private generic functions
make-part-graph: Private generic functions
make-root-pointing-url: Private generic functions
make-root-pointing-url: Private generic functions
make-root-pointing-url: Private generic functions
make-string-of-size: Private ordinary functions
make-system-part: Private generic functions
map-parts-from-leaves: Private ordinary functions
map-subpart-kinds: Private ordinary functions
maybe-display-part: Private ordinary functions
maybe-show-documentation: Private generic functions
maybe-show-documentation: Private generic functions
maybe-show-documentation: Private generic functions
Method, (setf css-file): Private generic functions
Method, (setf direct-parent): Private generic functions
Method, (setf document?): Private generic functions
Method, (setf flag?): Private generic functions
Method, (setf header): Private generic functions
Method, (setf parents): Public generic functions
Method, (setf symbol-kinds): Private generic functions
Method, (setf url): Private generic functions
Method, add-contents-link: Private generic functions
Method, add-contents-link: Private generic functions
Method, add-part-vertex: Private generic functions
Method, add-part-vertex: Private generic functions
Method, add-part-vertex: Private generic functions
Method, args: Private generic functions
Method, author-mail: Private generic functions
Method, author-name: Private generic functions
Method, build-contents-page: Private generic functions
Method, build-documentation: Private generic functions
Method, build-documentation: Private generic functions
Method, build-documentation: Private generic functions
Method, build-index-links: Private generic functions
Method, build-index-links: Private generic functions
Method, build-indexes: Private generic functions
Method, build-indexes: Private generic functions
Method, css-file: Private generic functions
Method, css-file-for-writer: Private generic functions
Method, depth-for-part: Private generic functions
Method, direct-instance: Private generic functions
Method, direct-parent: Private generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, display-part: Public generic functions
Method, doclisp-footer: Private generic functions
Method, doclisp-header: Private generic functions
Method, doclisp-header: Private generic functions
Method, document-part-p: Private generic functions
Method, document-part-p: Private generic functions
Method, document-part-p: Private generic functions
Method, document-part-to-file: Private generic functions
Method, document-part-to-file: Private generic functions
Method, document?: Private generic functions
Method, document?: Private generic functions
Method, documentation-exists-p: Private generic functions
Method, documentation-exists-p: Private generic functions
Method, edge->dot: Public standalone methods
Method, edge-kinds-for-part-graph: Private generic functions
Method, edge-kinds-for-part-graph: Private generic functions
Method, edge-kinds-for-part-graph: Private generic functions
Method, enough-filename: Private generic functions
Method, filename: Private generic functions
Method, find-part: Private generic functions
Method, find-part: Private generic functions
Method, finish-grovel: Private generic functions
Method, finish-grovel: Private generic functions
Method, flag?: Private generic functions
Method, graph-part-p: Private generic functions
Method, graph-part-p: Private generic functions
Method, graph-part-p: Private generic functions
Method, grovel-part: Private generic functions
Method, grovel-part: Private generic functions
Method, header: Private generic functions
Method, heading: Private generic functions
Method, include-in-contents-p: Private generic functions
Method, include-in-contents-p: Private generic functions
Method, include-kind-in-index-p: Private generic functions
Method, include-kind-in-index-p: Private generic functions
Method, include-kind-in-index-p: Private generic functions
Method, include-kind-in-index-p: Private generic functions
Method, index-kinds: Private generic functions
Method, index-kinds: Private generic functions
Method, index-kinds: Private generic functions
Method, index-kinds: Private generic functions
Method, index?: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, instance: Public generic functions
Method, kind: Private generic functions
Method, kind: Private generic functions
Method, label: Private generic functions
Method, layout-engine-for-part: Private generic functions
Method, layout-graph-to-file: Private generic functions
Method, maintainer-mail: Private generic functions
Method, maintainer-name: Private generic functions
Method, make-link-for: Private generic functions
Method, make-name-link-for: Private generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part: Public generic functions
Method, make-part-graph: Private generic functions
Method, make-part-graph: Private generic functions
Method, make-root-pointing-url: Private generic functions
Method, make-root-pointing-url: Private generic functions
Method, maybe-show-documentation: Private generic functions
Method, maybe-show-documentation: Private generic functions
Method, name: Private standalone methods
Method, name: Private standalone methods
Method, name: Private standalone methods
Method, name: Private standalone methods
Method, name-holder: Private generic functions
Method, name-holder: Private generic functions
Method, name-holder: Private generic functions
Method, output-table-summary-of-parts: Private generic functions
Method, output-table-summary-of-parts: Private generic functions
Method, page-writer: Private generic functions
Method, page-writer-class: Private generic functions
Method, parent: Public standalone methods
Method, parent: Public standalone methods
Method, parents: Public generic functions
Method, part: Private generic functions
Method, part-documentation: Public generic functions
Method, part-documentation: Public generic functions
Method, part-documentation: Public generic functions
Method, part-documentation: Public generic functions
Method, part-documentation: Public generic functions
Method, part-documentation: Public generic functions
Method, part-documentation: Public generic functions
Method, part-documentation: Public generic functions
Method, part-kind: Private generic functions
Method, part-kind: Private generic functions
Method, part-kind-abbreviation: Private generic functions
Method, part-name: Private generic functions
Method, part-name: Private generic functions
Method, part-name: Private generic functions
Method, part-type: Private generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, partname-list: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, reason: Private generic functions
Method, root-part: Private generic functions
Method, short-documentation: Private generic functions
Method, short-documentation: Private generic functions
Method, show-part-parents: Private generic functions
Method, show-part-parents: Private generic functions
Method, span-class-for-part-name: Private generic functions
Method, span-class-for-part-name: Private generic functions
Method, start-grovel: Private generic functions
Method, start-grovel: Private generic functions
Method, string->html: Private generic functions
Method, string->html: Private generic functions
Method, subpart-kinds: Public generic functions
Method, subpart-kinds: Public generic functions
Method, subpart-kinds: Public generic functions
Method, subpart-kinds: Public generic functions
Method, subpart-kinds: Public generic functions
Method, subpart-kinds: Public generic functions
Method, subparts: Private generic functions
Method, symbol-kinds: Private generic functions
Method, system: Private generic functions
Method, system-files: Private generic functions
Method, system-files: Private generic functions
Method, url: Private generic functions
Method, url-for-part: Private generic functions
Method, url-for-part: Private generic functions
Method, vertex->dot: Public standalone methods
method-sorter: Private ordinary functions

N
name: Private standalone methods
name: Private standalone methods
name: Private standalone methods
name: Private standalone methods
name-holder: Private generic functions
name-holder: Private generic functions
name-holder: Private generic functions
name-holder: Private generic functions
nice-package-name: Private ordinary functions
ns-tlp: Private ordinary functions

O
output-table-summary: Private ordinary functions
output-table-summary-of-parts: Private generic functions
output-table-summary-of-parts: Private generic functions
output-table-summary-of-parts: Private generic functions

P
packages-to-document: Private ordinary functions
packages-to-ignore: Private ordinary functions
page-writer: Private generic functions
page-writer: Private generic functions
page-writer-class: Private generic functions
page-writer-class: Private generic functions
parent: Public standalone methods
parent: Public standalone methods
parents: Public generic functions
parents: Public generic functions
part: Private generic functions
part: Private generic functions
part-can-have-documention-p: Private ordinary functions
part-documentation: Public generic functions
part-documentation: Public generic functions
part-documentation: Public generic functions
part-documentation: Public generic functions
part-documentation: Public generic functions
part-documentation: Public generic functions
part-documentation: Public generic functions
part-documentation: Public generic functions
part-documentation: Public generic functions
part-has-parents-p: Private ordinary functions
part-kind: Private generic functions
part-kind: Private generic functions
part-kind: Private generic functions
part-kind-abbreviation: Private generic functions
part-kind-abbreviation: Private generic functions
part-name: Private generic functions
part-name: Private generic functions
part-name: Private generic functions
part-name: Private generic functions
part-symbol-name: Private ordinary functions
part-type: Private generic functions
part-type: Private generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
partname-list: Public generic functions
parts-matching-symbol: Private ordinary functions
parts-with-no-documentation: Private ordinary functions
pathname->unix: Private ordinary functions
permuted-index-delimiter-p: Private ordinary functions
permuted-index-locations: Private ordinary functions
princ-n-spaces: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods

R
reason: Private generic functions
reason: Private generic functions
relative-url: Private ordinary functions
root-parent: Private ordinary functions
root-part: Private generic functions
root-part: Private generic functions

S
set-flags: Private ordinary functions
short-documentation: Private generic functions
short-documentation: Private generic functions
short-documentation: Private generic functions
show-part-parents: Private generic functions
show-part-parents: Private generic functions
show-part-parents: Private generic functions
slot-writer-name: Private ordinary functions
some-parent: Private ordinary functions
span-class-for-part-name: Private generic functions
span-class-for-part-name: Private generic functions
span-class-for-part-name: Private generic functions
start-grovel: Private generic functions
start-grovel: Private generic functions
start-grovel: Private generic functions
string->html: Private generic functions
string->html: Private generic functions
string->html: Private generic functions
stylesheet-url: Private ordinary functions
subpart-info: Private ordinary functions
subpart-kinds: Public generic functions
subpart-kinds: Public generic functions
subpart-kinds: Public generic functions
subpart-kinds: Public generic functions
subpart-kinds: Public generic functions
subpart-kinds: Public generic functions
subpart-kinds: Public generic functions
subparts: Private generic functions
subparts: Private generic functions
symbol-count: Private ordinary functions
symbol-kinds: Private generic functions
symbol-kinds: Private generic functions
symbol-name-tree: Private ordinary functions
system: Private generic functions
system: Private generic functions
system-files: Private generic functions
system-files: Private generic functions
system-files: Private generic functions
system-packages: Private ordinary functions

T
tinaa-home: Private ordinary functions

U
update-document-part-p: Private ordinary functions
url: Private generic functions
url: Private generic functions
url->file: Private ordinary functions
url-for-part: Private generic functions
url-for-part: Private generic functions
url-for-part: Private generic functions
url-name: Private ordinary functions

V
vertex->dot: Public standalone methods

W
with-html-output: Private macros
write-css-file: Private ordinary functions
write-part-graph: Private ordinary functions


A.3 Variables

Jump to:   *  
A   C   D   E   F   H   I   K   L   M   N   P   R   S   U  
Index Entry  Section

*
*css-file*: Public special variables
*current-index*: Private special variables
*current-part*: Private special variables
*current-part-index*: Private special variables
*default-packages-to-ignore*: Private special variables
*document-file*: Private special variables
*document-root*: Private special variables
*document-stream*: Private special variables
*graph-image-format*: Private special variables
*graph-size-in-inches*: Private special variables
*graphviz-directory*: Private special variables
*make-part-methods*: Private special variables
*output-calls*: Private special variables
*packages-to-document*: Private special variables
*required-index-contents*: Private special variables
*root-part*: Private special variables
*short-documentation-length*: Private special variables
*tinaa-home-page*: Private special variables
*tinaa-version*: Private special variables

A
args: Private conditions
author-mail: Private classes
author-name: Private classes

C
css-file: Private classes

D
direct-parent: Private classes
document?: Private classes
document?: Private classes

E
enough-filename: Private classes

F
filename: Private classes
flag?: Private classes

H
header: Private classes
heading: Private classes

I
index?: Private classes
instance: Private classes

K
kind: Public conditions
kind: Private conditions

L
label: Private classes

M
maintainer-mail: Private classes
maintainer-name: Private classes

N
name: Public conditions
name: Private conditions
name: Private classes
name: Private classes
name-holder: Private classes

P
page-writer: Public classes
page-writer-class: Public classes
parent: Public conditions
parent: Private conditions
parents: Private classes
part: Private classes
part-kind: Private classes
part-kind: Private classes
part-type: Private classes

R
reason: Public conditions
root-part: Private classes

S
Slot, args: Private conditions
Slot, author-mail: Private classes
Slot, author-name: Private classes
Slot, css-file: Private classes
Slot, direct-parent: Private classes
Slot, document?: Private classes
Slot, document?: Private classes
Slot, enough-filename: Private classes
Slot, filename: Private classes
Slot, flag?: Private classes
Slot, header: Private classes
Slot, heading: Private classes
Slot, index?: Private classes
Slot, instance: Private classes
Slot, kind: Public conditions
Slot, kind: Private conditions
Slot, label: Private classes
Slot, maintainer-mail: Private classes
Slot, maintainer-name: Private classes
Slot, name: Public conditions
Slot, name: Private conditions
Slot, name: Private classes
Slot, name: Private classes
Slot, name-holder: Private classes
Slot, page-writer: Public classes
Slot, page-writer-class: Public classes
Slot, parent: Public conditions
Slot, parent: Private conditions
Slot, parents: Private classes
Slot, part: Private classes
Slot, part-kind: Private classes
Slot, part-kind: Private classes
Slot, part-type: Private classes
Slot, reason: Public conditions
Slot, root-part: Private classes
Slot, subparts: Public classes
Slot, symbol-kinds: Private classes
Slot, system: Private classes
Slot, url: Private classes
Special Variable, *css-file*: Public special variables
Special Variable, *current-index*: Private special variables
Special Variable, *current-part*: Private special variables
Special Variable, *current-part-index*: Private special variables
Special Variable, *default-packages-to-ignore*: Private special variables
Special Variable, *document-file*: Private special variables
Special Variable, *document-root*: Private special variables
Special Variable, *document-stream*: Private special variables
Special Variable, *graph-image-format*: Private special variables
Special Variable, *graph-size-in-inches*: Private special variables
Special Variable, *graphviz-directory*: Private special variables
Special Variable, *make-part-methods*: Private special variables
Special Variable, *output-calls*: Private special variables
Special Variable, *packages-to-document*: Private special variables
Special Variable, *required-index-contents*: Private special variables
Special Variable, *root-part*: Private special variables
Special Variable, *short-documentation-length*: Private special variables
Special Variable, *tinaa-home-page*: Private special variables
Special Variable, *tinaa-version*: Private special variables
subparts: Public classes
symbol-kinds: Private classes
system: Private classes

U
url: Private classes


A.4 Data types

Jump to:   A   B   C   D   E   F   G   I   M   N   O   P   S   T   U   W  
Index Entry  Section

A
api.lisp: The tinaa/dev/api․lisp file

B
basic-doclisp-part: Private classes
basic-page-writer: Private classes
build-contents.lisp: The tinaa/dev/build-contents․lisp file
build-indexes.lisp: The tinaa/dev/build-indexes․lisp file

C
cannot-make-part: Public conditions
Class, basic-doclisp-part: Private classes
Class, basic-page-writer: Private classes
Class, direct-dependency-edge: Private classes
Class, direct-package-edge: Private classes
Class, doclisp-asdf-system: Private classes
Class, doclisp-assembly: Public classes
Class, doclisp-class: Private classes
Class, doclisp-condition: Private classes
Class, doclisp-constant: Private classes
Class, doclisp-file: Private classes
Class, doclisp-function: Private classes
Class, doclisp-generic-function: Private classes
Class, doclisp-macro: Private classes
Class, doclisp-method: Private classes
Class, doclisp-package: Private classes
Class, doclisp-part: Public classes
Class, doclisp-slot: Private classes
Class, doclisp-symbol: Private classes
Class, doclisp-variable: Private classes
Class, name-holder-mixin: Private classes
Class, other-dependency-edge: Private classes
Class, other-package-edge: Private classes
Class, page-writer-with-graphs: Private classes
Class, simple-page-writer: Private classes
Class, subpart-kind: Private classes
Class, tinaa-asdf-system-vertex: Private classes
Class, tinaa-edge: Private classes
Class, tinaa-graph: Private classes
Class, tinaa-package-vertex: Private classes
Class, tinaa-part-graph: Private classes
Class, tinaa-part-vertex: Private classes
Class, tinaa-vertex: Private classes
class-defs.lisp: The tinaa/dev/class-defs․lisp file
Condition, cannot-make-part: Public conditions
Condition, part-kind-unknown-error: Private conditions

D
definitions.lisp: The tinaa/dev/definitions․lisp file
dev: The tinaa/dev module
direct-dependency-edge: Private classes
direct-package-edge: Private classes
doc-asdf-system.lisp: The tinaa/dev/doc-asdf-system․lisp file
doc-class.lisp: The tinaa/dev/doc-class․lisp file
doc-function.lisp: The tinaa/dev/doc-function․lisp file
doc-package.lisp: The tinaa/dev/doc-package․lisp file
doc-symbol.lisp: The tinaa/dev/doc-symbol․lisp file
doc-variable.lisp: The tinaa/dev/doc-variable․lisp file
doclisp-asdf-system: Private classes
doclisp-assembly: Public classes
doclisp-class: Private classes
doclisp-condition: Private classes
doclisp-constant: Private classes
doclisp-file: Private classes
doclisp-function: Private classes
doclisp-generic-function: Private classes
doclisp-macro: Private classes
doclisp-method: Private classes
doclisp-package: Private classes
doclisp-part: Public classes
doclisp-slot: Private classes
doclisp-symbol: Private classes
doclisp-variable: Private classes

E
epilogue.lisp: The tinaa/dev/epilogue․lisp file

F
File, api.lisp: The tinaa/dev/api․lisp file
File, build-contents.lisp: The tinaa/dev/build-contents․lisp file
File, build-indexes.lisp: The tinaa/dev/build-indexes․lisp file
File, class-defs.lisp: The tinaa/dev/class-defs․lisp file
File, definitions.lisp: The tinaa/dev/definitions․lisp file
File, doc-asdf-system.lisp: The tinaa/dev/doc-asdf-system․lisp file
File, doc-class.lisp: The tinaa/dev/doc-class․lisp file
File, doc-function.lisp: The tinaa/dev/doc-function․lisp file
File, doc-package.lisp: The tinaa/dev/doc-package․lisp file
File, doc-symbol.lisp: The tinaa/dev/doc-symbol․lisp file
File, doc-variable.lisp: The tinaa/dev/doc-variable․lisp file
File, epilogue.lisp: The tinaa/dev/epilogue․lisp file
File, files-and-urls.lisp: The tinaa/dev/files-and-urls․lisp file
File, generate-output.lisp: The tinaa/dev/generate-output․lisp file
File, graph-parts.lisp: The tinaa/dev/graph-parts․lisp file
File, index.md: The tinaa/website/source/index․md file
File, macros.lisp: The tinaa/dev/macros․lisp file
File, notes.text: The tinaa/dev/notes․text file
File, package.lisp: The tinaa/dev/package․lisp file
File, permuted-index.lisp: The tinaa/dev/permuted-index․lisp file
File, templates.lisp: The tinaa/dev/templates․lisp file
File, tinaa.asd: The tinaa/tinaa․asd file
File, tinaa.css: The tinaa/dev/tinaa․css file
File, tinaa.lisp: The tinaa/dev/tinaa․lisp file
File, utilities.lisp: The tinaa/dev/utilities․lisp file
files-and-urls.lisp: The tinaa/dev/files-and-urls․lisp file

G
generate-output.lisp: The tinaa/dev/generate-output․lisp file
graph-parts.lisp: The tinaa/dev/graph-parts․lisp file

I
index.md: The tinaa/website/source/index․md file

M
macros.lisp: The tinaa/dev/macros․lisp file
Module, dev: The tinaa/dev module
Module, source: The tinaa/website/source module
Module, website: The tinaa/website module

N
name-holder-mixin: Private classes
notes.text: The tinaa/dev/notes․text file

O
other-dependency-edge: Private classes
other-package-edge: Private classes

P
Package, tinaa: The tinaa package
package.lisp: The tinaa/dev/package․lisp file
page-writer-with-graphs: Private classes
part-kind-unknown-error: Private conditions
permuted-index.lisp: The tinaa/dev/permuted-index․lisp file

S
simple-page-writer: Private classes
source: The tinaa/website/source module
subpart-kind: Private classes
System, tinaa: The tinaa system

T
templates.lisp: The tinaa/dev/templates․lisp file
tinaa: The tinaa system
tinaa: The tinaa package
tinaa-asdf-system-vertex: Private classes
tinaa-edge: Private classes
tinaa-graph: Private classes
tinaa-package-vertex: Private classes
tinaa-part-graph: Private classes
tinaa-part-vertex: Private classes
tinaa-vertex: Private classes
tinaa.asd: The tinaa/tinaa․asd file
tinaa.css: The tinaa/dev/tinaa․css file
tinaa.lisp: The tinaa/dev/tinaa․lisp file

U
utilities.lisp: The tinaa/dev/utilities․lisp file

W
website: The tinaa/website module