The docbrowser Reference Manual

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

The docbrowser Reference Manual

This is the docbrowser Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:27:23 2022 GMT+0.

Table of Contents


1 Introduction

Docbrowser - Web-based Common Lisp documentation browser

Author information

Elias Mårtenson

Source code repository location

The latest version of Docbrowser can be found at Github:

https://github.com/lokedhs/docbrowser

Compatibility

The application has been tested on SBCL, CCL and CLISP. Please let me know of any issues on other Common Lisp implementations.

Starting the server

After loading the package, run the following command from the REPL:

(docbrowser:start-docserver)

This will start the docserver on port 8080. A different port number can also be given with an optional :port argument.

To access the docbrowser, point a web browser to http://localhost:8080/

The main page presents a list of all the available packages. You can click on one to see its functions and variables, with their docstrings. You can also go to a function's source.


2 Systems

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


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

2.1 docbrowser

Web-based Common Lisp documentation browser

Author

Elias Martenson <lokedhs@gmail.com>

License

BSD

Dependencies
  • hunchentoot (system).
  • bordeaux-threads (system).
  • yacc (system).
  • parse-number (system).
  • babel (system).
  • closer-mop (system).
  • swank (system).
  • cl-json (system).
  • flexi-streams (system).
  • colorize (system).
  • split-sequence (system).
  • string-case (system).
  • alexandria (system).
Source

docbrowser.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 docbrowser/template

Source

docbrowser.asd.

Parent Component

docbrowser (system).

Child Components

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

3.2 docbrowser/src

Dependency

template (module).

Source

docbrowser.asd.

Parent Component

docbrowser (system).

Child Components

4 Files

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


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

4.1 Lisp


4.1.1 docbrowser/docbrowser.asd

Source

docbrowser.asd.

Parent Component

docbrowser (system).

ASDF Systems

docbrowser.

Packages

docbrowser-system.


4.1.2 docbrowser/template/template-package.lisp

Source

docbrowser.asd.

Parent Component

template (module).

Packages

docbrowser-template.

Internals

*compile-decl* (special variable).


4.1.3 docbrowser/template/util.lisp

Dependency

template-package.lisp (file).

Source

docbrowser.asd.

Parent Component

template (module).

Public Interface
Internals

4.1.4 docbrowser/template/template.lisp

Dependency

util.lisp (file).

Source

docbrowser.asd.

Parent Component

template (module).

Public Interface
Internals

4.1.5 docbrowser/template/parser.lisp

Dependency

template.lisp (file).

Source

docbrowser.asd.

Parent Component

template (module).

Packages

template-parse.

Public Interface
Internals

4.1.6 docbrowser/src/package.lisp

Source

docbrowser.asd.

Parent Component

src (module).

Packages

docbrowser.


4.1.7 docbrowser/src/misc.lisp

Dependency

package.lisp (file).

Source

docbrowser.asd.

Parent Component

src (module).

Internals

4.1.8 docbrowser/src/server.lisp

Dependency

misc.lisp (file).

Source

docbrowser.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.9 docbrowser/src/docbrowser.lisp

Dependency

server.lisp (file).

Source

docbrowser.asd.

Parent Component

src (module).

Packages

docbrowser-empty.

Internals

4.1.10 docbrowser/src/search.lisp

Dependency

docbrowser.lisp (file).

Source

docbrowser.asd.

Parent Component

src (module).

Internals

4.1.11 docbrowser/src/source-function.lisp

Dependency

search.lisp (file).

Source

docbrowser.asd.

Parent Component

src (module).

Internals

5 Packages

Packages are listed by definition order.


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

5.1 template-parse

Source

parser.lisp.


5.2 docbrowser-empty

Empty package that is used internally by Docbrowser

Source

docbrowser.lisp.


5.3 docbrowser-template

Source

template-package.lisp.

Use List

common-lisp.

Public Interface
Internals

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

5.4 docbrowser-system

private: ASDF system package for Docbrowser.

Source

docbrowser.asd.

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

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

5.5 docbrowser

Runs a webserver that allows the user to browse and search information about the packages in the Lisp runtime, including functions, classes and variables.

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


6.1.1 Special variables

Special Variable: *begin-code*

The string that opens a script segment. The end of a script segment is specified by *END-CODE*.

Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *current-content*
Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *end-code*

The string that ends a script segment.

Package

docbrowser-template.

Source

parser.lisp.


6.1.2 Ordinary functions

Function: escape-string-all (string s)

Escapes all characters in STRING which aren’t in the 7-bit ASCII character set.

Package

docbrowser-template.

Source

util.lisp.

Function: escape-string-minimal (string s)

Escape only #<, #>, and #& in STRING.

Package

docbrowser-template.

Source

util.lisp.

Function: escape-string-minimal-plus-quotes (string s)

Like ESCAPE-STRING-MINIMAL but also escapes quotes.

Package

docbrowser-template.

Source

util.lisp.

Function: exec-template-file (file data stream &key binary encoding)

Load and compile FILE and put it into the template cache if it was not already in the cache. Then run the template using DATA and write the output to STREAM.

Package

docbrowser-template.

Source

template.lisp.

Function: parse-template (stream &key binary encoding include-root-dir)

Parses and compiles the template defition given as STREAM. If BINARY
is NIL, the generated template will output its data as strings (using PRINC), otherwise the output will be converted to binary using the encoding specified by ENCODING. The binary output is the preferred
method as that will allow constant strings in the template to be
encoded during parsing instead of at runtime.

INCLUDE-ROOT-DIR is used to specify a base directory from where the "include" command will search for files.

The return value is a function that takes two arguments, DATA and OUTPUT. DATA is the data that will be used by the template, and OUTPUT is the output stream to which the result should be written.

Package

docbrowser-template.

Source

parser.lisp.

Function: start-docserver (&optional port)

Start the documentation server with a HTTP listener on port PORT.

Package

docbrowser.

Source

server.lisp.

Function: stop-docserver ()

Stop the documentation server.

Package

docbrowser.

Source

server.lisp.


6.1.3 Generic functions

Generic Reader: template-error-column (condition)
Package

docbrowser-template.

Methods
Reader Method: template-error-column ((condition template-error))
Source

parser.lisp.

Target Slot

column.

Generic Reader: template-error-content (condition)
Package

docbrowser-template.

Methods
Reader Method: template-error-content ((condition template-error))
Source

parser.lisp.

Target Slot

content.

Generic Reader: template-error-content-index (condition)
Package

docbrowser-template.

Methods
Reader Method: template-error-content-index ((condition template-error))
Source

parser.lisp.

Target Slot

content-index.

Generic Reader: template-error-line (condition)
Package

docbrowser-template.

Methods
Reader Method: template-error-line ((condition template-error))
Source

parser.lisp.

Target Slot

line.

Generic Reader: template-error-message (condition)
Package

docbrowser-template.

Methods
Reader Method: template-error-message ((condition template-error))
Source

parser.lisp.

Target Slot

message.


6.1.4 Standalone methods

Method: acceptor-dispatch-request ((acceptor docbrowser-acceptor) request)
Package

hunchentoot.

Source

server.lisp.

Method: initialize-instance :after ((obj parsed-file) &key &allow-other-keys)
Source

template.lisp.

Method: initialize-instance :after ((acceptor docbrowser-acceptor) &key &allow-other-keys)
Source

server.lisp.


6.1.5 Conditions

Condition: template-error

Error that is raised if there is an error parsing a template

Package

docbrowser-template.

Source

parser.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: line

The line number where the error occurred.

Initform

(quote (error "~s required when creating ~s" :line (quote docbrowser-template:template-error)))

Initargs

:line

Readers

template-error-line.

Writers

This slot is read-only.

Slot: column

The column index of the line where the error occurred, if available. Otherwise NIL.

Initform

(quote nil)

Initargs

:column

Readers

template-error-column.

Writers

This slot is read-only.

Slot: message

The error message

Initform

(quote (error "~s required when creating ~s" :message (quote docbrowser-template:template-error)))

Initargs

:message

Readers

template-error-message.

Writers

This slot is read-only.

Slot: content

The actual template content where the error occurred. Either the entire line, or part of it.

Initform

(quote nil)

Initargs

:content

Readers

template-error-content.

Writers

This slot is read-only.

Slot: content-index

The position in content closest to the actual error, or NIL if the information is not available.

Initform

(quote nil)

Initargs

:content-index

Readers

template-error-content-index.

Writers

This slot is read-only.


6.2 Internals


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

6.2.1 Special variables

Special Variable: *actions*
Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *cached-templates*
Package

docbrowser-template.

Source

template.lisp.

Special Variable: *cached-templates-lock*
Package

docbrowser-template.

Source

template.lisp.

Special Variable: *compile-decl*
Package

docbrowser-template.

Source

template-package.lisp.

Special Variable: *current-line-num*

Dynamic variable used to track the current line number during parsing

Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *current-stream*

The stream that the template output is written to.

Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *escape-char-p*
Package

docbrowser-template.

Source

util.lisp.

Special Variable: *files-base-dir*
Package

docbrowser.

Source

server.lisp.

Special Variable: *global-acceptor*

The acceptor for the currently running server.

Package

docbrowser.

Source

server.lisp.

Special Variable: *include-root-dir*
Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *maximum-search-results*

The maximum number of search results returned.

Package

docbrowser.

Source

search.lisp.

Special Variable: *output-binary*
Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *output-encoding*
Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *subtemplate-list*
Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *template-parser*
Package

docbrowser-template.

Source

parser.lisp.

Special Variable: *url-handlers*

A hash table keyed on the base URL that maps to the underlying handler function

Package

docbrowser.

Source

server.lisp.


6.2.2 Macros

Macro: define-handler-fn (name url &body body)
Package

docbrowser.

Source

server.lisp.

Macro: define-json-handler-fn (name url data-symbol &body body)
Package

docbrowser.

Source

search.lisp.

Macro: make-lexer-actions (&rest definitions)
Package

docbrowser-template.

Source

parser.lisp.

Macro: short-define-parser (name initials &body definitions)
Package

docbrowser-template.

Source

parser.lisp.

Macro: with-hunchentoot-stream ((out &optional content-type append-charset) &body body)
Package

docbrowser.

Source

server.lisp.


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

6.2.3 Ordinary functions

Function: %annotate-function-info (fn-info classes)

Append :ACCESSORP tag if the function is present as an accessor function.

Package

docbrowser.

Source

docbrowser.lisp.

Function: %ensure-external (symbol)
Package

docbrowser.

Source

docbrowser.lisp.

Function: %make-define-handler-fn-form (docstring name body)
Package

docbrowser.

Source

server.lisp.

Function: %show-package-screen-show (out package)
Package

docbrowser.

Source

docbrowser.lisp.

Function: assoc-cdr (key data &key error-p)

Return (CDR (ASSOC KEY DATA)). If ERROR-P is non-NIL, signal an error if KEY is not available is DATA.

Package

docbrowser.

Source

misc.lisp.

Function: assoc-name (v)
Package

docbrowser.

Source

docbrowser.lisp.

Function: debug-lexer (string)
Package

docbrowser-template.

Source

parser.lisp.

Function: debug-parser (s &optional binary)
Package

docbrowser-template.

Source

parser.lisp.

Function: escape-char (ch)
Package

docbrowser.

Source

source-function.lisp.

Function: escape-string (string s &key test)
Package

docbrowser-template.

Source

util.lisp.

Function: escape-string-slashes (string)
Package

docbrowser-template.

Source

parser.lisp.

Function: exec-template-to-string (file data)
Package

docbrowser-template.

Source

template.lisp.

Function: find-matching-symbols (string)
Package

docbrowser.

Source

search.lisp.

Function: find-superclasses (class)
Package

docbrowser.

Source

docbrowser.lisp.

Function: format-argument-to-string (arg)
Package

docbrowser.

Source

docbrowser.lisp.

Function: format-source (source-descriptor)
Package

docbrowser.

Source

source-function.lisp.

Function: hunchentoot-stream-as-text (&key content-type append-charset)

Sends the appropriate headers to ensure that all data is sent back using the correct encoding and returns a text stream that the result can be written to.

Package

docbrowser.

Source

server.lisp.

Function: inner-parse-stream-to-form (stream)
Package

docbrowser-template.

Source

parser.lisp.

Function: load-accessor-info (class slot)
Package

docbrowser.

Source

docbrowser.lisp.

Function: load-class-info (class-name)
Package

docbrowser.

Source

docbrowser.lisp.

Function: load-function-info (symbol)
Package

docbrowser.

Source

docbrowser.lisp.

Function: load-slots (class)
Package

docbrowser.

Source

docbrowser.lisp.

Function: load-specialisation-info (class-name)
Package

docbrowser.

Source

docbrowser.lisp.

Function: load-variable-info (symbol)
Package

docbrowser.

Source

docbrowser.lisp.

Function: main-screen ()
Package

docbrowser.

Source

docbrowser.lisp.

Function: make-lexer-actions-list (definitions)
Package

docbrowser-template.

Source

parser.lisp.

Function: make-stream-template-lexer (input-stream)
Package

docbrowser-template.

Source

parser.lisp.

Function: nice-princ-to-string (obj)
Package

docbrowser.

Source

misc.lisp.

Function: package-list-screen ()
Package

docbrowser.

Source

docbrowser.lisp.

Function: parse-stream-to-form (stream binary encoding include-root-dir)
Package

docbrowser-template.

Source

parser.lisp.

Function: parse-template-file (pathname &key binary encoding)
Package

docbrowser-template.

Source

template.lisp.

Function: prin1-to-string-with-package (obj package)
Package

docbrowser.

Source

misc.lisp.

Function: process-json (fn)
Package

docbrowser.

Source

search.lisp.

Function: process-search-result (symbols)
Package

docbrowser.

Source

search.lisp.

Function: read-file-content (file)
Package

docbrowser.

Source

source-function.lisp.

Function: safe-class-for-symbol (symbol)
Package

docbrowser.

Source

docbrowser.lisp.

Function: search-command-screen ()

Handler for AJAX-calls to perform a search operation

Package

docbrowser.

Source

search.lisp.

Function: search-screen ()
Package

docbrowser.

Source

search.lisp.

Function: show-package-screen ()
Package

docbrowser.

Source

docbrowser.lisp.

Function: show-template (out file data)
Package

docbrowser.

Source

server.lisp.

Function: signal-template-error (message &optional column content content-index)
Package

docbrowser-template.

Source

parser.lisp.

Function: source-function-screen ()
Package

docbrowser.

Source

source-function.lisp.

Function: specialise->symbol (spec)
Package

docbrowser.

Source

docbrowser.lisp.

Function: string->symbol (symbol-name &optional package)
Package

docbrowser-template.

Source

parser.lisp.

Function: style-from-type (type)
Package

docbrowser.

Source

source-function.lisp.

Function: symbol-external-p (symbol &optional package)

Return non-NIL if SYMBOL is external in PACKAGE. SYMBOL may be either a symbol, or a SETF form, in which case the check will be performed on the CADR of the list.

Package

docbrowser.

Source

misc.lisp.


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

6.2.4 Generic functions

Generic Reader: docbrowser-acceptor-files-dispatcher (object)
Package

docbrowser.

Methods
Reader Method: docbrowser-acceptor-files-dispatcher ((docbrowser-acceptor docbrowser-acceptor))

List of fallback dispatchers

Source

server.lisp.

Target Slot

files-dispatcher.

Generic Reader: parsed-file-last-time-check (object)
Package

docbrowser-template.

Methods
Reader Method: parsed-file-last-time-check ((parsed-file parsed-file))

automatically generated reader method

Source

template.lisp.

Target Slot

last-time-check.

Generic Writer: (setf parsed-file-last-time-check) (object)
Package

docbrowser-template.

Methods
Writer Method: (setf parsed-file-last-time-check) ((parsed-file parsed-file))

automatically generated writer method

Source

template.lisp.

Target Slot

last-time-check.

Generic Reader: parsed-file-modified-date (object)
Package

docbrowser-template.

Methods
Reader Method: parsed-file-modified-date ((parsed-file parsed-file))

automatically generated reader method

Source

template.lisp.

Target Slot

modified-date.

Generic Reader: parsed-file-pathspec (object)
Package

docbrowser-template.

Methods
Reader Method: parsed-file-pathspec ((parsed-file parsed-file))

automatically generated reader method

Source

template.lisp.

Target Slot

name.

Generic Reader: parsed-file-template (object)
Package

docbrowser-template.

Methods
Reader Method: parsed-file-template ((parsed-file parsed-file))

automatically generated reader method

Source

template.lisp.

Target Slot

template.


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

6.2.5 Classes

Class: docbrowser-acceptor

Acceptor for the documentation browser

Package

docbrowser.

Source

server.lisp.

Direct superclasses

acceptor.

Direct methods
Direct slots
Slot: files-dispatcher

List of fallback dispatchers

Readers

docbrowser-acceptor-files-dispatcher.

Writers

This slot is read-only.

Class: parsed-file

Cached parse result

Package

docbrowser-template.

Source

template.lisp.

Direct methods
Direct slots
Slot: name
Type

pathname

Initform

(error "name is a required parameter")

Initargs

:name

Readers

parsed-file-pathspec.

Writers

This slot is read-only.

Slot: modified-date
Type

integer

Readers

parsed-file-modified-date.

Writers

This slot is read-only.

Slot: last-time-check
Type

integer

Readers

parsed-file-last-time-check.

Writers

(setf parsed-file-last-time-check).

Slot: template
Type

function

Initform

(error "template is unset")

Initargs

:template

Readers

parsed-file-template.

Writers

This slot is read-only.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   %   (  
A   D   E   F   G   H   I   L   M   N   P   R   S   T   W  
Index Entry  Section

%
%annotate-function-info: Private ordinary functions
%ensure-external: Private ordinary functions
%make-define-handler-fn-form: Private ordinary functions
%show-package-screen-show: Private ordinary functions

(
(setf parsed-file-last-time-check): Private generic functions
(setf parsed-file-last-time-check): Private generic functions

A
acceptor-dispatch-request: Public standalone methods
assoc-cdr: Private ordinary functions
assoc-name: Private ordinary functions

D
debug-lexer: Private ordinary functions
debug-parser: Private ordinary functions
define-handler-fn: Private macros
define-json-handler-fn: Private macros
docbrowser-acceptor-files-dispatcher: Private generic functions
docbrowser-acceptor-files-dispatcher: Private generic functions

E
escape-char: Private ordinary functions
escape-string: Private ordinary functions
escape-string-all: Public ordinary functions
escape-string-minimal: Public ordinary functions
escape-string-minimal-plus-quotes: Public ordinary functions
escape-string-slashes: Private ordinary functions
exec-template-file: Public ordinary functions
exec-template-to-string: Private ordinary functions

F
find-matching-symbols: Private ordinary functions
find-superclasses: Private ordinary functions
format-argument-to-string: Private ordinary functions
format-source: Private ordinary functions
Function, %annotate-function-info: Private ordinary functions
Function, %ensure-external: Private ordinary functions
Function, %make-define-handler-fn-form: Private ordinary functions
Function, %show-package-screen-show: Private ordinary functions
Function, assoc-cdr: Private ordinary functions
Function, assoc-name: Private ordinary functions
Function, debug-lexer: Private ordinary functions
Function, debug-parser: Private ordinary functions
Function, escape-char: Private ordinary functions
Function, escape-string: Private ordinary functions
Function, escape-string-all: Public ordinary functions
Function, escape-string-minimal: Public ordinary functions
Function, escape-string-minimal-plus-quotes: Public ordinary functions
Function, escape-string-slashes: Private ordinary functions
Function, exec-template-file: Public ordinary functions
Function, exec-template-to-string: Private ordinary functions
Function, find-matching-symbols: Private ordinary functions
Function, find-superclasses: Private ordinary functions
Function, format-argument-to-string: Private ordinary functions
Function, format-source: Private ordinary functions
Function, hunchentoot-stream-as-text: Private ordinary functions
Function, inner-parse-stream-to-form: Private ordinary functions
Function, load-accessor-info: Private ordinary functions
Function, load-class-info: Private ordinary functions
Function, load-function-info: Private ordinary functions
Function, load-slots: Private ordinary functions
Function, load-specialisation-info: Private ordinary functions
Function, load-variable-info: Private ordinary functions
Function, main-screen: Private ordinary functions
Function, make-lexer-actions-list: Private ordinary functions
Function, make-stream-template-lexer: Private ordinary functions
Function, nice-princ-to-string: Private ordinary functions
Function, package-list-screen: Private ordinary functions
Function, parse-stream-to-form: Private ordinary functions
Function, parse-template: Public ordinary functions
Function, parse-template-file: Private ordinary functions
Function, prin1-to-string-with-package: Private ordinary functions
Function, process-json: Private ordinary functions
Function, process-search-result: Private ordinary functions
Function, read-file-content: Private ordinary functions
Function, safe-class-for-symbol: Private ordinary functions
Function, search-command-screen: Private ordinary functions
Function, search-screen: Private ordinary functions
Function, show-package-screen: Private ordinary functions
Function, show-template: Private ordinary functions
Function, signal-template-error: Private ordinary functions
Function, source-function-screen: Private ordinary functions
Function, specialise->symbol: Private ordinary functions
Function, start-docserver: Public ordinary functions
Function, stop-docserver: Public ordinary functions
Function, string->symbol: Private ordinary functions
Function, style-from-type: Private ordinary functions
Function, symbol-external-p: Private ordinary functions

G
Generic Function, (setf parsed-file-last-time-check): Private generic functions
Generic Function, docbrowser-acceptor-files-dispatcher: Private generic functions
Generic Function, parsed-file-last-time-check: Private generic functions
Generic Function, parsed-file-modified-date: Private generic functions
Generic Function, parsed-file-pathspec: Private generic functions
Generic Function, parsed-file-template: Private generic functions
Generic Function, template-error-column: Public generic functions
Generic Function, template-error-content: Public generic functions
Generic Function, template-error-content-index: Public generic functions
Generic Function, template-error-line: Public generic functions
Generic Function, template-error-message: Public generic functions

H
hunchentoot-stream-as-text: Private ordinary functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
inner-parse-stream-to-form: Private ordinary functions

L
load-accessor-info: Private ordinary functions
load-class-info: Private ordinary functions
load-function-info: Private ordinary functions
load-slots: Private ordinary functions
load-specialisation-info: Private ordinary functions
load-variable-info: Private ordinary functions

M
Macro, define-handler-fn: Private macros
Macro, define-json-handler-fn: Private macros
Macro, make-lexer-actions: Private macros
Macro, short-define-parser: Private macros
Macro, with-hunchentoot-stream: Private macros
main-screen: Private ordinary functions
make-lexer-actions: Private macros
make-lexer-actions-list: Private ordinary functions
make-stream-template-lexer: Private ordinary functions
Method, (setf parsed-file-last-time-check): Private generic functions
Method, acceptor-dispatch-request: Public standalone methods
Method, docbrowser-acceptor-files-dispatcher: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, parsed-file-last-time-check: Private generic functions
Method, parsed-file-modified-date: Private generic functions
Method, parsed-file-pathspec: Private generic functions
Method, parsed-file-template: Private generic functions
Method, template-error-column: Public generic functions
Method, template-error-content: Public generic functions
Method, template-error-content-index: Public generic functions
Method, template-error-line: Public generic functions
Method, template-error-message: Public generic functions

N
nice-princ-to-string: Private ordinary functions

P
package-list-screen: Private ordinary functions
parse-stream-to-form: Private ordinary functions
parse-template: Public ordinary functions
parse-template-file: Private ordinary functions
parsed-file-last-time-check: Private generic functions
parsed-file-last-time-check: Private generic functions
parsed-file-modified-date: Private generic functions
parsed-file-modified-date: Private generic functions
parsed-file-pathspec: Private generic functions
parsed-file-pathspec: Private generic functions
parsed-file-template: Private generic functions
parsed-file-template: Private generic functions
prin1-to-string-with-package: Private ordinary functions
process-json: Private ordinary functions
process-search-result: Private ordinary functions

R
read-file-content: Private ordinary functions

S
safe-class-for-symbol: Private ordinary functions
search-command-screen: Private ordinary functions
search-screen: Private ordinary functions
short-define-parser: Private macros
show-package-screen: Private ordinary functions
show-template: Private ordinary functions
signal-template-error: Private ordinary functions
source-function-screen: Private ordinary functions
specialise->symbol: Private ordinary functions
start-docserver: Public ordinary functions
stop-docserver: Public ordinary functions
string->symbol: Private ordinary functions
style-from-type: Private ordinary functions
symbol-external-p: Private ordinary functions

T
template-error-column: Public generic functions
template-error-column: Public generic functions
template-error-content: Public generic functions
template-error-content: Public generic functions
template-error-content-index: Public generic functions
template-error-content-index: Public generic functions
template-error-line: Public generic functions
template-error-line: Public generic functions
template-error-message: Public generic functions
template-error-message: Public generic functions

W
with-hunchentoot-stream: Private macros

Jump to:   %   (  
A   D   E   F   G   H   I   L   M   N   P   R   S   T   W  

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

A.3 Variables

Jump to:   *  
C   F   L   M   N   S   T  
Index Entry  Section

*
*actions*: Private special variables
*begin-code*: Public special variables
*cached-templates*: Private special variables
*cached-templates-lock*: Private special variables
*compile-decl*: Private special variables
*current-content*: Public special variables
*current-line-num*: Private special variables
*current-stream*: Private special variables
*end-code*: Public special variables
*escape-char-p*: Private special variables
*files-base-dir*: Private special variables
*global-acceptor*: Private special variables
*include-root-dir*: Private special variables
*maximum-search-results*: Private special variables
*output-binary*: Private special variables
*output-encoding*: Private special variables
*subtemplate-list*: Private special variables
*template-parser*: Private special variables
*url-handlers*: Private special variables

C
column: Public conditions
content: Public conditions
content-index: Public conditions

F
files-dispatcher: Private classes

L
last-time-check: Private classes
line: Public conditions

M
message: Public conditions
modified-date: Private classes

N
name: Private classes

S
Slot, column: Public conditions
Slot, content: Public conditions
Slot, content-index: Public conditions
Slot, files-dispatcher: Private classes
Slot, last-time-check: Private classes
Slot, line: Public conditions
Slot, message: Public conditions
Slot, modified-date: Private classes
Slot, name: Private classes
Slot, template: Private classes
Special Variable, *actions*: Private special variables
Special Variable, *begin-code*: Public special variables
Special Variable, *cached-templates*: Private special variables
Special Variable, *cached-templates-lock*: Private special variables
Special Variable, *compile-decl*: Private special variables
Special Variable, *current-content*: Public special variables
Special Variable, *current-line-num*: Private special variables
Special Variable, *current-stream*: Private special variables
Special Variable, *end-code*: Public special variables
Special Variable, *escape-char-p*: Private special variables
Special Variable, *files-base-dir*: Private special variables
Special Variable, *global-acceptor*: Private special variables
Special Variable, *include-root-dir*: Private special variables
Special Variable, *maximum-search-results*: Private special variables
Special Variable, *output-binary*: Private special variables
Special Variable, *output-encoding*: Private special variables
Special Variable, *subtemplate-list*: Private special variables
Special Variable, *template-parser*: Private special variables
Special Variable, *url-handlers*: Private special variables

T
template: Private classes

Jump to:   *  
C   F   L   M   N   S   T  

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

A.4 Data types

Jump to:   C   D   F   M   P   S   T   U  
Index Entry  Section

C
Class, docbrowser-acceptor: Private classes
Class, parsed-file: Private classes
Condition, template-error: Public conditions

D
docbrowser: The docbrowser system
docbrowser: The docbrowser package
docbrowser-acceptor: Private classes
docbrowser-empty: The docbrowser-empty package
docbrowser-system: The docbrowser-system package
docbrowser-template: The docbrowser-template package
docbrowser.asd: The docbrowser/docbrowser․asd file
docbrowser.lisp: The docbrowser/src/docbrowser․lisp file

F
File, docbrowser.asd: The docbrowser/docbrowser․asd file
File, docbrowser.lisp: The docbrowser/src/docbrowser․lisp file
File, misc.lisp: The docbrowser/src/misc․lisp file
File, package.lisp: The docbrowser/src/package․lisp file
File, parser.lisp: The docbrowser/template/parser․lisp file
File, search.lisp: The docbrowser/src/search․lisp file
File, server.lisp: The docbrowser/src/server․lisp file
File, source-function.lisp: The docbrowser/src/source-function․lisp file
File, template-package.lisp: The docbrowser/template/template-package․lisp file
File, template.lisp: The docbrowser/template/template․lisp file
File, util.lisp: The docbrowser/template/util․lisp file

M
misc.lisp: The docbrowser/src/misc․lisp file
Module, src: The docbrowser/src module
Module, template: The docbrowser/template module

P
Package, docbrowser: The docbrowser package
Package, docbrowser-empty: The docbrowser-empty package
Package, docbrowser-system: The docbrowser-system package
Package, docbrowser-template: The docbrowser-template package
Package, template-parse: The template-parse package
package.lisp: The docbrowser/src/package․lisp file
parsed-file: Private classes
parser.lisp: The docbrowser/template/parser․lisp file

S
search.lisp: The docbrowser/src/search․lisp file
server.lisp: The docbrowser/src/server․lisp file
source-function.lisp: The docbrowser/src/source-function․lisp file
src: The docbrowser/src module
System, docbrowser: The docbrowser system

T
template: The docbrowser/template module
template-error: Public conditions
template-package.lisp: The docbrowser/template/template-package․lisp file
template-parse: The template-parse package
template.lisp: The docbrowser/template/template․lisp file

U
util.lisp: The docbrowser/template/util․lisp file

Jump to:   C   D   F   M   P   S   T   U