This is the tinaa Reference Manual, version 0.5.11, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 06:37:56 2023 GMT+0.
tinaa/tinaa.asdtinaa/dev/package.lisptinaa/dev/class-defs.lisptinaa/dev/api.lisptinaa/dev/macros.lisptinaa/dev/utilities.lisptinaa/dev/definitions.lisptinaa/dev/files-and-urls.lisptinaa/dev/tinaa.lisptinaa/dev/generate-output.lisptinaa/dev/doc-package.lisptinaa/dev/doc-class.lisptinaa/dev/doc-variable.lisptinaa/dev/doc-function.lisptinaa/dev/doc-symbol.lisptinaa/dev/doc-asdf-system.lisptinaa/dev/build-indexes.lisptinaa/dev/permuted-index.lisptinaa/dev/build-contents.lisptinaa/dev/graph-parts.lisptinaa/dev/templates.lisptinaa/dev/epilogue.lispThe main system appears first, followed by any subsystem dependency.
tinaaGary Warren King <gwking@metabang.com>
Gary Warren King <gwking@metabang.com>
Basically BSD, see file COPYING for details
0.5.11
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"
Modules are listed depth-first from the system components tree.
tinaa/devtinaa (system).
package.lisp (file).
class-defs.lisp (file).
api.lisp (file).
macros.lisp (file).
utilities.lisp (file).
definitions.lisp (file).
files-and-urls.lisp (file).
tinaa.lisp (file).
generate-output.lisp (file).
doc-package.lisp (file).
doc-class.lisp (file).
doc-variable.lisp (file).
doc-function.lisp (file).
doc-symbol.lisp (file).
doc-asdf-system.lisp (file).
build-indexes.lisp (file).
permuted-index.lisp (file).
build-contents.lisp (file).
graph-parts.lisp (file).
templates.lisp (file).
epilogue.lisp (file).
notes.text (file).
tinaa.css (file).
Files are sorted by type and then listed depth-first from the systems components trees.
tinaa/tinaa.asdtinaa/dev/package.lisptinaa/dev/class-defs.lisptinaa/dev/api.lisptinaa/dev/macros.lisptinaa/dev/utilities.lisptinaa/dev/definitions.lisptinaa/dev/files-and-urls.lisptinaa/dev/tinaa.lisptinaa/dev/generate-output.lisptinaa/dev/doc-package.lisptinaa/dev/doc-class.lisptinaa/dev/doc-variable.lisptinaa/dev/doc-function.lisptinaa/dev/doc-symbol.lisptinaa/dev/doc-asdf-system.lisptinaa/dev/build-indexes.lisptinaa/dev/permuted-index.lisptinaa/dev/build-contents.lisptinaa/dev/graph-parts.lisptinaa/dev/templates.lisptinaa/dev/epilogue.lisptinaa/dev/class-defs.lisppackage.lisp (file).
api.lisp (file).
dev (module).
cannot-make-part (condition).
display-part (method).
doclisp-assembly (class).
doclisp-part (class).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
instance (reader method).
parent (reader method).
parent (reader method).
parents (reader method).
(setf parents) (writer method).
partname-list (method).
print-object (method).
args (reader method).
basic-doclisp-part (class).
basic-page-writer (class).
css-file (reader method).
(setf css-file) (writer method).
document? (reader method).
document? (reader method).
(setf document?) (writer method).
documentation-exists-p (method).
find-part (method).
flag? (reader method).
(setf flag?) (writer method).
header (reader method).
(setf header) (writer method).
heading (reader method).
index-kinds (method).
index? (reader method).
kind (reader method).
kind (reader method).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
name-holder (reader method).
name-holder-mixin (class).
page-writer (reader method).
page-writer-class (reader method).
part-kind (reader method).
part-kind (reader method).
part-kind-unknown-error (condition).
part-type (reader method).
reason (reader method).
simple-page-writer (class).
span-class-for-part-name (method).
subpart-kind (class).
subparts (reader method).
url (reader method).
(setf url) (writer method).
tinaa/dev/api.lisppackage.lisp (file).
dev (module).
display-part (generic function).
make-part (generic function).
part-documentation (generic function).
partname-list (generic function).
subpart-kinds (generic function).
build-index-links (generic function).
document-part-p (generic function).
document-part-to-file (generic function).
document-system-part (generic function).
documentation-exists-p (generic function).
find-part (generic function).
finish-grovel (generic function).
grovel-part (generic function).
include-kind-in-index-p (generic function).
index-kinds (generic function).
make-system-part (generic function).
output-table-summary-of-parts (generic function).
part-name (generic function).
short-documentation (generic function).
show-part-parents (generic function).
span-class-for-part-name (generic function).
url-for-part (generic function).
tinaa/dev/macros.lispapi.lisp (file).
package.lisp (file).
dev (module).
documenting (macro).
documenting-page (macro).
with-html-output (macro).
tinaa/dev/utilities.lispmacros.lisp (file).
dev (module).
display-arguments (function).
display-function (function).
lml-insert-file (function).
map-parts-from-leaves (function).
map-subpart-kinds (function).
set-flags (function).
string->html (method).
string->html (method).
tinaa/dev/definitions.lisppackage.lisp (file).
dev (module).
*css-file* (special variable).
*current-index* (special variable).
*current-part* (special variable).
*current-part-index* (special variable).
*default-packages-to-ignore* (special variable).
*document-file* (special variable).
*document-root* (special variable).
*document-stream* (special variable).
*output-calls* (special variable).
*packages-to-document* (special variable).
*root-part* (special variable).
*short-documentation-length* (special variable).
*tinaa-home-page* (special variable).
*tinaa-version* (special variable).
tinaa/dev/files-and-urls.lisppackage.lisp (file).
definitions.lisp (file).
dev (module).
add-contents-link (method).
add-contents-link (method).
file-depth-below-root (function).
make-root-pointing-url (method).
make-root-pointing-url (method).
relative-url (function).
stylesheet-url (function).
url->file (function).
url-for-part (method).
url-for-part (method).
tinaa/dev/tinaa.lispapi.lisp (file).
class-defs.lisp (file).
definitions.lisp (file).
dev (module).
display-part (method).
display-part (method).
make-part (method).
make-part (method).
part-documentation (method).
print-object (method).
subpart-kinds (method).
subpart-kinds (method).
*make-part-methods* (special variable).
add-package-to-document (function).
canonical-package-id (function).
document-part-p (method).
find-part (method).
finish-grovel (method).
finish-grovel (method).
grovel-part (method).
grovel-part (method).
ignore-package-p (function).
include-kind-in-index-p (method).
name-holder (method).
name-holder (method).
packages-to-document (function).
packages-to-ignore (function).
part-can-have-documention-p (function).
part-name (method).
part-symbol-name (function).
parts-with-no-documentation (function).
root-parent (function).
short-documentation (method).
some-parent (function).
start-grovel (method).
subpart-info (function).
tinaa-home (function).
tinaa/dev/generate-output.lisptinaa.lisp (file).
macros.lisp (file).
dev (module).
display-part (method).
document-system (function).
add-tinaa-link (function).
build-documentation (method).
build-documentation (method).
css-file-for-writer (method).
display-list-of-potential-parts (function).
doclisp-footer (method).
doclisp-header (method).
doclisp-header (method).
document-part-to-file (method).
make-link-for (method).
make-name-link-for (method).
maybe-display-part (function).
maybe-show-documentation (method).
output-table-summary (function).
output-table-summary-of-parts (method).
part-has-parents-p (function).
show-part-parents (method).
show-part-parents (method).
url-name (function).
write-css-file (function).
tinaa/dev/doc-package.lisptinaa.lisp (file).
macros.lisp (file).
dev (module).
display-part (method).
initialize-instance (method).
make-part (method).
part-documentation (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
subpart-kinds (method).
class-sorter (function).
conditionp (function).
doclisp-package (class).
document-part-p (method).
document-part-p (method).
document-part-to-file (method).
filtered-package-symbols (function).
include-kind-in-index-p (method).
include-kind-in-index-p (method).
include-kind-in-index-p (method).
index-kinds (method).
maybe-show-documentation (method).
nice-package-name (function).
start-grovel (method).
symbol-count (function).
symbol-kinds (reader method).
(setf symbol-kinds) (writer method).
update-document-part-p (function).
tinaa/dev/doc-class.lisptinaa.lisp (file).
macros.lisp (file).
dev (module).
display-part (method).
display-part (method).
initialize-instance (method).
initialize-instance (method).
make-part (method).
make-part (method).
make-part (method).
part-documentation (method).
part-documentation (method).
part-documentation (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
subpart-kinds (method).
subpart-kinds (method).
class-graph->dot (function).
class-uninteresting-p (function).
direct-instance (method).
direct-parent (method).
(setf direct-parent) (writer method).
doclisp-class (class).
doclisp-condition (class).
doclisp-slot (class).
interesting-subclasses (function).
interesting-superclasses (function).
make-local-class-graph (function).
part (reader method).
root-part (reader method).
slot-writer-name (function).
tinaa-part-graph (class).
tinaa-part-vertex (class).
tinaa/dev/doc-variable.lisptinaa.lisp (file).
macros.lisp (file).
dev (module).
display-part (method).
make-part (method).
make-part (method).
part-documentation (method).
doclisp-constant (class).
doclisp-variable (class).
documentation-exists-p (method).
tinaa/dev/doc-function.lisptinaa.lisp (file).
macros.lisp (file).
dev (module).
display-part (method).
display-part (method).
display-part (method).
display-part (method).
make-part (method).
make-part (method).
make-part (method).
make-part (method).
part-documentation (method).
doclisp-function (class).
doclisp-generic-function (class).
doclisp-macro (class).
doclisp-method (class).
method-sorter (function).
part-name (method).
symbol-name-tree (function).
tinaa/dev/doc-symbol.lisptinaa.lisp (file).
macros.lisp (file).
dev (module).
make-part (method).
doclisp-symbol (class).
span-class-for-part-name (method).
tinaa/dev/doc-asdf-system.lisptinaa.lisp (file).
macros.lisp (file).
dev (module).
display-part (method).
display-part (method).
initialize-instance (method).
make-part (method).
make-part (method).
part-documentation (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
partname-list (method).
subpart-kinds (method).
author-mail (reader method).
author-name (reader method).
build-license-page (function).
doclisp-asdf-system (class).
doclisp-file (class).
enough-filename (reader method).
filename (reader method).
find-name-and-email (function).
index-kinds (method).
maintainer-mail (reader method).
maintainer-name (reader method).
output-table-summary-of-parts (method).
part-name (method).
short-documentation (method).
system (reader method).
system-files (method).
system-files (method).
system-packages (function).
tinaa/dev/build-indexes.lisptinaa.lisp (file).
doc-symbol.lisp (file).
macros.lisp (file).
dev (module).
display-part (method).
display-part (method).
*required-index-contents* (special variable).
any-indexes-p (function).
build-index (function).
build-index-letters (function).
build-index-links (method).
build-index-links (method).
build-indexes (method).
build-indexes (method).
display-part-for-index (function).
index-file-name (function).
index-for-kind-p (function).
index-part-p (function).
local-index-url (function).
tinaa/dev/permuted-index.lispbuild-indexes.lisp (file).
dev (module).
display-part (method).
build-permuted-index (function).
make-string-of-size (function).
part-kind-abbreviation (method).
parts-matching-symbol (function).
permuted-index-delimiter-p (function).
permuted-index-locations (function).
princ-n-spaces (function).
tinaa/dev/build-contents.lisppackage.lisp (file).
dev (module).
build-contents-page (method).
content-things-from-part (function).
include-in-contents-p (method).
include-in-contents-p (method).
tinaa/dev/graph-parts.lisppackage.lisp (file).
definitions.lisp (file).
dev (module).
edge->dot (method).
vertex->dot (method).
*graph-image-format* (special variable).
*graph-size-in-inches* (special variable).
*graphviz-directory* (special variable).
add-part-vertex (method).
add-part-vertex (method).
add-part-vertex (method).
build-documentation (method).
build-part-graph (function).
depth-for-part (method).
direct-dependency-edge (class).
direct-package-edge (class).
edge-kinds-for-part-graph (method).
edge-kinds-for-part-graph (method).
edge-kinds-for-part-graph (method).
graph-file-name-for-part (function).
graph-part-p (generic function).
label (reader method).
layout-engine-for-part (method).
layout-graph-to-file (method).
make-part-graph (method).
make-part-graph (method).
ns-tlp (function).
other-dependency-edge (class).
other-package-edge (class).
page-writer-with-graphs (class).
pathname->unix (function).
tinaa-asdf-system-vertex (class).
tinaa-edge (class).
tinaa-graph (class).
tinaa-package-vertex (class).
tinaa-vertex (class).
write-part-graph (function).
Packages are listed by definition order.
tinaaA simple, yet extensible, Common Lisp documentation package.
doclisp
anaphora.
common-lisp.
defsystem-compatibility.
lisp-markup-language-2.
metabang.bind.
metabang.cl-containers.
metabang.moptilities.
metabang.utilities.
*css-file* (special variable).
cannot-make-part (condition).
display-part (generic function).
doclisp-assembly (class).
doclisp-part (class).
document-system (function).
instance (generic reader).
make-part (generic function).
parents (generic reader).
(setf parents) (generic writer).
part-documentation (generic function).
partname-list (generic function).
subpart-kinds (generic function).
*current-index* (special variable).
*current-part* (special variable).
*current-part-index* (special variable).
*default-packages-to-ignore* (special variable).
*document-file* (special variable).
*document-root* (special variable).
*document-stream* (special variable).
*graph-image-format* (special variable).
*graph-size-in-inches* (special variable).
*graphviz-directory* (special variable).
*make-part-methods* (special variable).
*output-calls* (special variable).
*packages-to-document* (special variable).
*required-index-contents* (special variable).
*root-part* (special variable).
*short-documentation-length* (special variable).
*tinaa-home-page* (special variable).
*tinaa-version* (special variable).
add-contents-link (generic function).
add-package-to-document (function).
add-part-vertex (generic function).
add-tinaa-link (function).
any-indexes-p (function).
args (generic reader).
author-mail (generic reader).
author-name (generic reader).
basic-doclisp-part (class).
basic-page-writer (class).
build-contents-page (generic function).
build-documentation (generic function).
build-index (function).
build-index-letters (function).
build-index-links (generic function).
build-indexes (generic function).
build-license-page (function).
build-part-graph (function).
build-permuted-index (function).
canonical-package-id (function).
class-graph->dot (function).
class-sorter (function).
class-uninteresting-p (function).
conditionp (function).
content-things-from-part (function).
css-file (generic reader).
(setf css-file) (generic writer).
css-file-for-writer (generic function).
depth-for-part (generic function).
direct-dependency-edge (class).
direct-instance (generic function).
direct-package-edge (class).
direct-parent (generic function).
(setf direct-parent) (generic writer).
display-arguments (function).
display-function (function).
display-list-of-potential-parts (function).
display-part-for-index (function).
doclisp-asdf-system (class).
doclisp-class (class).
doclisp-condition (class).
doclisp-constant (class).
doclisp-file (class).
doclisp-footer (generic function).
doclisp-function (class).
doclisp-generic-function (class).
doclisp-header (generic function).
doclisp-macro (class).
doclisp-method (class).
doclisp-package (class).
doclisp-slot (class).
doclisp-symbol (class).
doclisp-variable (class).
document-part-p (generic function).
document-part-to-file (generic function).
document-system-part (generic function).
document? (generic reader).
(setf document?) (generic writer).
documentation-exists-p (generic function).
documenting (macro).
documenting-page (macro).
edge-kinds-for-part-graph (generic function).
enough-filename (generic reader).
file-depth-below-root (function).
filename (generic reader).
filtered-package-symbols (function).
find-name-and-email (function).
find-part (generic function).
finish-grovel (generic function).
flag? (generic reader).
(setf flag?) (generic writer).
graph-file-name-for-part (function).
graph-part-p (generic function).
grovel-part (generic function).
header (generic reader).
(setf header) (generic writer).
heading (generic reader).
ignore-package-p (function).
include-in-contents-p (generic function).
include-kind-in-index-p (generic function).
index-file-name (function).
index-for-kind-p (function).
index-kinds (generic function).
index-part-p (function).
index? (generic reader).
interesting-subclasses (function).
interesting-superclasses (function).
kind (generic reader).
label (generic reader).
layout-engine-for-part (generic function).
layout-graph-to-file (generic function).
lml-insert-file (function).
local-index-url (function).
maintainer-mail (generic reader).
maintainer-name (generic reader).
make-link-for (generic function).
make-local-class-graph (function).
make-name-link-for (generic function).
make-part-graph (generic function).
make-root-pointing-url (generic function).
make-string-of-size (function).
make-system-part (generic function).
map-parts-from-leaves (function).
map-subpart-kinds (function).
maybe-display-part (function).
maybe-show-documentation (generic function).
method-sorter (function).
name-holder (generic function).
name-holder-mixin (class).
nice-package-name (function).
ns-tlp (function).
other-dependency-edge (class).
other-package-edge (class).
output-table-summary (function).
output-table-summary-of-parts (generic function).
packages-to-document (function).
packages-to-ignore (function).
page-writer (generic reader).
page-writer-class (generic reader).
page-writer-with-graphs (class).
part (generic reader).
part-can-have-documention-p (function).
part-has-parents-p (function).
part-kind (generic reader).
part-kind-abbreviation (generic function).
part-kind-unknown-error (condition).
part-name (generic function).
part-symbol-name (function).
part-type (generic reader).
parts-matching-symbol (function).
parts-with-no-documentation (function).
pathname->unix (function).
permuted-index-delimiter-p (function).
permuted-index-locations (function).
princ-n-spaces (function).
reason (generic reader).
relative-url (function).
root-parent (function).
root-part (generic reader).
set-flags (function).
short-documentation (generic function).
show-part-parents (generic function).
simple-page-writer (class).
slot-writer-name (function).
some-parent (function).
span-class-for-part-name (generic function).
start-grovel (generic function).
string->html (generic function).
stylesheet-url (function).
subpart-info (function).
subpart-kind (class).
subparts (generic reader).
symbol-count (function).
symbol-kinds (generic reader).
(setf symbol-kinds) (generic writer).
symbol-name-tree (function).
system (generic reader).
system-files (generic function).
system-packages (function).
tinaa-asdf-system-vertex (class).
tinaa-edge (class).
tinaa-graph (class).
tinaa-home (function).
tinaa-package-vertex (class).
tinaa-part-graph (class).
tinaa-part-vertex (class).
tinaa-vertex (class).
update-document-part-p (function).
url (generic reader).
(setf url) (generic writer).
url->file (function).
url-for-part (generic function).
url-name (function).
with-html-output (macro).
write-css-file (function).
write-part-graph (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
If set, this should point to the CSS file that Tinaa should use.
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.
Output information about a part. Example modes are :subpart-list, :detail, :summary.
simple-page-writer) (part basic-doclisp-part) (mode (eql :permuted-index)) &key spaces &allow-other-keys) ¶simple-page-writer) (part doclisp-symbol) (mode (eql :index)) &key &allow-other-keys) ¶simple-page-writer) (part basic-doclisp-part) (mode (eql :index)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-file) (mode (eql :table-summary)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-asdf-system) (mode (eql :detail)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-method) (mode (eql :table-summary)) &key &allow-other-keys) ¶simple-page-writer) (part basic-doclisp-part) (mode (eql :function)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-generic-function) (mode (eql :detail)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-function) (mode (eql :detail)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-variable) (mode (eql :detail)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-slot) (mode (eql :table-summary)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-class) (mode (eql :detail)) &key &allow-other-keys) ¶simple-page-writer) (part doclisp-package) (mode (eql :detail)) &key &allow-other-keys) ¶simple-page-writer) (part basic-doclisp-part) (mode (eql :table-summary)) &key &allow-other-keys) ¶simple-page-writer) (part basic-doclisp-part) (mode (eql :name+type)) &key &allow-other-keys) ¶simple-page-writer) (part basic-doclisp-part) (mode (eql :name)) &key &allow-other-keys) ¶simple-page-writer) part mode &key &allow-other-keys) ¶basic-doclisp-part)) ¶An instance of this part.
Make a part named ’name’ of kind ’kind’ whose parent is ’parent’.
(eql tinaa::file)) name &rest args &key &allow-other-keys) ¶(eql tinaa::asdf-system)) name &rest args &key &allow-other-keys) ¶(eql symbol)) name &rest args &key &allow-other-keys) ¶(eql tinaa::macro)) name &rest args &key &allow-other-keys) ¶(eql method)) name &rest args &key &allow-other-keys) ¶(eql generic-function)) name &rest args &key &allow-other-keys) ¶(eql function)) name &rest args &key &allow-other-keys) ¶(eql tinaa::constant)) name &rest args &key &allow-other-keys) ¶(eql variable)) name &rest args &key &allow-other-keys) ¶(eql tinaa::slot)) name &rest args &key &allow-other-keys) ¶(eql condition)) name &rest args &key &allow-other-keys) ¶(eql class)) name &rest args &key &allow-other-keys) ¶(eql package)) name &rest args &key &allow-other-keys) ¶basic-doclisp-part)) ¶automatically generated reader method
basic-doclisp-part)) ¶automatically generated writer method
Returns whatever documentation is available for part using the Common Lisp documentation function.
doclisp-asdf-system)) ¶doclisp-function)) ¶doclisp-variable)) ¶doclisp-slot)) ¶doclisp-condition)) ¶doclisp-class)) ¶doclisp-package)) ¶basic-doclisp-part)) ¶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.
doclisp-asdf-system) (part-name (eql tinaa::other-dependency))) ¶doclisp-asdf-system) (part-name (eql tinaa::direct-dependency))) ¶doclisp-asdf-system) (part-name (eql tinaa::file))) ¶doclisp-asdf-system) (part-name (eql tinaa::other-file))) ¶doclisp-asdf-system) (part-name (eql tinaa::direct-file))) ¶doclisp-asdf-system) (part-name (eql tinaa::other-package))) ¶doclisp-asdf-system) (part-name (eql tinaa::direct-package))) ¶doclisp-class) (part-name (eql tinaa::subclass))) ¶doclisp-class) (part-name (eql tinaa::superclass))) ¶doclisp-class) (part-name (eql class))) ¶doclisp-class) (part-name (eql tinaa::slot))) ¶doclisp-class) (part-name (eql tinaa::other-method))) ¶doclisp-class) (part-name (eql tinaa::direct-method))) ¶doclisp-class) (part-name (eql method))) ¶doclisp-package) (part-name (eql symbol))) ¶doclisp-package) (part-name (eql tinaa::macro))) ¶doclisp-package) (part-name (eql generic-function))) ¶doclisp-package) (part-name (eql function))) ¶doclisp-package) (part-name (eql tinaa::constant))) ¶doclisp-package) (part-name (eql variable))) ¶doclisp-package) (part-name (eql condition))) ¶doclisp-package) (part-name (eql class))) ¶Returns a list of the kinds of the subparts of assembly. This is a list of instances of subpart-kind.
doclisp-asdf-system)) ¶doclisp-condition)) ¶doclisp-class)) ¶doclisp-package)) ¶basic-doclisp-part)) ¶doclisp-assembly)) ¶direct-package-edge) stream) ¶cl-graph.
doclisp-assembly) &key) ¶doclisp-class) &key) ¶doclisp-asdf-system) &key) ¶subpart-kind) &key) ¶doclisp-package) &key) ¶doclisp-condition) &key) ¶basic-doclisp-part) &key) ¶cannot-make-part)) ¶metabang.utilities.
part-kind-unknown-error)) ¶metabang.utilities.
subpart-kind) stream) ¶basic-doclisp-part) stream) ¶tinaa-package-vertex) stream) ¶cl-graph.
This error is signaled when a part cannot be created.
error.
metabang.utilities.
(quote nil)
:parent
This slot is read-only.
A part with sub-parts.
| Initarg | Value |
|---|---|
:page-writer-class | (quote simple-page-writer) |
(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))))
This slot is read-only.
:page-writer-class
This slot is read-only.
This slot is read-only.
A part without pieces (a leaf).
The image format to use for graph files
The location of the various GraphViz files. In particular, dot, neato, circo and twopi should live in this directory.
Used to help ensure that we don’t use up the stack trying to find a good method... Probably too baroque.
The number of characters of documentation to show in summaries.
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.
Returns a string describing graph in DOT format.
Returns true if and only if thing is a condition
Returns a list of < kind name url > triples for the subparts of part that should be displayed in the table of contents.
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!
Returns a list of parts in name-holder than have the same name as symbol
Returns a URL that points to the same things as ‘url‘ but relative to (url *current-part*)
Go up the parent chain until there are no parents... that’s the root.
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.
basic-doclisp-part) force-contents-link?) ¶(eql nil)) force-contents-link?) ¶basic-graph) (part doclisp-asdf-system)) ¶basic-graph) (part doclisp-package)) ¶basic-graph) (part basic-doclisp-part)) ¶part-kind-unknown-error)) ¶args.
doclisp-asdf-system)) ¶automatically generated reader method
doclisp-asdf-system)) ¶automatically generated reader method
basic-page-writer) root top-level-things) ¶page-writer-with-graphs) (part doclisp-assembly) root &key &allow-other-keys) ¶basic-page-writer) (part doclisp-assembly) root &key &allow-other-keys) ¶basic-page-writer) (part doclisp-assembly) root &key erase-first?) ¶basic-doclisp-part) index-part current-index) ¶(eql nil)) index-part current-index) ¶basic-page-writer) (part name-holder-mixin)) ¶basic-page-writer) (part basic-doclisp-part)) ¶basic-page-writer)) ¶automatically generated reader method
basic-page-writer)) ¶automatically generated writer method
basic-page-writer)) ¶basic-doclisp-part)) ¶doclisp-slot)) ¶doclisp-slot)) ¶doclisp-slot)) ¶automatically generated writer method
basic-doclisp-part) &key force-contents-link?) ¶(eql nil)) &key force-contents-link?) ¶doclisp-package) (part basic-doclisp-part)) ¶doclisp-package) (part doclisp-package)) ¶name-holder-mixin) (part basic-doclisp-part)) ¶basic-page-writer) (part doclisp-package)) ¶basic-page-writer) (part basic-doclisp-part)) ¶subpart-kind)) ¶automatically generated reader method
basic-doclisp-part)) ¶automatically generated reader method
basic-doclisp-part)) ¶automatically generated writer method
doclisp-variable) (mode (eql :detail))) ¶doclisp-asdf-system) (part doclisp-class)) ¶doclisp-asdf-system) (part doclisp-asdf-system)) ¶doclisp-file)) ¶automatically generated reader method
doclisp-file)) ¶automatically generated reader method
Returns a existing part if it can be found.
name-holder-mixin) kind name) ¶doclisp-assembly)) ¶basic-doclisp-part)) ¶basic-doclisp-part)) ¶automatically generated reader method
basic-doclisp-part)) ¶automatically generated writer method
doclisp-class)) ¶doclisp-asdf-system)) ¶doclisp-assembly)) ¶basic-doclisp-part)) ¶basic-doclisp-part)) ¶automatically generated reader method
basic-doclisp-part)) ¶automatically generated writer method
subpart-kind)) ¶automatically generated reader method
name-holder-mixin)) ¶Returns true if part should include kind in it’s index.
doclisp-package) kind) ¶doclisp-package) (kind (eql method))) ¶doclisp-package) (kind (eql symbol))) ¶basic-doclisp-part) kind) ¶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.
doclisp-asdf-system)) ¶doclisp-package)) ¶basic-doclisp-part)) ¶subpart-kind)) ¶automatically generated reader method
cannot-make-part)) ¶kind.
part-kind-unknown-error)) ¶kind.
tinaa-edge)) ¶automatically generated reader method
basic-doclisp-part)) ¶doclisp-asdf-system)) ¶automatically generated reader method
doclisp-asdf-system)) ¶automatically generated reader method
(eql :table-summary)) name url) ¶doclisp-class)) ¶doclisp-asdf-system)) ¶basic-doclisp-part) name) ¶(eql nil)) name) ¶doclisp-package)) ¶basic-doclisp-part)) ¶name-holder-mixin)) ¶(eql nil))) ¶basic-doclisp-part)) ¶automatically generated reader method
doclisp-assembly)) ¶automatically generated reader method
doclisp-assembly)) ¶automatically generated reader method
tinaa-part-vertex)) ¶automatically generated reader method
part.
subpart-kind)) ¶automatically generated reader method
basic-doclisp-part)) ¶automatically generated reader method
Returns the name of the part as a string
doclisp-file)) ¶doclisp-function)) ¶basic-doclisp-part)) ¶basic-doclisp-part)) ¶automatically generated reader method
cannot-make-part)) ¶tinaa-part-graph)) ¶automatically generated reader method
Returns the first bit of the documentation for part.
Change *short-documentation-length* to determine how much is returned.
doclisp-asdf-system)) ¶basic-doclisp-part)) ¶Generate HTML to show the parents of a part. Called for a part only when it actually has parents (using an around method).
basic-doclisp-part)) ¶basic-doclisp-part)) ¶Returns the class to be used when displaying the part’s name.
doclisp-package) (part doclisp-symbol)) ¶basic-doclisp-part)) ¶doclisp-package)) ¶basic-doclisp-part)) ¶doclisp-assembly)) ¶automatically generated reader method
doclisp-package)) ¶automatically generated reader method
doclisp-package)) ¶automatically generated writer method
doclisp-file)) ¶automatically generated reader method
doclisp-asdf-system) system-closure?) ¶symbol) system-closure?) ¶basic-doclisp-part)) ¶automatically generated reader method
url.
basic-doclisp-part)) ¶automatically generated writer method
url.
Returns the url for the part, creating it if necessary.
name-holder-mixin)) ¶basic-doclisp-part)) ¶cannot-make-part)) ¶metabang.utilities.
name.
subpart-kind)) ¶automatically generated reader method
metabang.utilities.
name.
part-kind-unknown-error)) ¶metabang.utilities.
name.
basic-doclisp-part)) ¶automatically generated reader method
metabang.utilities.
name.
add-contents-link.
add-part-vertex.
build-index-links.
build-indexes.
depth-for-part.
display-part.
display-part.
display-part.
display-part.
display-part.
display-part.
doclisp-header.
document-part-p.
document-part-p.
document-part-to-file.
(setf document?).
document?.
finish-grovel.
(setf flag?).
flag?.
grovel-part.
(setf header).
header.
include-kind-in-index-p.
index-kinds.
initialize-instance.
instance.
layout-engine-for-part.
make-root-pointing-url.
maybe-show-documentation.
name.
name-holder.
(setf parents).
parents.
part-documentation.
part-kind.
part-name.
part-type.
print-object.
short-documentation.
show-part-parents.
show-part-parents.
span-class-for-part-name.
start-grovel.
subpart-kinds.
(setf url).
url.
url-for-part.
| Initarg | Value |
|---|---|
:header | |
metabang.utilities.
""
:name
name.
This slot is read-only.
:parents
An instance of this part.
:instance
This slot is read-only.
:document?
""
:header
""
:part-kind
This slot is read-only.
:name-holder
This slot is read-only.
:css-file
add-part-vertex.
author-mail.
author-name.
display-part.
edge-kinds-for-part-graph.
edge-kinds-for-part-graph.
graph-part-p.
index-kinds.
initialize-instance.
maintainer-mail.
maintainer-name.
make-part-graph.
part-documentation.
partname-list.
partname-list.
partname-list.
partname-list.
partname-list.
partname-list.
partname-list.
short-documentation.
subpart-kinds.
system-files.
| Initarg | Value |
|---|---|
:header | asdf system |
:part-kind | asdf-system |
:document? | t |
:part-type | (quote asdf-system) |
This slot is read-only.
This slot is read-only.
:maintainer-name
This slot is read-only.
:maintainer-mail
This slot is read-only.
| Initarg | Value |
|---|---|
:header | class |
:part-kind | class |
:part-type | (quote class) |
| Initarg | Value |
|---|---|
:header | condition |
:part-kind | condition |
:part-type | (quote condition) |
| Initarg | Value |
|---|---|
:header | constant |
:part-kind | constant |
:part-type | (quote constant) |
| Initarg | Value |
|---|---|
:header | file |
:part-kind | file |
:document? | t |
:part-type | (quote file) |
:enough-filename
This slot is read-only.
| Initarg | Value |
|---|---|
:header | function |
:part-kind | function |
:part-type | (quote function) |
| Initarg | Value |
|---|---|
:header | generic function |
:part-kind | generic function |
:part-type | (quote generic-function) |
| Initarg | Value |
|---|---|
:header | macro |
:part-kind | macro |
:part-type | (quote macro) |
| Initarg | Value |
|---|---|
:header | method |
:part-kind | method |
:part-type | (quote method) |
add-part-vertex.
display-part.
document-part-p.
document-part-p.
document-part-to-file.
include-kind-in-index-p.
include-kind-in-index-p.
include-kind-in-index-p.
index-kinds.
initialize-instance.
maybe-show-documentation.
part-documentation.
partname-list.
partname-list.
partname-list.
partname-list.
partname-list.
partname-list.
partname-list.
partname-list.
span-class-for-part-name.
start-grovel.
subpart-kinds.
(setf symbol-kinds).
symbol-kinds.
| Initarg | Value |
|---|---|
:header | package |
:part-kind | package |
:document? | t |
:part-type | (quote package) |
(list :internal :external)
:symbol-kinds
| Initarg | Value |
|---|---|
:header | slot |
:part-kind | slot |
:part-type | (quote slot) |
| Initarg | Value |
|---|---|
:header | symbol |
:part-kind | symbol |
:part-type | (quote symbol) |
| Initarg | Value |
|---|---|
:header | variable |
:part-kind | variable |
:part-type | (quote variable) |
dot-directed-edge.
dot-graph-mixin.
graph-container.
| Initarg | Value |
|---|---|
: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)))) |
graph-container.
| Initarg | Value |
|---|---|
:vertex-class | (quote tinaa-part-vertex) |
graph-container-vertex.
part.
dot-vertex.
graph-container-vertex.
| Jump to: | (
A B C D E F G H I K L M N O P R S T U V W |
|---|
| Jump to: | (
A B C D E F G H I K L M N O P R S T U V W |
|---|
| Jump to: | *
A C D E F H I K L M N P R S U |
|---|
| Jump to: | *
A C D E F H I K L M N P R S U |
|---|
| Jump to: | A B C D E F G I M N O P S T U W |
|---|
| Jump to: | A B C D E F G I M N O P S T U W |
|---|