The documentation-template Reference Manual

Table of Contents

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 2.4 "Will Decker" on Wed Jun 20 11:42:29 2018 GMT+0.


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

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

Source

documentation-template.asd (file)

Components

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

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


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 documentation-template.asd

Location

documentation-template.asd

Systems

documentation-template (system)

Packages

documentation-template-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 documentation-template/packages.lisp

Parent

documentation-template (system)

Location

packages.lisp

Packages

documentation-template


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.3 documentation-template/specials.lisp

Dependency

packages.lisp (file)

Parent

documentation-template (system)

Location

specials.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.4 documentation-template/util.lisp

Dependency

specials.lisp (file)

Parent

documentation-template (system)

Location

util.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

2.1.5 documentation-template/output.lisp

Dependency

util.lisp (file)

Parent

documentation-template (system)

Location

output.lisp

Exported Definitions

create-template (function)

Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 documentation-template-asd

Source

documentation-template.asd

Use List

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

3.2 documentation-template

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

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 (file)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Functions

Function: create-template PACKAGE &key TARGET SUBTITLE (MAYBE-SKIP-METHODS-P *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 (file)


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

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Special variables

Special Variable: *hyperdoc-base-uri*
Package

documentation-template

Source

specials.lisp (file)

Special Variable: *symbols*

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

Package

documentation-template

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 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 (file)

Function: collect-all-doc-entries PACKAGE

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

Package

documentation-template

Source

util.lisp (file)

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 (file)

Function: declared-special-p SYMBOL

Returns true if SYMBOL is declared special.

Package

documentation-template

Source

util.lisp (file)

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 (file)

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 (file)

Function: doc-type-ordinal TYPE

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

Package

documentation-template

Source

util.lisp (file)

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 (file)

Function: function-lambda-list FUNCTION

Returns the lambda list of the function designator FUNCTION.

Package

documentation-template

Source

util.lisp (file)

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 (file)

Function: hyperdoc-lookup SYMBOL TYPE
Package

documentation-template

Source

specials.lisp (file)

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 (file)

Function: name< NAME1 NAME2

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

Package

documentation-template

Source

util.lisp (file)

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 (file)

Function: simplify-specializer SPECIALIZER

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

Package

documentation-template

Source

util.lisp (file)

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 (file)

Function: symbol-constant-p SYMBOL

Returns true if SYMBOL is a constant.

Package

documentation-template

Source

util.lisp (file)

Function: write-class-entry SYMBOL DOC-STRING

Writes a full documentation entry for the class SYMBOL.

Package

documentation-template

Source

output.lisp (file)

Function: write-constant-entry SYMBOL DOC-STRING

Writes a full documentation entry for the constant SYMBOL.

Package

documentation-template

Source

output.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: write-macro-entry SYMBOL LAMBDA-LIST DOC-STRING

Writes a full documentation entry for the macro SYMBOL.

Package

documentation-template

Source

output.lisp (file)

Function: write-page-footer ()

Writes the footer of the HTML page.

Package

documentation-template

Source

output.lisp (file)

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 (file)

Function: write-special-var-entry SYMBOL DOC-STRING

Writes a full documentation entry for the special variable SYMBOL.

Package

documentation-template

Source

output.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Generic functions

Generic Function: %sbcl-simple-specializer SPECIALIZER

Returns a simple representation of SPECIALIZER.

Package

documentation-template

Source

util.lisp (file)

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

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   D   F   L  
Index Entry  Section

D
documentation-template.asd: The documentation-template<dot>asd file
documentation-template/output.lisp: The documentation-template/output<dot>lisp file
documentation-template/packages.lisp: The documentation-template/packages<dot>lisp file
documentation-template/specials.lisp: The documentation-template/specials<dot>lisp file
documentation-template/util.lisp: The documentation-template/util<dot>lisp file

F
File, Lisp, documentation-template.asd: The documentation-template<dot>asd file
File, Lisp, documentation-template/output.lisp: The documentation-template/output<dot>lisp file
File, Lisp, documentation-template/packages.lisp: The documentation-template/packages<dot>lisp file
File, Lisp, documentation-template/specials.lisp: The documentation-template/specials<dot>lisp file
File, Lisp, documentation-template/util.lisp: The documentation-template/util<dot>lisp file

L
Lisp File, documentation-template.asd: The documentation-template<dot>asd file
Lisp File, documentation-template/output.lisp: The documentation-template/output<dot>lisp file
Lisp File, documentation-template/packages.lisp: The documentation-template/packages<dot>lisp file
Lisp File, documentation-template/specials.lisp: The documentation-template/specials<dot>lisp file
Lisp File, documentation-template/util.lisp: The documentation-template/util<dot>lisp file

Jump to:   D   F   L  

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: Internal generic functions
%sbcl-simple-specializer: Internal generic functions
%sbcl-simple-specializer: Internal generic functions

C
class-doc-entry: Internal functions
collect-all-doc-entries: Internal functions
constant-doc-entry: Internal functions
create-template: Exported functions

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

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

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

H
hyperdoc-lookup: Internal functions

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

N
name<: Internal functions
name=: Internal functions

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

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

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

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*hyperdoc-base-uri*: Internal special variables
*maybe-skip-methods-p*: Exported special variables
*symbols*: Internal special variables
*target*: Exported special variables

S
Special Variable, *hyperdoc-base-uri*: Internal special variables
Special Variable, *maybe-skip-methods-p*: Exported special variables
Special Variable, *symbols*: Internal special variables
Special Variable, *target*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   D   P   S  
Index Entry  Section

D
documentation-template: The documentation-template system
documentation-template: The documentation-template package
documentation-template-asd: The documentation-template-asd package

P
Package, documentation-template: The documentation-template package
Package, documentation-template-asd: The documentation-template-asd package

S
System, documentation-template: The documentation-template system

Jump to:   D   P   S