The ccldoc Reference Manual

Child 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.

Lisp

3.1.1 `ccldoc/ccldoc.asd`

Source: ccldoc.asd.
Parent Component: ccldoc (system).
ASDF Systems: ccldoc.

3.1.2 `ccldoc/package.lisp`

Source: ccldoc.asd.
Parent Component: ccldoc (system).
Packages: ccldoc.

3.1.3 `ccldoc/utils.lisp`

Dependency

package.lisp (file).

Source

Parent Component

ccldoc (system).

Public Interface

def-definition-type (macro).
dspec (structure).
dspec-name (reader).
(setf dspec-name) (writer).
dspec-type (reader).
(setf dspec-type) (writer).
dspec-type-name (function).

Internals

%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).

Source

Parent Component

ccldoc (system).

Public Interface

clause (type).
clause-body (reader method).
(setf clause-body) (writer method).
clause-document (method).
clause-document (method).
clause-external-id (reader method).
(setf clause-external-id) (writer method).
clause-items (reader method).
clause-name (reader method).
(setf clause-name) (writer method).
clause-object (class).
clause-parent (method).
clause-parent (method).
clause-parent (reader method).
(setf clause-parent) (method).
(setf clause-parent) (method).
(setf clause-parent) (writer method).
clause-term (reader 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 (reader method).
clause-text (method).
clause-text (method).
clause-text (method).
clause-title (reader 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 (reader method).
(setf definition-display-name) (writer method).
definition-signature (reader method).
(setf definition-signature) (writer method).
definition-summary (reader method).
(setf definition-summary) (writer method).
docerror (class).
document (class).
glossary-section (function).
glossary-section (class).
glossentry (class).
index-section (function).
index-section (class).
indexed-clause (class).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
item (class).
link (class).
link-url (reader method).
listing (class).
listing-type (reader method).
listing-type (type).
markup (class).
markup-type (reader method).
markup-type (type).
named-clause (class).
para (class).
print-object (method).
row (class).
section (class).
section-level (method).
section-level (method).
table (class).
term-item (class).
text-block (class).
xref (class).
xref-default-body (reader method).
xref-target (reader method).

Internals

*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 (reader method).
clause-reference-name (method).
clause-reference-name (method).
clause-reference-name (method).
clause-section (method).
clause-source-form (reader method).
clause-with-optional-title (class).
clause-with-required-body (class).
clause-with-required-title (class).
default-operator (reader method).
default-operator (reader method).
default-operator (reader method).
default-operator (reader method).
default-operator (reader method).
default-operator (method).
external-ids (reader method).
find-clause (function).
inline-clause (class).
inline-clause-p (generic function).
matching-clauses (function).
named-clauses (reader method).
named-clauses-count (function).
placeholder-target-name (reader method).
princ-ccldoc (method).
reference-placeholder (class).
resolve-placeholder (function).
resolve-xref-targets (function).
section-name-p (function).
subclause-slots (generic function).
table-name-p (function).
wild-name-match-p (function).
wildcard-canonical-name-p (function).

3.1.5 `ccldoc/toplevel.lisp`

Dependency

representation.lisp (file).

Source

Parent Component

ccldoc (system).

Public Interface

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

Internals

%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).

Source

Parent Component

ccldoc (system).

Internals

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).

Source

Parent Component

ccldoc (system).

Public Interface

output-docbook (function).

Internals

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).

Source

Parent Component

ccldoc (system).

Public Interface

output-tracwiki (function).

Internals

*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).

Source

Parent Component

ccldoc (system).

Public Interface

output-html (function).

Internals

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).

Source

Parent Component

ccldoc (system).

Internals

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).

Source

Parent Component

ccldoc (system).

Public Interface

output-ccldoc (function).

Internals

*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.

ccldoc

4.1 `ccldoc`

Source

package.lisp.

Use List

common-lisp.

Public Interface

clause (type).
clause-body (generic reader).
(setf clause-body) (generic writer).
clause-document (generic function).
clause-external-id (generic reader).
(setf clause-external-id) (generic writer).
clause-items (generic reader).
clause-name (generic reader).
(setf clause-name) (generic writer).
clause-object (class).
clause-parent (generic function).
(setf clause-parent) (generic function).
clause-term (generic reader).
clause-text (generic function).
clause-title (generic reader).
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 reader).
(setf definition-display-name) (generic writer).
definition-signature (generic reader).
(setf definition-signature) (generic writer).
definition-summary (generic reader).
(setf definition-summary) (generic writer).
docerror (class).
document (class).
dspec (structure).
dspec-name (reader).
(setf dspec-name) (writer).
dspec-type (reader).
(setf dspec-type) (writer).
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 reader).
listing (class).
listing-type (generic reader).
listing-type (type).
load-document (function).
markup (class).
markup-type (generic reader).
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).
table (class).
term-item (class).
text-block (class).
xref (class).
xref-default-body (generic reader).
xref-target (generic reader).

Internals

%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 reader).
clause-reference-name (generic function).
clause-section (generic function).
clause-source-form (generic reader).
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-ccldoc (generic function).
decompile-clause-name (function).
decompile-items (generic function).
def-operator (macro).
def-predicate (macro).
default-operator (generic function).
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-name (function).
external-id-string (function).
external-ids (generic reader).
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-list (generic function).
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).
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 reader).
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).
parent-type-for-dspec-type (function).
parse-arg-and-options (function).
parse-ccldoc-string (function).
placeholder-target-name (generic reader).
pprint-ccldoc (function).
pprint-ccldoc-operator (function).
pprint-ccldoc-table (function).
prettify-ccldoc (function).
princ-ccldoc (generic function).
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).
subforms-clause (function).
subforms-items (function).
subforms-to-body (generic function).
subforms-to-items (generic function).
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-sidebar (function).
write-html-toc (function).
write-latex (generic function).
write-latex-preamble (function).
write-nowiki (function).
write-tracwiki (generic function).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Macros
Ordinary functions
Generic functions
Standalone methods
Structures
Classes
Types

5.1.1 Macros

Macro: def-definition-type (type (&optional parent-type) &key type-name id-prefix function) ¶

Package: ccldoc.
Source: utils.lisp.

Macro: def-expander (name params &body body) ¶

Package: ccldoc.
Source: toplevel.lisp.

5.1.2 Ordinary functions

Reader: dspec-name (instance) ¶

Writer: (setf dspec-name) (instance) ¶

Package: ccldoc.
Source: utils.lisp.
Target Slot: name.

Reader: dspec-type (instance) ¶

Writer: (setf dspec-type) (instance) ¶

Package: ccldoc.
Source: utils.lisp.
Target Slot: type.

Function: dspec-type-name (dspec) ¶

Package: ccldoc.
Source: utils.lisp.

Function: glossary-section (doc) ¶

Package: ccldoc.
Source: representation.lisp.

Function: index-section (doc) ¶

Package: ccldoc.
Source: representation.lisp.

Function: load-document (filename &key external-format) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: output-ccldoc (object filename &key external-format if-exists) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: output-docbook (doc filename &key external-format if-exists) ¶

Package: ccldoc.
Source: output-docbook.lisp.

Function: output-html (doc filename &key external-format if-exists stylesheet) ¶

Package: ccldoc.
Source: output-html.lisp.

Function: output-tracwiki (doc filename &key external-format if-exists) ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

5.1.3 Generic functions

Generic Reader: clause-body (object) ¶

Package

Methods

Reader Method: clause-body ((clause-with-body clause-with-body)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: body.

Generic Writer: (setf clause-body) (object) ¶

Package

Methods

Writer Method: (setf clause-body) ((clause-with-body clause-with-body)) ¶

automatically generated writer method

Source: representation.lisp.
Target Slot: body.

Generic Function: clause-document (clause) ¶

Package

Methods

Method: clause-document ((clause document)) ¶

Source: representation.lisp.

Method: clause-document ((clause clause-object)) ¶

Source: representation.lisp.

Generic Reader: clause-external-id (object) ¶

Package

Methods

Reader Method: clause-external-id ((named-clause named-clause)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: external-id.

Generic Writer: (setf clause-external-id) (object) ¶

Package

Methods

Writer Method: (setf clause-external-id) ((named-clause named-clause)) ¶

automatically generated writer method

Source: representation.lisp.
Target Slot: external-id.

Generic Reader: clause-items (object) ¶

Package

Methods

Reader Method: clause-items ((clause-with-items clause-with-items)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: items.

Generic Reader: clause-name (object) ¶

Package

Methods

Reader Method: clause-name ((named-clause named-clause)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: name.

Generic Writer: (setf clause-name) (object) ¶

Package

Methods

Writer Method: (setf clause-name) ((named-clause named-clause)) ¶

automatically generated writer method

Source: representation.lisp.
Target Slot: name.

Generic Function: clause-parent (object) ¶

Package

Methods

Method: clause-parent ((string string)) ¶

Source: representation.lisp.

Method: clause-parent ((list cons)) ¶

Source: representation.lisp.

Reader Method: clause-parent ((clause-object clause-object)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: parent.

Generic Function: (setf clause-parent) (object) ¶

Package

Methods

Method: (setf clause-parent) ((string string)) ¶

Source: representation.lisp.

Method: (setf clause-parent) ((list cons)) ¶

Source: representation.lisp.

Writer Method: (setf clause-parent) ((clause-object clause-object)) ¶

automatically generated writer method

Source: representation.lisp.
Target Slot: parent.

Generic Reader: clause-term (object) ¶

Package

Methods

Reader Method: clause-term ((clause-with-term clause-with-term)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: term.

Generic Function: clause-text (clause) ¶

Package

Methods

Method: clause-text ((clause glossentry)) ¶

Source: representation.lisp.

Method: clause-text ((clause definition)) ¶

Source: representation.lisp.

Method: clause-text ((clause row)) ¶

Source: representation.lisp.

Method: clause-text ((clause para)) ¶

Source: representation.lisp.

Method: clause-text ((clause term-item)) ¶

Source: representation.lisp.

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

Source: representation.lisp.

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

Source: representation.lisp.

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

Source: representation.lisp.

Reader Method: clause-text ((docerror docerror)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: clause-text.

Method: clause-text ((clauses list)) ¶

Source: representation.lisp.

Method: clause-text ((clause clause-object)) ¶

Source: representation.lisp.

Method: clause-text ((clause string)) ¶

Source: representation.lisp.

Generic Reader: clause-title (object) ¶

Package

Methods

Reader Method: clause-title ((clause-with-title clause-with-title)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: title.

Generic Reader: definition-display-name (object) ¶

Package

Methods

Reader Method: definition-display-name ((definition definition)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: display-name.

Generic Writer: (setf definition-display-name) (object) ¶

Package

Methods

Writer Method: (setf definition-display-name) ((definition definition)) ¶

automatically generated writer method

Source: representation.lisp.
Target Slot: display-name.

Generic Reader: definition-signature (object) ¶

Package

Methods

Reader Method: definition-signature ((definition definition)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: signature.

Generic Writer: (setf definition-signature) (object) ¶

Package

Methods

Writer Method: (setf definition-signature) ((definition definition)) ¶

automatically generated writer method

Source: representation.lisp.
Target Slot: signature.

Generic Reader: definition-summary (object) ¶

Package

Methods

Reader Method: definition-summary ((definition definition)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: summary.

Generic Writer: (setf definition-summary) (object) ¶

Package

Methods

Writer Method: (setf definition-summary) ((definition definition)) ¶

automatically generated writer method

Source: representation.lisp.
Target Slot: summary.

Generic Reader: link-url (object) ¶

Package

Methods

Reader Method: link-url ((link link)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: url.

Generic Reader: listing-type (object) ¶

Package

Methods

Reader Method: listing-type ((listing listing)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: listing-type.

Generic Reader: markup-type (object) ¶

Package

Methods

Reader Method: markup-type ((markup markup)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: markup-type.

Generic Function: section-level (clause) ¶

Package

Methods

Method: section-level ((clause section)) ¶

Source: representation.lisp.

Method: section-level ((clause clause-object)) ¶

Source: representation.lisp.

Generic Reader: xref-default-body (object) ¶

Package

Methods

Reader Method: xref-default-body ((xref xref)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: default-body.

Generic Reader: xref-target (object) ¶

Package

Methods

Reader Method: xref-target ((xref xref)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: target.

5.1.4 Standalone methods

Method: initialize-instance :after ((clause table) &key) ¶

Source: representation.lisp.

Method: initialize-instance :around ((clause named-clause) &key) ¶

Source: representation.lisp.

Method: initialize-instance :after ((clause section) &key) ¶

Source: representation.lisp.

Method: print-object ((c clause-object) stream) ¶

Source: representation.lisp.

5.1.5 Structures

Structure: dspec ¶

Package

Source

utils.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: type ¶

Package: common-lisp.
Type: (satisfies ccldoc::dspec-type-name-p)
Initform: t
Readers: dspec-type.
Writers: (setf dspec-type).

Slot: name ¶

Readers: dspec-name.
Writers: (setf dspec-name).

5.1.6 Classes

Class: clause-object ¶

Package

Source

Direct subclasses

clause-with-body.
clause-with-items.
clause-with-term.
clause-with-title.
docerror.
inline-clause.
named-clause.

Direct methods

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

Direct slots

Slot: parent ¶

Type: (or null ccldoc:clause-object)
Initform: ccldoc::*parent-clause*
Readers: clause-parent.
Writers: (setf clause-parent).

Slot: source-form ¶

Initform: ccldoc::*source-form*
Readers: clause-source-form.
Writers: This slot is read-only.

Class: clause-with-body ¶

Package

Source

Direct superclasses

Direct subclasses

clause-with-required-body.
code-block.
definition.
glossentry.
indexed-clause.
item.
markup.
para.
section.
term-item.
text-block.

Direct methods

(setf clause-body).
clause-body.
clause-text.
decompile-body.
decompile-ccldoc.
para-subforms-to-body.
subclause-slots.
subforms-to-body.

Direct slots

Slot: body ¶

Type: (or null ccldoc:clause)
Readers: clause-body.
Writers: (setf clause-body).

Class: clause-with-items ¶

Package

Source

Direct superclasses

Direct subclasses

listing.
row.
table.

Direct methods

clause-items.
clause-text.
decompile-items.
subclause-slots.
subforms-to-items.

Direct slots

Slot: items ¶

Type: vector
Readers: clause-items.
Writers: This slot is read-only.

Class: clause-with-term ¶

Package

Source

Direct superclasses

Direct subclasses

glossentry.
term-item.

Direct methods

clause-term.
subclause-slots.

Direct slots

Slot: term ¶

Type: (or null ccldoc:clause)
Initargs: :term
Readers: clause-term.
Writers: This slot is read-only.

Class: clause-with-title ¶

Package

Source

Direct superclasses

Direct subclasses

clause-with-optional-title.
clause-with-required-title.

Direct methods

clause-text.
clause-title.

Direct slots

Slot: title ¶

Initargs: :title
Readers: clause-title.
Writers: This slot is read-only.

Class: code-block ¶

Package

Source

Direct superclasses

Direct methods

generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Class: definition ¶

Package

Source

Direct superclasses

clause-with-body.
named-clause.

Direct methods

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

Direct slots

Slot: display-name ¶

Type: ccldoc:clause
Readers: definition-display-name.
Writers: (setf definition-display-name).

Slot: signature ¶

Type: ccldoc:clause
Readers: definition-signature.
Writers: (setf definition-signature).

Slot: summary ¶

Type: (or null ccldoc:clause)
Readers: definition-summary.
Writers: (setf definition-summary).

Class: docerror ¶

Package

Source

Direct superclasses

Direct methods

clause-text.
generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: clause-text ¶

Initargs: :message
Readers: clause-text.
Writers: This slot is read-only.

Class: document ¶

Package

Source

Direct superclasses

section.

Direct methods

clause-document.
external-id-for-clause.
external-ids.
generate-docbook-form.
named-clauses.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: parent ¶

Type: null

Slot: named-clauses ¶

Initform: (make-hash-table :test (function equalp))
Readers: named-clauses.
Writers: This slot is read-only.

Slot: external-ids ¶

Initform: (make-hash-table :test (function equal))
Readers: external-ids.
Writers: This slot is read-only.

Class: glossary-section ¶

Package

Source

Direct superclasses

section.

Direct methods

generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Class: glossentry ¶

Package

Source

Direct superclasses

clause-with-body.
clause-with-term.
named-clause.

Direct methods

clause-reference-name.
clause-text.
decompile-ccldoc.
generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Class: index-section ¶

Package

Source

Direct superclasses

section.

Direct methods

generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: body ¶

Type: null

Class: indexed-clause ¶

Package

Source

Direct superclasses

clause-with-body.
inline-clause.

Direct subclasses

reference-placeholder.
xref.

Direct methods

default-operator.
generate-docbook-form.
subclause-slots.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: default-operator ¶

Allocation: :class
Initform: (ccldoc::op-name :index)
Readers: default-operator.
Writers: This slot is read-only.

Class: item ¶

Package

Source

Direct superclasses

Direct subclasses

term-item.

Direct methods

generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Class: link ¶

Package

Source

Direct superclasses

clause-with-required-body.
inline-clause.

Direct methods

decompile-ccldoc.
generate-docbook-form.
link-url.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: url ¶

Type: string
Initargs: :url
Readers: link-url.
Writers: This slot is read-only.

Class: listing ¶

Package

Source

Direct superclasses

clause-with-items.

Direct methods

decompile-ccldoc.
generate-docbook-form.
listing-type.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: listing-type ¶

Type: ccldoc:listing-type
Initargs: :type
Readers: listing-type.
Writers: This slot is read-only.

Class: markup ¶

Package

Source

Direct superclasses

clause-with-body.
inline-clause.

Direct methods

decompile-ccldoc.
generate-docbook-form.
markup-type.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: markup-type ¶

Type: ccldoc:markup-type
Initargs: :type
Readers: markup-type.
Writers: This slot is read-only.

Class: named-clause ¶

Package

Source

Direct superclasses

Direct subclasses

clause-with-required-title.
definition.
glossentry.

Direct methods

(setf clause-external-id).
clause-external-id.
(setf clause-name).
clause-name.
initialize-instance.
write-html.
write-latex.

Direct slots

Slot: name ¶

Initargs: :name
Readers: clause-name.
Writers: (setf clause-name).

Slot: external-id ¶

Type: string
Readers: clause-external-id.
Writers: (setf clause-external-id).

Class: para ¶

Package

Source

Direct superclasses

Direct methods

clause-text.
generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Class: row ¶

Package

Source

Direct superclasses

clause-with-items.

Direct methods

clause-text.
decompile-ccldoc.
generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Class: section ¶

Package

Source

Direct superclasses

clause-with-body.
clause-with-required-title.

Direct subclasses

document.
glossary-section.
index-section.

Direct methods

decompile-ccldoc.
default-operator.
generate-docbook-form.
initialize-instance.
section-level.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: default-operator ¶

Allocation: :class
Initform: (ccldoc::op-name :defsection)
Readers: default-operator.
Writers: This slot is read-only.

Slot: package ¶

Package: common-lisp.
Initargs: :package

Class: table ¶

Package

Source

Direct superclasses

clause-with-items.
clause-with-required-title.

Direct methods

decompile-ccldoc.
external-id-for-clause.
generate-docbook-form.
initialize-instance.
write-html.
write-latex.
write-tracwiki.

Class: term-item ¶

Package

Source

Direct superclasses

clause-with-body.
clause-with-term.
item.

Direct methods

clause-text.
decompile-ccldoc.
default-operator.
generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Direct slots

Slot: default-operator ¶

Allocation: :class
Initform: (ccldoc::op-name :item)
Readers: default-operator.
Writers: This slot is read-only.

Class: text-block ¶

Package

Source

Direct superclasses

clause-with-body.
clause-with-optional-title.

Direct methods

decompile-ccldoc.
generate-docbook-form.
write-html.
write-latex.
write-tracwiki.

Class: xref ¶

Package

Source

Direct superclasses

indexed-clause.

Direct methods

decompile-ccldoc.
default-operator.
generate-docbook-form.
write-html.
write-latex.
write-tracwiki.
xref-default-body.
xref-target.

Direct slots

Slot: default-operator ¶

Allocation: :class
Initform: (ccldoc::op-name :ref)
Readers: default-operator.
Writers: This slot is read-only.

Slot: default-body ¶

Initargs: :default-body
Readers: xref-default-body.
Writers: This slot is read-only.

Slot: target ¶

Type: ccldoc:named-clause
Initargs: :target
Readers: xref-target.
Writers: This slot is read-only.

5.1.7 Types

Type: clause () ¶

Package: ccldoc.
Source: representation.lisp.

Type: listing-type () ¶

Package: ccldoc.
Source: representation.lisp.

Type: markup-type () ¶

Package: ccldoc.
Source: representation.lisp.

5.2 Internals

Special variables
Macros
Ordinary functions
Generic functions
Classes

5.2.1 Special variables

Special Variable: *ccldoc-fake-packages* ¶

Package: ccldoc.
Source: utils.lisp.

Special Variable: *ccldoc-pprint-dispatch* ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Special Variable: *current-file* ¶

Package: ccldoc.
Source: representation.lisp.

Special Variable: *dspec-types* ¶

Package: ccldoc.
Source: utils.lisp.

Special Variable: *form-subforms-start* ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Special Variable: *nowiki-context* ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

Special Variable: *operators* ¶

Package: ccldoc.
Source: toplevel.lisp.

Special Variable: *parent-clause* ¶

Package: ccldoc.
Source: representation.lisp.

Special Variable: *section-package* ¶

Package: ccldoc.
Source: representation.lisp.

Special Variable: *source-form* ¶

Package: ccldoc.
Source: representation.lisp.

Special Variable: *special-anywhere* ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

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

Package: ccldoc.
Source: output-tracwiki.lisp.

Special Variable: *whitespace-allowed-tags* ¶

Package: ccldoc.
Source: utils.lisp.

Special Variable: *wiki-indent* ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

Special Variable: *wiki-inline* ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

5.2.2 Macros

Macro: cassert (form &rest error-args) ¶

Package: ccldoc.
Source: utils.lisp.

Macro: def-operator (name params &body body) ¶

Package: ccldoc.
Source: toplevel.lisp.

Macro: def-predicate (name type) ¶

Package: ccldoc.
Source: utils.lisp.

Macro: with-ccldoc-packages (&body body) ¶

Package: ccldoc.
Source: utils.lisp.

Macro: with-markup ((stream-var start-text end-text) &body body) ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

5.2.3 Ordinary functions

Function: %def-operator (type op-name params fn docstring &key parser-types) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: %make-dspec (&key type name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: ancestor-of-type (clause-object type) ¶

Package: ccldoc.
Source: representation.lisp.

Function: as-fully-qualified-name (doc name) ¶

Package: ccldoc.
Source: representation.lisp.

Function: assign-external-ids (doc) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: build-ccldoc (doc-form &key default-file) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: call-with-markup (start-text end-text stream fn) ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

Function: canonical-clause-name-p (name) ¶

Package: ccldoc.
Source: representation.lisp.

Function: canonicalize-definition-name (type name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: canonicalize-ref-name (name) ¶

Package: ccldoc.
Source: syntax.lisp.

Function: ccldoc-macro-expander (name) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: ccldoc-macroexpand (form) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: ccldoc-operator (name) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: ccldoc-opinfo (name) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: ccldoc-package (name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: ccldoc-string-parser (name) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: clause-chapter (clause) ¶

Package: ccldoc.
Source: output-html.lisp.

Function: collect-glossary-entries (doc) ¶

Package: ccldoc.
Source: syntax.lisp.

Function: combine-strings (list) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: concat-by (sep &rest strings) ¶

Package: ccldoc.
Source: utils.lisp.

Function: copy-dspec (instance) ¶

Package: ccldoc.
Source: utils.lisp.

Function: copy-dspecinfo (sequence) ¶

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

Package: ccldoc.
Alias for: copy-seq.

Function: copy-opinfo (sequence) ¶

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

Package: ccldoc.
Alias for: copy-seq.

Function: decompile-clause-name (name) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: delim-pos (string start &optional end) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: desym (thing) ¶

Package: ccldoc.
Source: utils.lisp.

Function: disambiguate-ids (simple-id clauses) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: docbook-tag (clause tag-name) ¶

Package: ccldoc.
Source: output-docbook.lisp.

Function: docbook-tag-for-markup (type) ¶

Package: ccldoc.
Source: output-docbook.lisp.

Function: docbook-tags-for-listing (type) ¶

Package: ccldoc.
Source: output-docbook.lisp.

Function: docbook-title* (clause) ¶

Package: ccldoc.
Source: output-docbook.lisp.

Function: dspec-subtypep (type super) ¶

Package: ccldoc.
Source: utils.lisp.

Function: dspec-type-for-type-name (type-name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: dspec-type-name-p (type) ¶

Package: ccldoc.
Source: utils.lisp.

Function: dspecinfo-function (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: (setf dspecinfo-function) (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: dspecinfo-id-prefix (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: (setf dspecinfo-id-prefix) (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: dspecinfo-parent-type (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: (setf dspecinfo-parent-type) (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: dspecinfo-type (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: (setf dspecinfo-type) (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: dspecinfo-type-name (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: (setf dspecinfo-type-name) (structure) ¶

Package: ccldoc.
Source: utils.lisp.

Function: dspecp (object) ¶

Package: ccldoc.
Source: utils.lisp.

Function: end-delim-pos (string start &optional end) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: escape-char (char) ¶

Package: ccldoc.
Source: output-latex.lisp.

Function: escape-char-test (char) ¶

Package: ccldoc.
Source: output-latex.lisp.

Function: escape-for-latex (string &key test) ¶

Package: ccldoc.
Source: output-latex.lisp.

Function: external-id-for-name (name) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: external-id-string (lisp-name) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: find-clause (doc fn &optional errorp) ¶

Package: ccldoc.
Source: representation.lisp.

Function: form-clause (form) ¶

Package: ccldoc.
Source: syntax.lisp.

Function: form-clause-by-operator (operator args) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: form-clause-ensuring-simple (term) ¶

Package: ccldoc.
Source: syntax.lisp.

Function: form-subforms-start (form) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: function-for-dspec-type (type) ¶

Package: ccldoc.
Source: utils.lisp.

Function: generate-body-list (clause-with-body) ¶

Package: ccldoc.
Source: output-docbook.lisp.

Function: gensymcat (&rest args) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: gensymp (thing) ¶

Package: ccldoc.
Source: utils.lisp.

Function: html-formatted-signature (signature) ¶

Package: ccldoc.
Source: output-html.lisp.

Function: id-prefix-for-dspec-type (type) ¶

Package: ccldoc.
Source: utils.lisp.

Function: info-for-dspec-type (type) ¶

Package: ccldoc.
Source: utils.lisp.

Function: lisp-from-string (string &key start end eof) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: load-to-ccldoc-form (file stream) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: make-arg-reader (&rest argtypes) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: make-dspec (type name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: make-dspecinfo (&key type type-name id-prefix parent-type function) ¶

Package: ccldoc.
Source: utils.lisp.

Function: make-opinfo (&key type function parser) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: make-wild-dspec (name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: matching-clauses (doc fn) ¶

Package: ccldoc.
Source: representation.lisp.

Function: named-clauses-count (doc) ¶

Package: ccldoc.
Source: representation.lisp.

Function: norm-for-external-id (char string) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: normalize-title (title) ¶

Package: ccldoc.
Source: syntax.lisp.

Function: normalize-whitespace (string) ¶

Package: ccldoc.
Source: utils.lisp.

Function: op-name (sym &optional intern) ¶

Package: ccldoc.
Source: utils.lisp.

Function: op-name-p (sym1 sym2) ¶

Package: ccldoc.
Source: utils.lisp.

Function: operator-sym-p (sym) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: opinfo-function (structure) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: (setf opinfo-function) (structure) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: opinfo-parser (structure) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: (setf opinfo-parser) (structure) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: opinfo-type (structure) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: (setf opinfo-type) (structure) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: output-latex (doc filename &key external-format if-exists) ¶

Package: ccldoc.
Source: output-latex.lisp.

Function: parent-type-for-dspec-type (type) ¶

Package: ccldoc.
Source: utils.lisp.

Function: parse-arg-and-options (arg-and-options &key options type) ¶

Package: ccldoc.
Source: syntax.lisp.

Function: parse-ccldoc-string (string) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: pprint-ccldoc (form stream &key package) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: pprint-ccldoc-operator (stream sym) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: pprint-ccldoc-table (xp list &rest args) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: prettify-ccldoc (form &key package) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: read-all-from-string (string &key start end package) ¶

Package: ccldoc.
Source: utils.lisp.

Function: read-ccldoc-document (filename external-format) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: register-dspec-type (type parent-type type-name id-prefix function) ¶

Package: ccldoc.
Source: utils.lisp.

Function: resolve-placeholder (clause) ¶

Package: ccldoc.
Source: representation.lisp.

Function: resolve-xref-targets (doc) ¶

Package: ccldoc.
Source: representation.lisp.

Function: section-name-p (name) ¶

Package: ccldoc.
Source: representation.lisp.

Function: std-dspec-name (ccl-type name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: string-chunk (string start &optional end) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: string-dspec-name (name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: stringyp (x) ¶

Package: ccldoc.
Source: output-ccldoc.lisp.

Function: subforms-clause (parent forms &optional upgrade-to-para) ¶

Package: ccldoc.
Source: syntax.lisp.

Function: subforms-items (parent forms type) ¶

Package: ccldoc.
Source: syntax.lisp.

Function: symbol-dspec-name (name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: table-name-p (name) ¶

Package: ccldoc.
Source: representation.lisp.

Function: text-for-clause-name (name &optional package) ¶

Package: ccldoc.
Source: toplevel.lisp.

Function: wiki-blankline (stream) ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

Function: wiki-freshline (stream) ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

Function: wiki-newline (stream) ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

Function: wild-dspec-p (name) ¶

Package: ccldoc.
Source: utils.lisp.

Function: wild-name-match-p (clause-name wild-name) ¶

Package: ccldoc.
Source: representation.lisp.

Function: wildcard-canonical-name-p (cname) ¶

Package: ccldoc.
Source: representation.lisp.

Function: write-html-sidebar (document stream) ¶

Package: ccldoc.
Source: output-html.lisp.

Function: write-html-toc (document stream &optional depth) ¶

Package: ccldoc.
Source: output-html.lisp.

Function: write-latex-preamble (stream) ¶

Package: ccldoc.
Source: output-latex.lisp.

Function: write-nowiki (type clause stream) ¶

Package: ccldoc.
Source: output-tracwiki.lisp.

5.2.4 Generic functions

Generic Reader: clause-default-body (object) ¶

Package

Methods

Reader Method: clause-default-body ((reference-placeholder reference-placeholder)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: default-body.

Generic Function: clause-reference-name (clause) ¶

Package

Methods

Method: clause-reference-name ((clause glossentry)) ¶

Source: representation.lisp.

Method: clause-reference-name ((clause definition)) ¶

Source: representation.lisp.

Method: clause-reference-name ((clause clause-with-required-title)) ¶

Source: representation.lisp.

Generic Function: clause-section (clause) ¶

Package

Methods

Method: clause-section ((clause clause-object)) ¶

Source: representation.lisp.

Generic Reader: clause-source-form (object) ¶

Package

Methods

Reader Method: clause-source-form ((clause-object clause-object)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: source-form.

Generic Function: decompile-body (clause) ¶

Package

Methods

Method: decompile-body ((clause clause-with-body)) ¶

Source: output-ccldoc.lisp.

Generic Function: decompile-ccldoc (clause) ¶

Package

Methods

Method: decompile-ccldoc ((link link)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((row row)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((clause xref)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((clause reference-placeholder)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((clause term-item)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((table table)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((listing listing)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((markup markup)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((glossentry glossentry)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((definition definition)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((blk text-block)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((section section)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((clause clause-with-body)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((list list)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((string string)) ¶

Source: output-ccldoc.lisp.

Method: decompile-ccldoc ((clause clause-object)) ¶

Source: output-ccldoc.lisp.

Generic Function: decompile-items (clause) ¶

Package

Methods

Method: decompile-items ((clause clause-with-items)) ¶

Source: output-ccldoc.lisp.

Generic Function: default-operator (clause) ¶

Package

Methods

Reader Method: default-operator ((section section)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: default-operator.

Reader Method: default-operator ((reference-placeholder reference-placeholder)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: default-operator.

Reader Method: default-operator ((xref xref)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: default-operator.

Reader Method: default-operator ((indexed-clause indexed-clause)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: default-operator.

Reader Method: default-operator ((term-item term-item)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: default-operator.

Method: default-operator ((clause clause-object)) ¶

Source: representation.lisp.

Generic Function: external-id-for-clause (clause) ¶

Package

Methods

Method: external-id-for-clause ((clause document)) ¶

Source: toplevel.lisp.

Method: external-id-for-clause ((clause table)) ¶

Source: toplevel.lisp.

Method: external-id-for-clause (clause) ¶

Source: toplevel.lisp.

Generic Reader: external-ids (object) ¶

Package

Methods

Reader Method: external-ids ((document document)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: external-ids.

Generic Function: generate-docbook-form (clause) ¶

Package

Methods

Method: generate-docbook-form ((clause indexed-clause)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause xref)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause definition)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause item)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause term-item)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause listing)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause link)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause glossentry)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause row)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause table)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause markup)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause code-block)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause text-block)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause string)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause para)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause glossary-section)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause index-section)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause section)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause document)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause docerror)) ¶

Source: output-docbook.lisp.

Method: generate-docbook-form ((clause cons)) ¶

Source: output-docbook.lisp.

Generic Function: generate-docbook-list (list) ¶

Package

Methods

Method: generate-docbook-list (clause) ¶

Source: output-docbook.lisp.

Method: generate-docbook-list ((list list)) ¶

Source: output-docbook.lisp.

Generic Function: inline-clause-p (clause) ¶

Package

Source

Methods

Method: inline-clause-p ((clause string)) ¶

Method: inline-clause-p ((list list)) ¶

Method: inline-clause-p ((clause inline-clause)) ¶

Method: inline-clause-p ((clause clause-object)) ¶

Generic Reader: named-clauses (object) ¶

Package

Methods

Reader Method: named-clauses ((document document)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: named-clauses.

Generic Function: para-subforms-to-body (parent forms) ¶

Package

Methods

Method: para-subforms-to-body ((parent clause-with-body) forms) ¶

Source: syntax.lisp.

Generic Reader: placeholder-target-name (object) ¶

Package

Methods

Reader Method: placeholder-target-name ((reference-placeholder reference-placeholder)) ¶

automatically generated reader method

Source: representation.lisp.
Target Slot: target-name.

Generic Function: princ-ccldoc (c stream) ¶

Package

Methods

Method: princ-ccldoc ((c clause-object) stream) ¶

Source: representation.lisp.

Generic Function: subclause-slots (clause) ¶

Package

Source

Method Combination

append.

Options: :most-specific-first

Methods

Method: subclause-slots append ((clause indexed-clause)) ¶

Method: subclause-slots append ((clause definition)) ¶

Method: subclause-slots append ((clause clause-with-items)) ¶

Method: subclause-slots append ((clause clause-with-term)) ¶

Method: subclause-slots append ((clause clause-with-body)) ¶

Method: subclause-slots append ((clause string)) ¶

Method: subclause-slots append ((clause clause-object)) ¶

Generic Function: subforms-to-body (parent forms) ¶

Package

Methods

Method: subforms-to-body ((parent clause-with-body) forms) ¶

Source: syntax.lisp.

Generic Function: subforms-to-items (parent forms &optional type) ¶

Package

Methods

Method: subforms-to-items ((parent clause-with-items) forms &optional type) ¶

Source: syntax.lisp.

Generic Function: write-html (clause stream) ¶

Package

Methods

Method: write-html :before ((clause named-clause) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause null) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause string) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause cons) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause definition) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause xref) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause term-item) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause item) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause markup) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause indexed-clause) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause listing) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause row) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause table) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause link) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause docerror) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause para) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause text-block) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause code-block) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause section) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause glossentry) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause glossary-section) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause index-section) stream) ¶

Source: output-html.lisp.

Method: write-html ((clause document) stream) ¶

Source: output-html.lisp.

Generic Function: write-latex (clause stream) ¶

Package

Methods

Method: write-latex ((clause null) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause string) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause cons) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause definition) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause xref) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause term-item) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause item) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause markup) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause listing) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause row) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause table) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause link) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause docerror) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause para) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause text-block) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause code-block) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause section) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause glossentry) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause glossary-section) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause indexed-clause) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause index-section) stream) ¶

Source: output-latex.lisp.

Method: write-latex :before ((clause named-clause) stream) ¶

Source: output-latex.lisp.

Method: write-latex ((clause document) stream) ¶

Source: output-latex.lisp.

Generic Function: write-tracwiki (clause stream) ¶

Package

Methods

Method: write-tracwiki ((clause xref) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause definition) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause item) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause term-item) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause listing) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause link) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause row) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause table) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause markup) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause para) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause code-block) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause text-block) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause glossentry) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause glossary-section) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause indexed-clause) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause index-section) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause section) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause document) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause docerror) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause string) stream) ¶

Source: output-tracwiki.lisp.

Method: write-tracwiki ((clause cons) stream) ¶

Source: output-tracwiki.lisp.

5.2.5 Classes

Class: clause-with-optional-title ¶

Package

Source

Direct superclasses

clause-with-title.

Direct subclasses

text-block.

Direct slots

Slot: title ¶

Type: (or null string)

Class: clause-with-required-body ¶

Package

Source

Direct superclasses

Direct subclasses

link.

Direct slots

Slot: body ¶

Type: ccldoc:clause

Class: clause-with-required-title ¶

Package

Source

Direct superclasses

clause-with-title.
named-clause.

Direct subclasses

section.
table.

Direct methods

clause-reference-name.

Direct slots

Slot: title ¶

Type: string

Class: inline-clause ¶

Package

Source

Direct superclasses

Direct subclasses

indexed-clause.
link.
markup.

Direct methods

inline-clause-p.

Class: reference-placeholder ¶

Package

Source