Package Tinaa - Internal and External Symbols

Part of:

asdf-system tinaa
A simple, yet extensible, Common Lisp documentation package.

Package Tinaa uses the packages Common-Lisp, Defsystem-Compatibility, Lisp-Markup-Language-2, Metabang.Bind, Metabang.Cl-Containers, Metabang.Moptilities and Metabang.Utilities. It is also known as Doclisp. It has 813 total symbols and 10 external ones.

Condition

cannot-make-partThis error is signaled when a part cannot be created.

Class

basic-doclisp-part
doclisp-asdf-system
doclisp-assemblyA part with sub-parts.
doclisp-class
doclisp-condition
doclisp-constant
doclisp-file
doclisp-function
doclisp-generic-function
doclisp-macro
doclisp-method
doclisp-package
doclisp-partA part without pieces (a leaf).
doclisp-slot
doclisp-symbol
doclisp-variable
name-holder-mixin
subpart-kind
tinaa-part-graph

Variable

*current-index*
*current-part*
*current-part-index*
*default-packages-to-ignore*
*document-file*
*document-root*
*document-stream*
*output-calls*
*packages-to-document*
*required-index-contents*
*root-part*
*short-documentation-length*
*tinaa-home-page*
*tinaa-version*
mp
ms

Function

add-package-to-document
add-tinaa-link
any-indexes-p
build-contents-page
build-index
build-index-letters
build-index-of-kind
build-license-page
build-permuted-indexA permuted index includes each n-word entry up to n times, at points corresponding to the use of ...
canonical-package-id
class-graph->dotReturns a string describing graph in DOT format.
class-sorter
class-uninteresting-p
conditionpReturns true if and only if thing is a condition
content-things-from-partReturns a list of < kind name url > triples for the subparts of part that should be displayed in ...
display-arguments
display-function
display-list-of-potential-parts
display-part-for-index
document-systemCreate TINAA documentation for a system. System-kind should be 'package or some other value for ...
file-depth-below-root
filtered-package-symbols
find-name-and-emailReturns (as multiple values) a name and e-mail address as parsed from a string. Handles only “nam...
ignore-package-p
index-file-name
index-for-kind-p
index-part-p
index-url-name
interesting-subclasses
interesting-superclasses
local-index-url
make-local-class-graph
make-string-of-size
map-parts-from-leaves
map-subpart-kinds
maybe-display-part
method-sorter
nice-package-name
output-table-summary
packages-to-document
packages-to-ignore
part-can-have-documention-p
part-has-parents-p
part-symbol-name
parts-matching-symbolReturns a list of parts in name-holder than have the same name as symbol
parts-with-no-documentation
pathname-for-system-fileReturns the full pathname in system for filename (which is just the name+type).
permuted-index-delimiter-p
permuted-index-locations
princ-n-spaces
relative-urlReturns a URL that points to the same things as `url` but relative to (url *current-part*)
root-parent
set-flags
some-parent
string->html
stylesheet-url
subpart-info
symbol-count
symbol-name-tree
system-packages
tinaa-home
update-document-part-p
url->fileReturns a file spec for the url rooted at *document-root*. The URL must be delimited using forwar...
url-name
write-css-file

Generic-Function

add-contents-link
build-documentation
build-index-links
build-indexes
direct-instance
direct-parent
display-partOutput information about a part. Example modes are :subpart-list, :detail, :summary.
doclisp-footer
doclisp-header
document-part-p
document-part-to-file
documentation-exists-p
find-partReturns a existing part if it can be found.
finish-grovel
grovel-part
include-in-contents-p
include-kind-in-index-pReturns true if part should include kind in it's index.
index-kindsReturns a list describing what indexes to generate for this part. This list is a list of lists of...
make-link-for
make-name-link-for
make-partMake a part named 'name' of kind 'kind' whose parent is 'parent'.
make-root-pointing-url
maybe-show-documentation
name
name-holder
output-table-summary-of-parts
part-documentationReturns whatever documentation is available for part using the Common Lisp documentation function...
part-kind-abbreviation
part-nameReturns the name of the part as a string
partname-listReturns a list of the names of the subparts of part of type 'part-kind'. Usually, these will be s...
short-documentationReturns the first bit of the documentation for part. Change *short-documentation-length* to deter...
show-part-parentsGenerate HTML to show the parents of a part. Called for a part only when it actually has parents ...
span-class-for-part-nameReturns the class to be used when displaying the part's name.
start-grovel
subpart-kindsReturns a list of the kinds of the subparts of assembly. This is a list of instances of subpart-k...
system-files
url-for-partReturns the url for the part, creating it if necessary.

Macro

documenting
documenting-page
fnA general-purpose function-builder. EXPR should be of the form (OPERATOR . ARGUMENTS). Will ...
with-html-output