This is the documentation-template Reference Manual, version 0.4.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 05:03:55 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
documentation-template0.4.4
cl-who (system).
packages.lisp (file).
specials.lisp (file).
util.lisp (file).
output.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
documentation-template/documentation-template.asddocumentation-template/packages.lispdocumentation-template/specials.lispdocumentation-template/util.lispdocumentation-template/output.lispdocumentation-template/documentation-template.asddocumentation-template (system).
documentation-template/packages.lispdocumentation-template (system).
documentation-template/specials.lisppackages.lisp (file).
documentation-template (system).
*maybe-skip-methods-p* (special variable).
*target* (special variable).
*hyperdoc-base-uri* (special variable).
*symbols* (special variable).
hyperdoc-lookup (function).
documentation-template/util.lispspecials.lisp (file).
documentation-template (system).
%sbcl-simple-specializer (generic function).
class-doc-entry (function).
collect-all-doc-entries (function).
constant-doc-entry (function).
declared-special-p (function).
doc-entries (function).
doc-entry< (function).
doc-type-ordinal (function).
function-doc-entry (function).
function-lambda-list (function).
generic-function-doc-entry (function).
macro-doc-entry (function).
name< (function).
name= (function).
simplify-specializer (function).
special-var-doc-entry (function).
symbol-constant-p (function).
documentation-template/output.lisputil.lisp (file).
documentation-template (system).
create-template (function).
write-class-entry (function).
write-constant-entry (function).
write-entry (function).
write-entry-footer (function).
write-entry-header (function).
write-function-entry (function).
write-lambda-list (function).
write-lambda-list* (function).
write-macro-entry (function).
write-page-footer (function).
write-page-header (function).
write-special-var-entry (function).
Packages are listed by definition order.
documentation-templatecl-who.
common-lisp.
sb-mop.
*maybe-skip-methods-p* (special variable).
*target* (special variable).
create-template (function).
%sbcl-simple-specializer (generic function).
*hyperdoc-base-uri* (special variable).
*symbols* (special variable).
class-doc-entry (function).
collect-all-doc-entries (function).
constant-doc-entry (function).
declared-special-p (function).
doc-entries (function).
doc-entry< (function).
doc-type-ordinal (function).
function-doc-entry (function).
function-lambda-list (function).
generic-function-doc-entry (function).
hyperdoc-lookup (function).
macro-doc-entry (function).
name< (function).
name= (function).
simplify-specializer (function).
special-var-doc-entry (function).
symbol-constant-p (function).
write-class-entry (function).
write-constant-entry (function).
write-entry (function).
write-entry-footer (function).
write-entry-header (function).
write-function-entry (function).
write-lambda-list (function).
write-lambda-list* (function).
write-macro-entry (function).
write-page-footer (function).
write-page-header (function).
write-special-var-entry (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
This is the default value for the :MAYBE-SKIP-METHODS-P keyword argument of CREATE-TEMPLATE and its initial value is NIL. It is also used internally.
Where to output the HTML page. If this value is not NIL, it will be the default target for CREATE-TEMPLATE. CREATE-TEMPLATE will also set this value.
Writes an HTML page with preliminary documentation entries and an index for all exported symbols of the package PACKAGE to the file TARGET. If MAYBE-SKIP-METHODS-P is true, documentation entries for inidividual methods are skipped if the corresponding generic function has a documentation string.
The list of symbols for which we will create an index with links.
Returns a list with one entry for a class if SYMBOL names a class.
Returns a sorted list of entries for all exported symbols of PACKAGE.
Returns a list with one entry for a constant if SYMBOL names a constant.
Returns true if SYMBOL is declared special.
Returns a list of all possible entries for the symbol SYMBOL and for the corresponding SETF function name.
Comparions function used for sorting - sort by name and, if the names are the same, by DOC-TYPE-ORDINAL.
Assigns ordinals to the different kinds of entries for sorting purposes.
Returns a list with one entry for a function if NAME names a plain old function.
Returns the lambda list of the function designator FUNCTION.
Returns a list with one entry for a generic function and one entry for each of its methods if NAME names a generic function.
Returns a list with one entry for a macro if SYMBOL names a macro.
Comparison function used for sorting - symbols are "smaller" then SETF names, otherwise sort alphabetically.
Two function names are equal if they are EQUAL - this covers symbols as well as general function names.
Converts specializers which are classes to their names, leaves the rest alone.
Returns a list with one entry for a special variable if SYMBOL names a special variable.
Returns true if SYMBOL is a constant.
Writes a full documentation entry for the class SYMBOL.
Writes a full documentation entry for the constant SYMBOL.
Write one documentation entry corresponding to ENTRY. OTHER-ENTRIES is the list of the remaining entries waiting to be written. OTHER-ENTRIES, probably updated, will be returned.
Writes the footer for a documentation entry for the name NAME including the documentation string DOC-STRING.
Writes the header for a documentation entry of name NAME and type TYPE. The HTML anchor will only get a ’name’ attribute if WRITE-NAME-P is true and NAME is not a SETF name.
Writes a full documentation entry for the function, generic function, or method with name NAME. NAME is a generic function if GENERICP is true, SPECIALIZERS is a list of specializers, i.e. in this case NAME is a method. Likewise, QUALIFIERS is a list of qualifiers. SIGNATURE-ONLY-P means that we don’t want a full header.
Writes the lambda list LAMBDA-LIST, optionally with the specializers SPECIALIZERS. Adds something like ‘=> result’ at the end if RESULTP is true.
The function which does all the work for WRITE-LAMBDA-LIST and calls itself recursive if needed.
Writes a full documentation entry for the macro SYMBOL.
Writes the header of the HTML page. Assumes that the library has the same name as the package. Adds a list of all exported symbols with links.
Writes a full documentation entry for the special variable SYMBOL.
| Jump to: | %
C D F G H M N S W |
|---|
| Jump to: | %
C D F G H M N S W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | D F O P S U |
|---|
| Jump to: | D F O P S U |
|---|