The documentation-template Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The documentation-template Reference Manual

This is the documentation-template Reference Manual, version 0.4.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:37:31 2022 GMT+0.

Table of Contents


1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 documentation-template

Version

0.4.4

Dependency

cl-who (system).

Source

documentation-template.asd.

Child Components

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


2.1.1 documentation-template/documentation-template.asd

Source

documentation-template.asd.

Parent Component

documentation-template (system).

ASDF Systems

documentation-template.

Packages

documentation-template-asd.


2.1.2 documentation-template/packages.lisp

Source

documentation-template.asd.

Parent Component

documentation-template (system).

Packages

documentation-template.


2.1.3 documentation-template/specials.lisp

Dependency

packages.lisp (file).

Source

documentation-template.asd.

Parent Component

documentation-template (system).

Public Interface
Internals

2.1.4 documentation-template/util.lisp

Dependency

specials.lisp (file).

Source

documentation-template.asd.

Parent Component

documentation-template (system).

Internals

2.1.5 documentation-template/output.lisp

Dependency

util.lisp (file).

Source

documentation-template.asd.

Parent Component

documentation-template (system).

Public Interface

create-template (function).

Internals

3 Packages

Packages are listed by definition order.


3.1 documentation-template

Source

packages.lisp.

Use List
  • cl-who.
  • common-lisp.
  • sb-mop.
Public Interface
Internals

3.2 documentation-template-asd

Source

documentation-template.asd.

Use List
  • asdf/interface.
  • common-lisp.

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Public Interface


4.1.1 Special variables

Special Variable: *maybe-skip-methods-p*

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.

Package

documentation-template.

Source

specials.lisp.

Special Variable: *target*

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.

Package

documentation-template.

Source

specials.lisp.


4.1.2 Ordinary functions

Function: create-template (package &key target subtitle maybe-skip-methods-p if-exists if-does-not-exist)

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.

Package

documentation-template.

Source

output.lisp.


4.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

4.2.1 Special variables

Special Variable: *hyperdoc-base-uri*
Package

documentation-template.

Source

specials.lisp.

Special Variable: *symbols*

The list of symbols for which we will create an index with links.

Package

documentation-template.

Source

specials.lisp.


4.2.2 Ordinary functions

Function: class-doc-entry (symbol)

Returns a list with one entry for a class if SYMBOL names a class.

Package

documentation-template.

Source

util.lisp.

Function: collect-all-doc-entries (package)

Returns a sorted list of entries for all exported symbols of PACKAGE.

Package

documentation-template.

Source

util.lisp.

Function: constant-doc-entry (symbol)

Returns a list with one entry for a constant if SYMBOL names a constant.

Package

documentation-template.

Source

util.lisp.

Function: declared-special-p (symbol)

Returns true if SYMBOL is declared special.

Package

documentation-template.

Source

util.lisp.

Function: doc-entries (symbol)

Returns a list of all possible entries for the symbol SYMBOL and for the corresponding SETF function name.

Package

documentation-template.

Source

util.lisp.

Function: doc-entry< (entry1 entry2)

Comparions function used for sorting - sort by name and, if the names are the same, by DOC-TYPE-ORDINAL.

Package

documentation-template.

Source

util.lisp.

Function: doc-type-ordinal (type)

Assigns ordinals to the different kinds of entries for sorting purposes.

Package

documentation-template.

Source

util.lisp.

Function: function-doc-entry (name)

Returns a list with one entry for a function if NAME names a plain old function.

Package

documentation-template.

Source

util.lisp.

Function: function-lambda-list (function)

Returns the lambda list of the function designator FUNCTION.

Package

documentation-template.

Source

util.lisp.

Function: generic-function-doc-entry (name)

Returns a list with one entry for a generic function and one entry for each of its methods if NAME names a generic function.

Package

documentation-template.

Source

util.lisp.

Function: hyperdoc-lookup (symbol type)
Package

documentation-template.

Source

specials.lisp.

Function: macro-doc-entry (symbol)

Returns a list with one entry for a macro if SYMBOL names a macro.

Package

documentation-template.

Source

util.lisp.

Function: name< (name1 name2)

Comparison function used for sorting - symbols are "smaller" then SETF names, otherwise sort alphabetically.

Package

documentation-template.

Source

util.lisp.

Function: name= (name1 name2)

Two function names are equal if they are EQUAL - this covers symbols as well as general function names.

Package

documentation-template.

Source

util.lisp.

Function: simplify-specializer (specializer)

Converts specializers which are classes to their names, leaves the rest alone.

Package

documentation-template.

Source

util.lisp.

Function: special-var-doc-entry (symbol)

Returns a list with one entry for a special variable if SYMBOL names a special variable.

Package

documentation-template.

Source

util.lisp.

Function: symbol-constant-p (symbol)

Returns true if SYMBOL is a constant.

Package

documentation-template.

Source

util.lisp.

Function: write-class-entry (symbol doc-string)

Writes a full documentation entry for the class SYMBOL.

Package

documentation-template.

Source

output.lisp.

Function: write-constant-entry (symbol doc-string)

Writes a full documentation entry for the constant SYMBOL.

Package

documentation-template.

Source

output.lisp.

Function: write-entry (entry other-entries)

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.

Package

documentation-template.

Source

output.lisp.

Function: write-entry-footer (name doc-string)

Writes the footer for a documentation entry for the name NAME including the documentation string DOC-STRING.

Package

documentation-template.

Source

output.lisp.

Function: write-entry-header (name type &key write-name-p)

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.

Package

documentation-template.

Source

output.lisp.

Function: write-function-entry (name lambda-list doc-string other-entries &key genericp signature-only-p specializers qualifiers)

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.

Package

documentation-template.

Source

output.lisp.

Function: write-lambda-list (lambda-list &key resultp specializers)

Writes the lambda list LAMBDA-LIST, optionally with the specializers SPECIALIZERS. Adds something like ‘=> result’ at the end if RESULTP is true.

Package

documentation-template.

Source

output.lisp.

Function: write-lambda-list* (lambda-list &optional specializers)

The function which does all the work for WRITE-LAMBDA-LIST and calls itself recursive if needed.

Package

documentation-template.

Source

output.lisp.

Function: write-macro-entry (symbol lambda-list doc-string)

Writes a full documentation entry for the macro SYMBOL.

Package

documentation-template.

Source

output.lisp.

Function: write-page-footer ()

Writes the footer of the HTML page.

Package

documentation-template.

Source

output.lisp.

Function: write-page-header (package-name subtitle symbols)

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.

Package

documentation-template.

Source

output.lisp.

Function: write-special-var-entry (symbol doc-string)

Writes a full documentation entry for the special variable SYMBOL.

Package

documentation-template.

Source

output.lisp.


4.2.3 Generic functions

Generic Function: %sbcl-simple-specializer (specializer)

Returns a simple representation of SPECIALIZER.

Package

documentation-template.

Source

util.lisp.

Methods
Method: %sbcl-simple-specializer (specializer)
Method: %sbcl-simple-specializer ((specializer eql-specializer))

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %  
C   D   F   G   H   M   N   S   W  
Index Entry  Section

%
%sbcl-simple-specializer: Private generic functions
%sbcl-simple-specializer: Private generic functions
%sbcl-simple-specializer: Private generic functions

C
class-doc-entry: Private ordinary functions
collect-all-doc-entries: Private ordinary functions
constant-doc-entry: Private ordinary functions
create-template: Public ordinary functions

D
declared-special-p: Private ordinary functions
doc-entries: Private ordinary functions
doc-entry<: Private ordinary functions
doc-type-ordinal: Private ordinary functions

F
Function, class-doc-entry: Private ordinary functions
Function, collect-all-doc-entries: Private ordinary functions
Function, constant-doc-entry: Private ordinary functions
Function, create-template: Public ordinary functions
Function, declared-special-p: Private ordinary functions
Function, doc-entries: Private ordinary functions
Function, doc-entry<: Private ordinary functions
Function, doc-type-ordinal: Private ordinary functions
Function, function-doc-entry: Private ordinary functions
Function, function-lambda-list: Private ordinary functions
Function, generic-function-doc-entry: Private ordinary functions
Function, hyperdoc-lookup: Private ordinary functions
Function, macro-doc-entry: Private ordinary functions
Function, name<: Private ordinary functions
Function, name=: Private ordinary functions
Function, simplify-specializer: Private ordinary functions
Function, special-var-doc-entry: Private ordinary functions
Function, symbol-constant-p: Private ordinary functions
Function, write-class-entry: Private ordinary functions
Function, write-constant-entry: Private ordinary functions
Function, write-entry: Private ordinary functions
Function, write-entry-footer: Private ordinary functions
Function, write-entry-header: Private ordinary functions
Function, write-function-entry: Private ordinary functions
Function, write-lambda-list: Private ordinary functions
Function, write-lambda-list*: Private ordinary functions
Function, write-macro-entry: Private ordinary functions
Function, write-page-footer: Private ordinary functions
Function, write-page-header: Private ordinary functions
Function, write-special-var-entry: Private ordinary functions
function-doc-entry: Private ordinary functions
function-lambda-list: Private ordinary functions

G
Generic Function, %sbcl-simple-specializer: Private generic functions
generic-function-doc-entry: Private ordinary functions

H
hyperdoc-lookup: Private ordinary functions

M
macro-doc-entry: Private ordinary functions
Method, %sbcl-simple-specializer: Private generic functions
Method, %sbcl-simple-specializer: Private generic functions

N
name<: Private ordinary functions
name=: Private ordinary functions

S
simplify-specializer: Private ordinary functions
special-var-doc-entry: Private ordinary functions
symbol-constant-p: Private ordinary functions

W
write-class-entry: Private ordinary functions
write-constant-entry: Private ordinary functions
write-entry: Private ordinary functions
write-entry-footer: Private ordinary functions
write-entry-header: Private ordinary functions
write-function-entry: Private ordinary functions
write-lambda-list: Private ordinary functions
write-lambda-list*: Private ordinary functions
write-macro-entry: Private ordinary functions
write-page-footer: Private ordinary functions
write-page-header: Private ordinary functions
write-special-var-entry: Private ordinary functions

Jump to:   %  
C   D   F   G   H   M   N   S   W