A simple, yet extensible, Common Lisp documentation package.
| cannot-make-part | This error is signaled when a part cannot be created. |
|---|---|
| part-kind-unknown-error |
| *css-file* | If set, this should point to the CSS file that Tinaa should use. |
|---|---|
| *current-index* | |
| *current-part* | |
| *current-part-index* | |
| *default-packages-to-ignore* | |
| *document-file* | |
| *document-root* | |
| *document-stream* | |
| *graph-image-format* | The image format to use for graph files |
| *graph-size-in-inches* | |
| *graphviz-directory* | The location of the various GraphViz files. In particular, dot, neato, circo and twopi should liv... |
| *make-part-methods* | Used to help ensure that we don't use up the stack trying to find a good method... Probably too b... |
| *output-calls* | |
| *packages-to-document* | |
| *required-index-contents* | |
| *root-part* | |
| *short-documentation-length* | The number of characters of documentation to show in summaries. |
| *tinaa-home-page* | |
| *tinaa-version* |
| add-contents-link | |
|---|---|
| add-part-vertex | |
| build-contents-page | |
| build-documentation | |
| build-index-links | |
| build-indexes | |
| css-file-for-writer | |
| depth-for-part | |
| direct-instance | |
| direct-parent | |
| display-part | Output information about a part. Example modes are |
| doclisp-footer | |
| doclisp-header | |
| document-part-p | |
| document-part-to-file | |
| documentation-exists-p | |
| edge-kinds-for-part-graph | |
| find-part | Returns a existing part if it can be found. |
| finish-grovel | |
| graph-part-p | |
| grovel-part | |
| include-in-contents-p | |
| include-kind-in-index-p | Returns true if part should include kind in it's index. |
| index-kinds | Returns a list describing what indexes to generate for this part. This list is a list of lists of... |
| layout-engine-for-part | |
| layout-graph-to-file | |
| make-link-for | |
| make-name-link-for | |
| make-part | Make a part named 'name' of kind 'kind' whose parent is 'parent'. |
| make-part-graph | |
| make-root-pointing-url | |
| maybe-show-documentation | |
| name-holder | |
| output-table-summary-of-parts | |
| part-documentation | Returns whatever documentation is available for part using the Common Lisp documentation function... |
| part-kind-abbreviation | |
| part-name | Returns the name of the part as a string |
| partname-list | Returns a list of the names of the subparts of part of type 'part-kind'. Usually, these will be s... |
| short-documentation | Returns the first bit of the documentation for part. |
| show-part-parents | Generate HTML to show the parents of a part. Called for a part only when it actually has parents ... |
| span-class-for-part-name | Returns the class to be used when displaying the part's name. |
| start-grovel | |
| string->html | |
| subpart-kinds | Returns a list of the kinds of the subparts of assembly. |
| system-files | |
| url-for-part | Returns the url for the part, creating it if necessary. |