The ccldoc Reference Manual

Table of Contents

The ccldoc Reference Manual

This is the ccldoc Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 09:10:29 2019 GMT+0.

1 Introduction

CCLDoc documentation system

CCLDoc is a system for creating Lisp documentation. It uses S-expressions to represent document structure, markup, cross references, and contents. It has a small number of basic operators, supports macros for syntax extensions, and supports a simple syntax for embedding expressions in strings for added convenience.

The documentation for Clozure CL is written in CCLDoc.

To use CCLDoc to format the CCL documentation, follow these steps:

1. Install CCL. See http://ccl.clozure.com/download.html
2. Install Quicklisp. See http://www.quicklisp.org
3. Check out the CCLDoc sources into ~/quicklisp/local-projects

Now, start CCL, and do the following:

(load "home:quicklisp;setup")
(ql:quickload :ccldoc)
(defparameter *d* (ccldoc:load-document "ccl:doc;manual;ccl.ccldoc"))
(ccldoc::output-html *d* "/tmp/ccl.html" :stylesheet "ccl.css")

You can then view the generated ccl.html file in your browser. The generated HTML expects to use a style file named ccl.css in the same directory.

There is also a not-quite-complete LaTeX converter. To use it, do (output-latex *d* "ccl.tex") and then process the ccl.tex file with xelatex to produce a PDF file. The version of xelatex that comes with MacTeX 2014 works.

2 Systems

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

2.1 ccldoc

Author

Clozure Associates and contributors

License

Apache License 2.0

Description

create lisp documentation using s-expressions

Dependencies

• alexandria
• split-sequence
• s-xml
• cl-who
• ccl-compat

Source

ccldoc.asd (file)

Components

• package.lisp (file)
• utils.lisp (file)
• representation.lisp (file)
• toplevel.lisp (file)
• syntax.lisp (file)
• output-docbook.lisp (file)
• output-tracwiki.lisp (file)
• output-html.lisp (file)
• output-latex.lisp (file)
• output-ccldoc.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 ccldoc.asd

Location

ccldoc.asd

Systems

ccldoc (system)

3.1.2 ccldoc/package.lisp

Parent

ccldoc (system)

Location

package.lisp

Packages

ccldoc

3.1.3 ccldoc/utils.lisp

Dependency

package.lisp (file)

Parent

ccldoc (system)

Location

utils.lisp

Exported Definitions

• def-definition-type (macro)
• dspec (structure)
• dspec-name (function)
• (setf dspec-name) (function)
• dspec-type (function)
• (setf dspec-type) (function)
• dspec-type-name (function)

Internal Definitions

• %make-dspec (function)
• *ccldoc-fake-packages* (special variable)
• *dspec-types* (special variable)
• *whitespace-allowed-tags* (special variable)
• canonicalize-definition-name (function)
• cassert (macro)
• ccldoc-package (function)
• concat-by (function)
• copy-dspec (function)
• def-predicate (macro)
• desym (function)
• dspec-subtypep (function)
• dspec-type-for-type-name (function)
• dspec-type-name-p (function)
• dspecinfo-function (function)
• (setf dspecinfo-function) (function)
• dspecinfo-id-prefix (function)
• (setf dspecinfo-id-prefix) (function)
• dspecinfo-parent-type (function)
• (setf dspecinfo-parent-type) (function)
• dspecinfo-type (function)
• (setf dspecinfo-type) (function)
• dspecinfo-type-name (function)
• (setf dspecinfo-type-name) (function)
• dspecp (function)
• function-for-dspec-type (function)
• gensymp (function)
• id-prefix-for-dspec-type (function)
• info-for-dspec-type (function)
• make-dspec (function)
• make-dspecinfo (function)
• make-wild-dspec (function)
• normalize-whitespace (function)
• op-name (function)
• op-name-p (function)
• parent-type-for-dspec-type (function)
• read-all-from-string (function)
• register-dspec-type (function)
• std-dspec-name (function)
• string-dspec-name (function)
• symbol-dspec-name (function)
• wild-dspec-p (function)
• with-ccldoc-packages (macro)

3.1.4 ccldoc/representation.lisp

Dependency

utils.lisp (file)

Parent

ccldoc (system)

Location

representation.lisp

Exported Definitions

• block (class)
• clause (type)
• clause-body (method)
• (setf clause-body) (method)
• clause-document (method)
• clause-document (method)
• clause-external-id (method)
• (setf clause-external-id) (method)
• clause-items (method)
• clause-name (method)
• (setf clause-name) (method)
• clause-object (class)
• clause-parent (method)
• (setf clause-parent) (method)
• clause-parent (method)
• (setf clause-parent) (method)
• clause-parent (method)
• (setf clause-parent) (method)
• clause-term (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-title (method)
• clause-with-body (class)
• clause-with-items (class)
• clause-with-term (class)
• clause-with-title (class)
• code-block (class)
• definition (class)
• definition-display-name (method)
• (setf definition-display-name) (method)
• definition-signature (method)
• (setf definition-signature) (method)
• definition-summary (method)
• (setf definition-summary) (method)
• docerror (class)
• document (class)
• glossary-section (function)
• glossary-section (class)
• glossentry (class)
• index-section (function)
• index-section (class)
• indexed-clause (class)
• item (class)
• link (class)
• link-url (method)
• listing (class)
• listing-type (method)
• listing-type (type)
• markup (class)
• markup-type (method)
• markup-type (type)
• named-clause (class)
• para (class)
• row (class)
• section (class)
• section-level (method)
• section-level (method)
• table (class)
• term-item (class)
• xref (class)
• xref-default-body (method)
• xref-target (method)

Internal Definitions

• *current-file* (special variable)
• *parent-clause* (special variable)
• *section-package* (special variable)
• *source-form* (special variable)
• ancestor-of-type (function)
• as-fully-qualified-name (function)
• canonical-clause-name-p (function)
• clause-default-body (method)
• clause-reference-name (method)
• clause-reference-name (method)
• clause-reference-name (method)
• clause-section (method)
• clause-source-form (method)
• clause-with-optional-title (class)
• clause-with-required-body (class)
• clause-with-required-title (class)
• default-operator (method)
• default-operator (method)
• default-operator (method)
• default-operator (method)
• default-operator (method)
• default-operator (method)
• external-ids (method)
• find-clause (function)
• inline-clause (class)
• inline-clause-p (generic function)
• inline-clause-p (method)
• inline-clause-p (method)
• inline-clause-p (method)
• inline-clause-p (method)
• matching-clauses (function)
• named-clauses (method)
• named-clauses-count (function)
• placeholder-target-name (method)
• princ-ccldoc (method)
• reference-placeholder (class)
• resolve-placeholder (function)
• resolve-xref-targets (function)
• section-name-p (function)
• subclause-slots (generic function)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• table-name-p (function)
• wild-name-match-p (function)
• wildcard-canonical-name-p (function)

3.1.5 ccldoc/toplevel.lisp

Dependency

representation.lisp (file)

Parent

ccldoc (system)

Location

toplevel.lisp

Exported Definitions

• def-expander (macro)
• load-document (function)

Internal Definitions

• %def-operator (function)
• *operators* (special variable)
• assign-external-ids (function)
• build-ccldoc (function)
• ccldoc-macro-expander (function)
• ccldoc-macroexpand (function)
• ccldoc-operator (function)
• ccldoc-opinfo (function)
• ccldoc-string-parser (function)
• def-operator (macro)
• delim-pos (function)
• disambiguate-ids (function)
• end-delim-pos (function)
• external-id-for-clause (method)
• external-id-for-clause (method)
• external-id-for-clause (method)
• external-id-for-name (function)
• external-id-string (function)
• form-clause-by-operator (function)
• lisp-from-string (function)
• load-to-ccldoc-form (function)
• make-arg-reader (function)
• make-opinfo (function)
• norm-for-external-id (function)
• opinfo-function (function)
• (setf opinfo-function) (function)
• opinfo-parser (function)
• (setf opinfo-parser) (function)
• opinfo-type (function)
• (setf opinfo-type) (function)
• parse-ccldoc-string (function)
• read-ccldoc-document (function)
• string-chunk (function)
• text-for-clause-name (function)

3.1.6 ccldoc/syntax.lisp

Dependency

toplevel.lisp (file)

Parent

ccldoc (system)

Location

syntax.lisp

Internal Definitions

• canonicalize-ref-name (function)
• collect-glossary-entries (function)
• form-clause (function)
• form-clause-ensuring-simple (function)
• normalize-title (function)
• para-subforms-to-body (method)
• parse-arg-and-options (function)
• subforms-clause (function)
• subforms-items (function)
• subforms-to-body (method)
• subforms-to-items (method)

3.1.7 ccldoc/output-docbook.lisp

Dependency

syntax.lisp (file)

Parent

ccldoc (system)

Location

output-docbook.lisp

Exported Definitions

output-docbook (function)

Internal Definitions

• docbook-tag (function)
• docbook-tag-for-markup (function)
• docbook-tags-for-listing (function)
• docbook-title* (function)
• generate-body-list (function)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-list (method)
• generate-docbook-list (method)

3.1.8 ccldoc/output-tracwiki.lisp

Dependency

output-docbook.lisp (file)

Parent

ccldoc (system)

Location

output-tracwiki.lisp

Exported Definitions

output-tracwiki (function)

Internal Definitions

• *nowiki-context* (special variable)
• *special-anywhere* (special variable)
• *special-at-start-of-line* (special variable)
• *wiki-indent* (special variable)
• *wiki-inline* (special variable)
• call-with-markup (function)
• wiki-blankline (function)
• wiki-freshline (function)
• wiki-newline (function)
• with-markup (macro)
• write-nowiki (function)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)

3.1.9 ccldoc/output-html.lisp

Dependency

output-tracwiki.lisp (file)

Parent

ccldoc (system)

Location

output-html.lisp

Exported Definitions

output-html (function)

Internal Definitions

• clause-chapter (function)
• html-formatted-signature (function)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html-sidebar (function)
• write-html-toc (function)

3.1.10 ccldoc/output-latex.lisp

Dependency

output-html.lisp (file)

Parent

ccldoc (system)

Location

output-latex.lisp

Internal Definitions

• escape-char (function)
• escape-char-test (function)
• escape-for-latex (function)
• output-latex (function)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex-preamble (function)

3.1.11 ccldoc/output-ccldoc.lisp

Dependency

output-latex.lisp (file)

Parent

ccldoc (system)

Location

output-ccldoc.lisp

Exported Definitions

output-ccldoc (function)

Internal Definitions

• *ccldoc-pprint-dispatch* (special variable)
• *form-subforms-start* (special variable)
• combine-strings (function)
• decompile-body (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-clause-name (function)
• decompile-items (method)
• form-subforms-start (function)
• gensymcat (function)
• operator-sym-p (function)
• pprint-ccldoc (function)
• pprint-ccldoc-operator (function)
• pprint-ccldoc-table (function)
• prettify-ccldoc (function)
• stringyp (function)

4 Packages

Packages are listed by definition order.

4.1 ccldoc

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• block (class)
• clause (type)
• clause-body (generic function)
• clause-body (method)
• (setf clause-body) (method)
• (setf clause-body) (generic function)
• clause-document (generic function)
• clause-document (method)
• clause-document (method)
• clause-external-id (generic function)
• clause-external-id (method)
• (setf clause-external-id) (method)
• (setf clause-external-id) (generic function)
• clause-items (generic function)
• clause-items (method)
• clause-name (generic function)
• clause-name (method)
• (setf clause-name) (method)
• (setf clause-name) (generic function)
• clause-object (class)
• clause-parent (generic function)
• clause-parent (method)
• (setf clause-parent) (method)
• clause-parent (method)
• (setf clause-parent) (method)
• clause-parent (method)
• (setf clause-parent) (method)
• (setf clause-parent) (generic function)
• clause-term (generic function)
• clause-term (method)
• clause-text (generic function)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-text (method)
• clause-title (generic function)
• clause-title (method)
• clause-with-body (class)
• clause-with-items (class)
• clause-with-term (class)
• clause-with-title (class)
• code-block (class)
• def-definition-type (macro)
• def-expander (macro)
• definition (class)
• definition-display-name (generic function)
• definition-display-name (method)
• (setf definition-display-name) (method)
• (setf definition-display-name) (generic function)
• definition-signature (generic function)
• definition-signature (method)
• (setf definition-signature) (method)
• (setf definition-signature) (generic function)
• definition-summary (generic function)
• definition-summary (method)
• (setf definition-summary) (method)
• (setf definition-summary) (generic function)
• docerror (class)
• document (class)
• dspec (structure)
• dspec-name (function)
• (setf dspec-name) (function)
• dspec-type (function)
• (setf dspec-type) (function)
• dspec-type-name (function)
• glossary-section (function)
• glossary-section (class)
• glossentry (class)
• index-section (function)
• index-section (class)
• indexed-clause (class)
• item (class)
• link (class)
• link-url (generic function)
• link-url (method)
• listing (class)
• listing-type (generic function)
• listing-type (method)
• listing-type (type)
• load-document (function)
• markup (class)
• markup-type (generic function)
• markup-type (method)
• markup-type (type)
• named-clause (class)
• output-ccldoc (function)
• output-docbook (function)
• output-html (function)
• output-tracwiki (function)
• para (class)
• row (class)
• section (class)
• section-level (generic function)
• section-level (method)
• section-level (method)
• table (class)
• term-item (class)
• xref (class)
• xref-default-body (generic function)
• xref-default-body (method)
• xref-target (generic function)
• xref-target (method)

Internal Definitions

• %def-operator (function)
• %make-dspec (function)
• *ccldoc-fake-packages* (special variable)
• *ccldoc-pprint-dispatch* (special variable)
• *current-file* (special variable)
• *dspec-types* (special variable)
• *form-subforms-start* (special variable)
• *nowiki-context* (special variable)
• *operators* (special variable)
• *parent-clause* (special variable)
• *section-package* (special variable)
• *source-form* (special variable)
• *special-anywhere* (special variable)
• *special-at-start-of-line* (special variable)
• *whitespace-allowed-tags* (special variable)
• *wiki-indent* (special variable)
• *wiki-inline* (special variable)
• ancestor-of-type (function)
• as-fully-qualified-name (function)
• assign-external-ids (function)
• build-ccldoc (function)
• call-with-markup (function)
• canonical-clause-name-p (function)
• canonicalize-definition-name (function)
• canonicalize-ref-name (function)
• cassert (macro)
• ccldoc-macro-expander (function)
• ccldoc-macroexpand (function)
• ccldoc-operator (function)
• ccldoc-opinfo (function)
• ccldoc-package (function)
• ccldoc-string-parser (function)
• clause-chapter (function)
• clause-default-body (generic function)
• clause-default-body (method)
• clause-reference-name (generic function)
• clause-reference-name (method)
• clause-reference-name (method)
• clause-reference-name (method)
• clause-section (generic function)
• clause-section (method)
• clause-source-form (generic function)
• clause-source-form (method)
• clause-with-optional-title (class)
• clause-with-required-body (class)
• clause-with-required-title (class)
• collect-glossary-entries (function)
• combine-strings (function)
• concat-by (function)
• copy-dspec (function)
• copy-dspecinfo (function)
• copy-opinfo (function)
• decompile-body (generic function)
• decompile-body (method)
• decompile-ccldoc (generic function)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-ccldoc (method)
• decompile-clause-name (function)
• decompile-items (generic function)
• decompile-items (method)
• def-operator (macro)
• def-predicate (macro)
• default-operator (generic function)
• default-operator (method)
• default-operator (method)
• default-operator (method)
• default-operator (method)
• default-operator (method)
• default-operator (method)
• delim-pos (function)
• desym (function)
• disambiguate-ids (function)
• docbook-tag (function)
• docbook-tag-for-markup (function)
• docbook-tags-for-listing (function)
• docbook-title* (function)
• dspec-subtypep (function)
• dspec-type-for-type-name (function)
• dspec-type-name-p (function)
• dspecinfo-function (function)
• (setf dspecinfo-function) (function)
• dspecinfo-id-prefix (function)
• (setf dspecinfo-id-prefix) (function)
• dspecinfo-parent-type (function)
• (setf dspecinfo-parent-type) (function)
• dspecinfo-type (function)
• (setf dspecinfo-type) (function)
• dspecinfo-type-name (function)
• (setf dspecinfo-type-name) (function)
• dspecp (function)
• end-delim-pos (function)
• escape-char (function)
• escape-char-test (function)
• escape-for-latex (function)
• external-id-for-clause (generic function)
• external-id-for-clause (method)
• external-id-for-clause (method)
• external-id-for-clause (method)
• external-id-for-name (function)
• external-id-string (function)
• external-ids (generic function)
• external-ids (method)
• find-clause (function)
• form-clause (function)
• form-clause-by-operator (function)
• form-clause-ensuring-simple (function)
• form-subforms-start (function)
• function-for-dspec-type (function)
• generate-body-list (function)
• generate-docbook-form (generic function)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-form (method)
• generate-docbook-list (generic function)
• generate-docbook-list (method)
• generate-docbook-list (method)
• gensymcat (function)
• gensymp (function)
• html-formatted-signature (function)
• id-prefix-for-dspec-type (function)
• info-for-dspec-type (function)
• inline-clause (class)
• inline-clause-p (generic function)
• inline-clause-p (method)
• inline-clause-p (method)
• inline-clause-p (method)
• inline-clause-p (method)
• lisp-from-string (function)
• load-to-ccldoc-form (function)
• make-arg-reader (function)
• make-dspec (function)
• make-dspecinfo (function)
• make-opinfo (function)
• make-wild-dspec (function)
• matching-clauses (function)
• named-clauses (generic function)
• named-clauses (method)
• named-clauses-count (function)
• norm-for-external-id (function)
• normalize-title (function)
• normalize-whitespace (function)
• op-name (function)
• op-name-p (function)
• operator-sym-p (function)
• opinfo-function (function)
• (setf opinfo-function) (function)
• opinfo-parser (function)
• (setf opinfo-parser) (function)
• opinfo-type (function)
• (setf opinfo-type) (function)
• output-latex (function)
• para-subforms-to-body (generic function)
• para-subforms-to-body (method)
• parent-type-for-dspec-type (function)
• parse-arg-and-options (function)
• parse-ccldoc-string (function)
• placeholder-target-name (generic function)
• placeholder-target-name (method)
• pprint-ccldoc (function)
• pprint-ccldoc-operator (function)
• pprint-ccldoc-table (function)
• prettify-ccldoc (function)
• princ-ccldoc (generic function)
• princ-ccldoc (method)
• read-all-from-string (function)
• read-ccldoc-document (function)
• reference-placeholder (class)
• register-dspec-type (function)
• resolve-placeholder (function)
• resolve-xref-targets (function)
• section-name-p (function)
• std-dspec-name (function)
• string-chunk (function)
• string-dspec-name (function)
• stringyp (function)
• subclause-slots (generic function)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subclause-slots (method)
• subforms-clause (function)
• subforms-items (function)
• subforms-to-body (generic function)
• subforms-to-body (method)
• subforms-to-items (generic function)
• subforms-to-items (method)
• symbol-dspec-name (function)
• table-name-p (function)
• text-for-clause-name (function)
• wiki-blankline (function)
• wiki-freshline (function)
• wiki-newline (function)
• wild-dspec-p (function)
• wild-name-match-p (function)
• wildcard-canonical-name-p (function)
• with-ccldoc-packages (macro)
• with-markup (macro)
• write-html (generic function)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html (method)
• write-html-sidebar (function)
• write-html-toc (function)
• write-latex (generic function)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex (method)
• write-latex-preamble (function)
• write-nowiki (function)
• write-tracwiki (generic function)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)
• write-tracwiki (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: def-definition-type TYPE (&optional PARENT-TYPE) &key TYPE-NAME ID-PREFIX FUNCTION

Package

ccldoc

Source

utils.lisp (file)

Macro: def-expander NAME PARAMS &body BODY

Package

ccldoc

Source

toplevel.lisp (file)

5.1.2 Functions

Function: dspec-name INSTANCE

Function: (setf dspec-name) VALUE INSTANCE

Package

ccldoc

Source

utils.lisp (file)

Function: dspec-type INSTANCE

Function: (setf dspec-type) VALUE INSTANCE

Package

ccldoc

Source

utils.lisp (file)

Function: dspec-type-name DSPEC

Package

ccldoc

Source

utils.lisp (file)

Function: glossary-section DOC

Package

ccldoc

Source

representation.lisp (file)

Function: index-section DOC

Package

ccldoc

Source

representation.lisp (file)

Function: load-document FILENAME &key EXTERNAL-FORMAT

Package

ccldoc

Source

toplevel.lisp (file)

Function: output-ccldoc OBJECT FILENAME &key EXTERNAL-FORMAT IF-EXISTS

Package

ccldoc

Source

output-ccldoc.lisp (file)

Function: output-docbook DOC FILENAME &key EXTERNAL-FORMAT IF-EXISTS

Package

ccldoc

Source

output-docbook.lisp (file)

Function: output-html DOC FILENAME &key EXTERNAL-FORMAT IF-EXISTS STYLESHEET

Package

ccldoc

Source

output-html.lisp (file)

Function: output-tracwiki DOC FILENAME &key EXTERNAL-FORMAT IF-EXISTS

Package

ccldoc

Source

output-tracwiki.lisp (file)

5.1.3 Generic functions

Generic Function: clause-body OBJECT

Generic Function: (setf clause-body) NEW-VALUE OBJECT

Package

ccldoc

Methods

Method: clause-body (CLAUSE-WITH-BODY clause-with-body)

automatically generated reader method

Source

representation.lisp (file)

Method: (setf clause-body) NEW-VALUE (CLAUSE-WITH-BODY clause-with-body)

automatically generated writer method

Source

representation.lisp (file)

Generic Function: clause-document CLAUSE

Package

ccldoc

Methods

Method: clause-document (CLAUSE document)

Source

representation.lisp (file)

Method: clause-document (CLAUSE clause-object)

Source

representation.lisp (file)

Generic Function: clause-external-id OBJECT

Generic Function: (setf clause-external-id) NEW-VALUE OBJECT

Package

ccldoc

Methods

Method: clause-external-id (NAMED-CLAUSE named-clause)

automatically generated reader method

Source

representation.lisp (file)

Method: (setf clause-external-id) NEW-VALUE (NAMED-CLAUSE named-clause)

automatically generated writer method

Source

representation.lisp (file)

Generic Function: clause-items OBJECT

Package

ccldoc

Methods

Method: clause-items (CLAUSE-WITH-ITEMS clause-with-items)

automatically generated reader method

Source

representation.lisp (file)

Generic Function: clause-name OBJECT

Generic Function: (setf clause-name) NEW-VALUE OBJECT

Package

ccldoc

Methods

Method: clause-name (NAMED-CLAUSE named-clause)

automatically generated reader method

Source

representation.lisp (file)

Method: (setf clause-name) NEW-VALUE (NAMED-CLAUSE named-clause)

automatically generated writer method

Source

representation.lisp (file)

Generic Function: clause-parent OBJECT

Generic Function: (setf clause-parent) NEW-VALUE OBJECT

Package

ccldoc

Methods

Method: clause-parent (STRING string)

Method: (setf clause-parent) PARENT (STRING string)

Source

representation.lisp (file)

Method: clause-parent (LIST cons)

Method: (setf clause-parent) PARENT (LIST cons)

Source

representation.lisp (file)

Method: clause-parent (CLAUSE-OBJECT clause-object)

automatically generated reader method

Source

representation.lisp (file)

Method: (setf clause-parent) NEW-VALUE (CLAUSE-OBJECT clause-object)

automatically generated writer method

Source

representation.lisp (file)

Generic Function: clause-term OBJECT

Package

ccldoc

Methods

Method: clause-term (CLAUSE-WITH-TERM clause-with-term)

automatically generated reader method

Source

representation.lisp (file)

Generic Function: clause-text CLAUSE

Package

ccldoc

Methods

Method: clause-text (CLAUSE glossentry)

Source

representation.lisp (file)

Method: clause-text (CLAUSE definition)

Source

representation.lisp (file)

Method: clause-text (CLAUSE row)

Source

representation.lisp (file)

Method: clause-text (CLAUSE para)

Source

representation.lisp (file)

Method: clause-text (CLAUSE term-item)

Source

representation.lisp (file)

Method: clause-text (CLAUSE clause-with-items)

Source

representation.lisp (file)

Method: clause-text (CLAUSE clause-with-body)

Source

representation.lisp (file)

Method: clause-text (CLAUSE clause-with-title)

Source

representation.lisp (file)

Method: clause-text (DOCERROR docerror)

automatically generated reader method

Source

representation.lisp (file)

Method: clause-text (CLAUSES list)

Source

representation.lisp (file)

Method: clause-text (CLAUSE clause-object)

Source

representation.lisp (file)

Method: clause-text (CLAUSE string)

Source

representation.lisp (file)

Generic Function: clause-title OBJECT

Package

ccldoc

Methods

Method: clause-title (CLAUSE-WITH-TITLE clause-with-title)

automatically generated reader method

Source

representation.lisp (file)

Generic Function: definition-display-name OBJECT

Generic Function: (setf definition-display-name) NEW-VALUE OBJECT

Package

ccldoc

Methods

Method: definition-display-name (DEFINITION definition)

automatically generated reader method

Source

representation.lisp (file)

Method: (setf definition-display-name) NEW-VALUE (DEFINITION definition)

automatically generated writer method

Source

representation.lisp (file)

Generic Function: definition-signature OBJECT

Generic Function: (setf definition-signature) NEW-VALUE OBJECT

Package

ccldoc

Methods

Method: definition-signature (DEFINITION definition)

automatically generated reader method

Source

representation.lisp (file)

Method: (setf definition-signature) NEW-VALUE (DEFINITION definition)

automatically generated writer method

Source

representation.lisp (file)

Generic Function: definition-summary OBJECT

Generic Function: (setf definition-summary) NEW-VALUE OBJECT

Package

ccldoc

Methods

Method: definition-summary (DEFINITION definition)

automatically generated reader method

Source

representation.lisp (file)

Method: (setf definition-summary) NEW-VALUE (DEFINITION definition)

automatically generated writer method

Source

representation.lisp (file)

Generic Function: link-url OBJECT

Package

ccldoc

Methods

Method: link-url (LINK link)

automatically generated reader method

Source

representation.lisp (file)

Generic Function: listing-type OBJECT

Package

ccldoc

Methods

Method: listing-type (LISTING listing)

automatically generated reader method

Source

representation.lisp (file)

Generic Function: markup-type OBJECT

Package

ccldoc

Methods

Method: markup-type (MARKUP markup)

automatically generated reader method

Source

representation.lisp (file)

Generic Function: section-level CLAUSE

Package

ccldoc

Methods

Method: section-level (CLAUSE section)

Source

representation.lisp (file)

Method: section-level (CLAUSE clause-object)

Source

representation.lisp (file)

Generic Function: xref-default-body OBJECT

Package

ccldoc

Methods

Method: xref-default-body (XREF xref)

automatically generated reader method

Source

representation.lisp (file)

Generic Function: xref-target OBJECT

Package

ccldoc

Methods

Method: xref-target (XREF xref)

automatically generated reader method

Source

representation.lisp (file)

5.1.4 Structures

Structure: dspec ()

Package

ccldoc

Source

utils.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: type

Type

(satisfies ccldoc::dspec-type-name-p)

Initform

t

Readers

dspec-type (function)

Writers

(setf dspec-type) (function)

Slot: name

Readers

dspec-name (function)

Writers

(setf dspec-name) (function)

5.1.5 Classes

Class: block ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• clause-with-body (class)
• clause-with-optional-title (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)

Class: clause-object ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• inline-clause (class)
• docerror (class)
• named-clause (class)
• clause-with-title (class)
• clause-with-body (class)
• clause-with-term (class)
• clause-with-items (class)

Direct methods

• decompile-ccldoc (method)
• clause-text (method)
• section-level (method)
• clause-document (method)
• clause-section (method)
• subclause-slots (method)
• princ-ccldoc (method)
• print-object (method)
• inline-clause-p (method)
• default-operator (method)
• clause-source-form (method)
• clause-parent (method)
• clause-parent (method)

Direct slots

Slot: parent

Type

(or null ccldoc:clause-object)

Initform

ccldoc::*parent-clause*

Readers

clause-parent (generic function)

Writers

(setf clause-parent) (generic function)

Slot: source-form

Initform

ccldoc::*source-form*

Readers

clause-source-form (generic function)

Class: clause-with-body ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-object (class)

Direct subclasses

• clause-with-required-body (class)
• item (class)
• term-item (class)
• para (class)
• block (class)
• markup (class)
• code-block (class)
• definition (class)
• glossentry (class)
• indexed-clause (class)
• section (class)

Direct methods

• decompile-body (method)
• decompile-ccldoc (method)
• subforms-to-body (method)
• para-subforms-to-body (method)
• clause-text (method)
• subclause-slots (method)
• clause-body (method)
• clause-body (method)

Direct slots

Slot: body

Type

(or null ccldoc:clause)

Readers

clause-body (generic function)

Writers

(setf clause-body) (generic function)

Class: clause-with-items ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-object (class)

Direct subclasses

• listing (class)
• row (class)
• table (class)

Direct methods

• decompile-items (method)
• subforms-to-items (method)
• clause-text (method)
• subclause-slots (method)
• clause-items (method)

Direct slots

Slot: items

Type

vector

Readers

clause-items (generic function)

Class: clause-with-term ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-object (class)

Direct subclasses

• term-item (class)
• glossentry (class)

Direct methods

• subclause-slots (method)
• clause-term (method)

Direct slots

Slot: term

Type

(or null ccldoc:clause)

Initargs

:term

Readers

clause-term (generic function)

Class: clause-with-title ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-object (class)

Direct subclasses

• clause-with-required-title (class)
• clause-with-optional-title (class)

Direct methods

• clause-text (method)
• clause-title (method)

Direct slots

Slot: title

Initargs

:title

Readers

clause-title (generic function)

Class: code-block ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-with-body (class)

Direct methods

• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)

Class: definition ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• clause-with-body (class)
• named-clause (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• clause-text (method)
• clause-reference-name (method)
• subclause-slots (method)
• definition-summary (method)
• definition-summary (method)
• definition-signature (method)
• definition-signature (method)
• definition-display-name (method)
• definition-display-name (method)

Direct slots

Slot: display-name

Type

ccldoc:clause

Readers

definition-display-name (generic function)

Writers

(setf definition-display-name) (generic function)

Slot: signature

Type

ccldoc:clause

Readers

definition-signature (generic function)

Writers

(setf definition-signature) (generic function)

Slot: summary

Type

(or null ccldoc:clause)

Readers

definition-summary (generic function)

Writers

(setf definition-summary) (generic function)

Class: docerror ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-object (class)

Direct methods

• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• clause-text (method)

Direct slots

Slot: clause-text

Initargs

:message

Readers

clause-text (generic function)

Class: document ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

section (class)

Direct methods

• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• external-id-for-clause (method)
• clause-document (method)
• external-ids (method)
• named-clauses (method)

Direct slots

Slot: parent

Type

null

Slot: named-clauses

Initform

(make-hash-table :test (function equalp))

Readers

named-clauses (generic function)

Slot: external-ids

Initform

(make-hash-table :test (function equal))

Readers

external-ids (generic function)

Class: glossary-section ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

section (class)

Direct methods

• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)

Class: glossentry ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• clause-with-body (class)
• clause-with-term (class)
• named-clause (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• clause-reference-name (method)
• clause-text (method)

Class: index-section ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

section (class)

Direct methods

• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)

Direct slots

Slot: body

Type

null

Class: indexed-clause ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• inline-clause (class)
• clause-with-body (class)

Direct subclasses

• xref (class)
• reference-placeholder (class)

Direct methods

• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• subclause-slots (method)
• default-operator (method)

Direct slots

Slot: default-operator

Allocation

:class

Initform

(ccldoc::op-name :index)

Readers

default-operator (generic function)

Class: item ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-with-body (class)

Direct subclasses

term-item (class)

Direct methods

• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)

Class: link ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• inline-clause (class)
• clause-with-required-body (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• link-url (method)

Direct slots

Slot: url

Type

string

Initargs

:url

Readers

link-url (generic function)

Class: listing ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-with-items (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• listing-type (method)

Direct slots

Slot: listing-type

Type

ccldoc:listing-type

Initargs

:type

Readers

listing-type (generic function)

Class: markup ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• inline-clause (class)
• clause-with-body (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• markup-type (method)

Direct slots

Slot: markup-type

Type

ccldoc:markup-type

Initargs

:type

Readers

markup-type (generic function)

Class: named-clause ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-object (class)

Direct subclasses

• clause-with-required-title (class)
• definition (class)
• glossentry (class)

Direct methods

• write-latex (method)
• write-html (method)
• initialize-instance (method)
• clause-external-id (method)
• clause-external-id (method)
• clause-name (method)
• clause-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

clause-name (generic function)

Writers

(setf clause-name) (generic function)

Slot: external-id

Type

string

Readers

clause-external-id (generic function)

Writers

(setf clause-external-id) (generic function)

Class: para ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-with-body (class)

Direct methods

• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• clause-text (method)

Class: row ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

clause-with-items (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• clause-text (method)

Class: section ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• clause-with-body (class)
• clause-with-required-title (class)

Direct subclasses

• glossary-section (class)
• index-section (class)
• document (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• section-level (method)
• initialize-instance (method)
• default-operator (method)

Direct slots

Slot: default-operator

Allocation

:class

Initform

(ccldoc::op-name :defsection)

Readers

default-operator (generic function)

Slot: package

Initargs

:package

Class: table ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• clause-with-items (class)
• clause-with-required-title (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• external-id-for-clause (method)
• initialize-instance (method)

Class: term-item ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

• clause-with-body (class)
• clause-with-term (class)
• item (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• clause-text (method)
• default-operator (method)

Direct slots

Slot: default-operator

Allocation

:class

Initform

(ccldoc::op-name :item)

Readers

default-operator (generic function)

Class: xref ()

Package

ccldoc

Source

representation.lisp (file)

Direct superclasses

indexed-clause (class)

Direct methods

• decompile-ccldoc (method)
• write-latex (method)
• write-html (method)
• write-tracwiki (method)
• generate-docbook-form (method)
• xref-target (method)
• xref-default-body (method)
• default-operator (method)

Direct slots

Slot: default-operator

Allocation

:class

Initform

(ccldoc::op-name :ref)

Readers

default-operator (generic function)

Slot: default-body

Initargs

:default-body

Readers

xref-default-body (generic function)

Slot: target

Type

ccldoc:named-clause

Initargs

:target

Readers

xref-target (generic function)

5.1.6 Types

Type: clause ()

Package

ccldoc

Source

representation.lisp (file)

Type: listing-type ()

Package

ccldoc

Source

representation.lisp (file)

Type: markup-type ()

Package

ccldoc

Source

representation.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *ccldoc-fake-packages*

Package

ccldoc

Source

utils.lisp (file)

Special Variable: *ccldoc-pprint-dispatch*

Package

ccldoc

Source

output-ccldoc.lisp (file)

Special Variable: *current-file*

Package

ccldoc

Source

representation.lisp (file)

Special Variable: *dspec-types*

Package

ccldoc

Source

utils.lisp (file)

Special Variable: *form-subforms-start*

Package

ccldoc

Source

output-ccldoc.lisp (file)

Special Variable: *nowiki-context*

Package

ccldoc

Source

output-tracwiki.lisp (file)

Special Variable: *operators*

Package

ccldoc

Source

toplevel.lisp (file)

Special Variable: *parent-clause*

Package

ccldoc

Source

representation.lisp (file)

Special Variable: *section-package*

Package

ccldoc

Source

representation.lisp (file)

Special Variable: *source-form*

Package

ccldoc

Source

representation.lisp (file)

Special Variable: *special-anywhere*

Package

ccldoc

Source

output-tracwiki.lisp (file)

Special Variable: *special-at-start-of-line*

Package

ccldoc

Source

output-tracwiki.lisp (file)

Special Variable: *whitespace-allowed-tags*

Package

ccldoc

Source

utils.lisp (file)

Special Variable: *wiki-indent*

Package

ccldoc

Source

output-tracwiki.lisp (file)

Special Variable: *wiki-inline*

Package

ccldoc

Source

output-tracwiki.lisp (file)

5.2.2 Macros

Macro: cassert FORM &rest ERROR-ARGS

Package

ccldoc

Source

utils.lisp (file)

Macro: def-operator NAME PARAMS &body BODY

Package

ccldoc

Source

toplevel.lisp (file)

Macro: def-predicate NAME TYPE

Package

ccldoc

Source

utils.lisp (file)

Macro: with-ccldoc-packages &body BODY

Package

ccldoc

Source

utils.lisp (file)

Macro: with-markup (STREAM-VAR START-TEXT END-TEXT) &body BODY

Package

ccldoc

Source

output-tracwiki.lisp (file)

5.2.3 Functions

Function: %def-operator TYPE OP-NAME PARAMS FN DOCSTRING &key PARSER-TYPES

Package

ccldoc

Source

toplevel.lisp (file)

Function: %make-dspec &key (TYPE TYPE) (NAME NAME)

Package

ccldoc

Source

utils.lisp (file)

Function: ancestor-of-type CLAUSE-OBJECT TYPE

Package

ccldoc

Source

representation.lisp (file)

Function: as-fully-qualified-name DOC NAME

Package

ccldoc

Source

representation.lisp (file)

Function: assign-external-ids DOC

Package

ccldoc

Source

toplevel.lisp (file)

Function: build-ccldoc DOC-FORM &key DEFAULT-FILE

Package

ccldoc

Source

toplevel.lisp (file)

Function: call-with-markup START-TEXT END-TEXT STREAM FN

Package

ccldoc

Source

output-tracwiki.lisp (file)

Function: canonical-clause-name-p NAME

Package

ccldoc

Source

representation.lisp (file)

Function: canonicalize-definition-name TYPE NAME

Package

ccldoc

Source

utils.lisp (file)

Function: canonicalize-ref-name NAME

Package

ccldoc

Source

syntax.lisp (file)

Function: ccldoc-macro-expander NAME

Package

ccldoc

Source

toplevel.lisp (file)

Function: ccldoc-macroexpand FORM

Package

ccldoc

Source

toplevel.lisp (file)

Function: ccldoc-operator NAME

Package

ccldoc

Source

toplevel.lisp (file)

Function: ccldoc-opinfo NAME

Package

ccldoc

Source

toplevel.lisp (file)

Function: ccldoc-package NAME

Package

ccldoc

Source

utils.lisp (file)

Function: ccldoc-string-parser NAME

Package

ccldoc

Source

toplevel.lisp (file)

Function: clause-chapter CLAUSE

Package

ccldoc

Source

output-html.lisp (file)

Function: collect-glossary-entries DOC

Package

ccldoc

Source

syntax.lisp (file)

Function: combine-strings LIST

Package

ccldoc

Source

output-ccldoc.lisp (file)

Function: concat-by SEP &rest STRINGS

Package

ccldoc

Source

utils.lisp (file)

Function: copy-dspec INSTANCE

Package

ccldoc

Source

utils.lisp (file)

Function: copy-dspecinfo SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

ccldoc

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: copy-opinfo SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

ccldoc

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: decompile-clause-name NAME

Package

ccldoc

Source

output-ccldoc.lisp (file)

Function: delim-pos STRING START &optional END

Package

ccldoc

Source

toplevel.lisp (file)

Function: desym THING

Package

ccldoc

Source

utils.lisp (file)

Function: disambiguate-ids SIMPLE-ID CLAUSES

Package

ccldoc

Source

toplevel.lisp (file)

Function: docbook-tag CLAUSE TAG-NAME

Package

ccldoc

Source

output-docbook.lisp (file)

Function: docbook-tag-for-markup TYPE

Package

ccldoc

Source

output-docbook.lisp (file)

Function: docbook-tags-for-listing TYPE

Package

ccldoc

Source

output-docbook.lisp (file)

Function: docbook-title* CLAUSE

Package

ccldoc

Source

output-docbook.lisp (file)

Function: dspec-subtypep TYPE SUPER

Package

ccldoc

Source

utils.lisp (file)

Function: dspec-type-for-type-name TYPE-NAME

Package

ccldoc

Source

utils.lisp (file)

Function: dspec-type-name-p TYPE

Package

ccldoc

Source

utils.lisp (file)

Function: dspecinfo-function STRUCTURE

Function: (setf dspecinfo-function) VALUE STRUCTURE

Package

ccldoc

Source

utils.lisp (file)

Function: dspecinfo-id-prefix STRUCTURE

Function: (setf dspecinfo-id-prefix) VALUE STRUCTURE

Package

ccldoc

Source

utils.lisp (file)

Function: dspecinfo-parent-type STRUCTURE

Function: (setf dspecinfo-parent-type) VALUE STRUCTURE

Package

ccldoc

Source

utils.lisp (file)

Function: dspecinfo-type STRUCTURE

Function: (setf dspecinfo-type) VALUE STRUCTURE

Package

ccldoc

Source

utils.lisp (file)

Function: dspecinfo-type-name STRUCTURE

Function: (setf dspecinfo-type-name) VALUE STRUCTURE

Package

ccldoc

Source

utils.lisp (file)

Function: dspecp OBJECT

Package

ccldoc

Source

utils.lisp (file)

Function: end-delim-pos STRING START &optional END

Package

ccldoc

Source

toplevel.lisp (file)

Function: escape-char CHAR

Package

ccldoc

Source

output-latex.lisp (file)

Function: escape-char-test CHAR

Package

ccldoc

Source

output-latex.lisp (file)

Function: escape-for-latex STRING &key TEST

Package

ccldoc

Source

output-latex.lisp (file)