This is the ccldoc Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu May 15 03:31:52 2025 GMT+0.
ccldoc/ccldoc.asdccldoc/package.lispccldoc/borrowed-code.lispccldoc/utils.lispccldoc/representation.lispccldoc/toplevel.lispccldoc/syntax.lispccldoc/output-tracwiki.lispccldoc/output-html.lispccldoc/output-latex.lispccldoc/output-ccldoc.lispThe main system appears first, followed by any subsystem dependency.
ccldoccreate lisp documentation using s-expressions
Clozure Associates and contributors
Apache License 2.0
ccl-compat (system).
package.lisp (file).
borrowed-code.lisp (file).
utils.lisp (file).
representation.lisp (file).
toplevel.lisp (file).
syntax.lisp (file).
output-tracwiki.lisp (file).
output-html.lisp (file).
output-latex.lisp (file).
output-ccldoc.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
ccldoc/ccldoc.asdccldoc/package.lispccldoc/borrowed-code.lispccldoc/utils.lispccldoc/representation.lispccldoc/toplevel.lispccldoc/syntax.lispccldoc/output-tracwiki.lispccldoc/output-html.lispccldoc/output-latex.lispccldoc/output-ccldoc.lispccldoc/borrowed-code.lisppackage.lisp (file).
ccldoc (system).
escape-for-html (function).
escape-for-html-minimal (function).
html-escape-char-minimal-test (function).
html-escape-char-test (function).
if-let (macro).
remove-from-plist (function).
simple-split (function).
starts-with-subseq (function).
when-let (macro).
ccldoc/utils.lispborrowed-code.lisp (file).
ccldoc (system).
def-definition-type (macro).
dspec (structure).
dspec-name (reader).
(setf dspec-name) (writer).
dspec-type (reader).
(setf dspec-type) (writer).
dspec-type-name (function).
%make-dspec (function).
*ccldoc-fake-packages* (special variable).
*dspec-types* (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).
ccldoc/representation.lisputils.lisp (file).
ccldoc (system).
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).
*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).
ccldoc/toplevel.lisprepresentation.lisp (file).
ccldoc (system).
def-expander (macro).
load-document (function).
%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).
ccldoc/syntax.lisptoplevel.lisp (file).
ccldoc (system).
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).
ccldoc/output-tracwiki.lispsyntax.lisp (file).
ccldoc (system).
output-tracwiki (function).
*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).
ccldoc/output-html.lispoutput-tracwiki.lisp (file).
ccldoc (system).
output-html (function).
clause-chapter (function).
html-formatted-signature (function).
slurp-lines (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-stylesheet (function).
ccldoc/output-latex.lispoutput-html.lisp (file).
ccldoc (system).
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).
ccldoc/output-ccldoc.lispoutput-latex.lisp (file).
ccldoc (system).
output-ccldoc (function).
*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).
Packages are listed by definition order.
ccldoccommon-lisp.
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-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).
%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).
*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).
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-html (function).
escape-for-html-minimal (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).
gensymcat (function).
gensymp (function).
html-escape-char-minimal-test (function).
html-escape-char-test (function).
html-formatted-signature (function).
id-prefix-for-dspec-type (function).
if-let (macro).
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).
remove-from-plist (function).
resolve-placeholder (function).
resolve-xref-targets (function).
section-name-p (function).
simple-split (function).
slurp-lines (function).
starts-with-subseq (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).
when-let (macro).
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-stylesheet (function).
write-tracwiki (generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
name.
type.
clause-with-body)) ¶automatically generated reader method
body.
clause-with-body)) ¶automatically generated writer method
body.
clause-object)) ¶named-clause)) ¶automatically generated reader method
named-clause)) ¶automatically generated writer method
clause-with-items)) ¶automatically generated reader method
named-clause)) ¶automatically generated reader method
name.
named-clause)) ¶automatically generated writer method
name.
string)) ¶cons)) ¶clause-object)) ¶automatically generated reader method
string)) ¶cons)) ¶clause-object)) ¶automatically generated writer method
clause-with-term)) ¶automatically generated reader method
term.
glossentry)) ¶definition)) ¶clause-with-items)) ¶clause-with-body)) ¶clause-with-title)) ¶docerror)) ¶automatically generated reader method
list)) ¶clause-object)) ¶string)) ¶clause-with-title)) ¶automatically generated reader method
definition)) ¶automatically generated reader method
definition)) ¶automatically generated writer method
definition)) ¶automatically generated reader method
definition)) ¶automatically generated writer method
definition)) ¶automatically generated reader method
definition)) ¶automatically generated writer method
clause-object)) ¶named-clause) &key) ¶clause-object) stream) ¶(or null ccldoc:clause)
vector
This slot is read-only.
(or null ccldoc:clause)
:term
This slot is read-only.
:title
This slot is read-only.
:message
This slot is read-only.
null
(make-hash-table :test (function equalp))
This slot is read-only.
(make-hash-table :test (function equal))
This slot is read-only.
null
:class
(ccldoc::op-name :index)
This slot is read-only.
ccldoc:listing-type
:type
This slot is read-only.
ccldoc:markup-type
:type
This slot is read-only.
:class
(ccldoc::op-name :item)
This slot is read-only.
:class
(ccldoc::op-name :ref)
This slot is read-only.
:default-body
This slot is read-only.
ccldoc:named-clause
:target
This slot is read-only.
Creates new variable bindings, and conditionally executes either
THEN-FORM or ELSE-FORM. ELSE-FORM defaults to NIL.
BINDINGS must be either single binding of the form:
(variable initial-form)
or a list of bindings of the form:
((variable-1 initial-form-1)
(variable-2 initial-form-2)
...
(variable-n initial-form-n))
All initial-forms are executed sequentially in the specified order. Then all
the variables are bound to the corresponding values.
If all variables were bound to true values, the THEN-FORM is executed with the bindings in effect, otherwise the ELSE-FORM is executed with the bindings in effect.
Creates new variable bindings, and conditionally executes FORMS.
BINDINGS must be either single binding of the form:
(variable initial-form)
or a list of bindings of the form:
((variable-1 initial-form-1)
(variable-2 initial-form-2)
...
(variable-n initial-form-n))
All initial-forms are executed sequentially in the specified order. Then all
the variables are bound to the corresponding values.
If all variables were bound to true values, then FORMS are executed as an implicit PROGN.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Escape all characters in STRING which pass TEST. This function is not guaranteed to return a fresh string. Note that you can pass NIL for STRING which’ll just be returned.
Returns a property-list with same keys and values as PLIST, except that keys in the list designated by KEYS and values corresponding to them are removed. The returned property-list may share structure with the PLIST, but PLIST is not destructively modified. Keys are compared using EQ.
Test whether the first elements of SEQUENCE are the same (as per TEST) as the elements of PREFIX.
If RETURN-SUFFIX is T the function returns, as a second value, a
sub-sequence or displaced array pointing to the sequence after PREFIX.
reference-placeholder)) ¶automatically generated reader method
glossentry)) ¶definition)) ¶clause-with-required-title)) ¶clause-object)) ¶clause-object)) ¶automatically generated reader method
clause-with-body)) ¶reference-placeholder)) ¶glossentry)) ¶definition)) ¶text-block)) ¶clause-with-body)) ¶list)) ¶string)) ¶clause-object)) ¶clause-with-items)) ¶section)) ¶automatically generated reader method
reference-placeholder)) ¶automatically generated reader method
xref)) ¶automatically generated reader method
indexed-clause)) ¶automatically generated reader method
term-item)) ¶automatically generated reader method
clause-object)) ¶string)) ¶list)) ¶inline-clause)) ¶clause-object)) ¶clause-with-body) forms) ¶reference-placeholder)) ¶automatically generated reader method
clause-object) stream) ¶append.
:most-specific-first
indexed-clause)) ¶definition)) ¶clause-with-items)) ¶clause-with-term)) ¶clause-with-body)) ¶string)) ¶clause-object)) ¶clause-with-body) forms) ¶clause-with-items) forms &optional type) ¶named-clause) stream) ¶null) stream) ¶string) stream) ¶cons) stream) ¶definition) stream) ¶indexed-clause) stream) ¶text-block) stream) ¶code-block) stream) ¶glossentry) stream) ¶glossary-section) stream) ¶index-section) stream) ¶null) stream) ¶string) stream) ¶cons) stream) ¶definition) stream) ¶text-block) stream) ¶code-block) stream) ¶glossentry) stream) ¶glossary-section) stream) ¶indexed-clause) stream) ¶index-section) stream) ¶named-clause) stream) ¶definition) stream) ¶code-block) stream) ¶text-block) stream) ¶glossentry) stream) ¶glossary-section) stream) ¶indexed-clause) stream) ¶index-section) stream) ¶string) stream) ¶cons) stream) ¶(or null string)
string
:class
(ccldoc::op-name :ref)
This slot is read-only.
:default-body
This slot is read-only.
:name
This slot is read-only.
| Jump to: | %
(
A B C D E F G H I L M N O P R S T W X |
|---|
| Jump to: | %
(
A B C D E F G H I L M N O P R S T W X |
|---|
| Jump to: | *
B C D E I L M N P S T U |
|---|
| Jump to: | *
B C D E I L M N P S T U |
|---|
| Jump to: | B C D F G I L M N O P R S T U X |
|---|
| Jump to: | B C D F G I L M N O P R S T U X |
|---|