The trivial-documentation Reference Manual

Table of Contents

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

The trivial-documentation Reference Manual

This is the trivial-documentation Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:26:36 2018 GMT+0.


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

1 Introduction

trivial-documentation

Description:

trivial-documentation provides a unified API for scraping on-line documentation out of a running Lisp image.

Documentation:


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

2 Systems

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


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

2.1 trivial-documentation

Author

Max Rottenkolber <max@mr.gy>

License

GNU AGPL

Description

Extract documentation and definitions for symbols and packages.

Dependencies
Source

trivial-documentation.asd (file)

Component

extract.lisp (file)


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

3 Files

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


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

3.1 Lisp


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

3.1.1 trivial-documentation.asd

Location

trivial-documentation.asd

Systems

trivial-documentation (system)


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

3.1.2 trivial-documentation/extract.lisp

Parent

trivial-documentation (system)

Location

extract.lisp

Packages

trivial-documentation

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 trivial-documentation

Extract documentation and definitions for symbols and packages.

Source

extract.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: package-api PACKAGE

*Arguments and Values:*

_package_—a _package_ or a _string designator_ naming a _package_.

*Description:*

{extract-api} compiles and returns a _property list_ mapping the external symbols of _package_ to lists of definitions as returned by {symbol-definitions}. The returned _property list_ is in alphabetical order (by comparing the keys).

Package

trivial-documentation

Source

extract.lisp (file)

Function: symbol-definitions SYMBOL

*Arguments and Values:*

_symbol_—a symbol.

*Description:*

{symbol-definitions} compiles and returns a list of definitions for _symbol_. Each definition is a _property list_ containing at least two _properties_:

+ {:kind}—one of {:constant}, {:variable}, {:function}, {:generic-function}, {:macro}, {:structure}, {:class} or {:type}.
+ {:documentation}—the respective documentation string or {nil}.

Definitions of kind {:constant} and {:variable} have an additional _property_ {:value} which holds the initial value of the constant or variable.

Definitions of kind {:function}, {:generic-function} and {:macro} have an additional _property_ {:lambda-list} which holds the lambda list of the (generic) function or macro.

Definitions of kind {:class} have three additional _properties_ {:precedence-list}, {:initargs}, and {:slots} which hold the class precedence list, initialization arguments, and a _plist_ of _slot_ names and documentation strings of the class.

Package

trivial-documentation

Source

extract.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: class-definition CLASS-NAME

Compile definition for CLASS-NAME.

Package

trivial-documentation

Source

extract.lisp (file)

Function: class-precedence-list CLASS-NAME

Get class precedence list for CLASS-NAME.

Package

trivial-documentation

Source

extract.lisp (file)

Function: class-slot-initargs CLASS-NAME

Get class slot initargs for CLASS-NAME.

Package

trivial-documentation

Source

extract.lisp (file)

Function: class-slots CLASS-NAME

Get plist of slot names and docstrings for CLASS-NAME.

Package

trivial-documentation

Source

extract.lisp (file)

Function: function-definition FUNCTION-NAME

Compile definition for FUNCTION-NAME.

Package

trivial-documentation

Source

extract.lisp (file)

Function: function-p FUNCTION-NAME

Tests if FUNCTION-NAME is bound to a function.

Package

trivial-documentation

Source

extract.lisp (file)

Function: generic-function-p FUNCTION-NAME

Tests if FUNCTION-NAME is bound to a generic function.

Package

trivial-documentation

Source

extract.lisp (file)

Function: lambda-list FUNCTION-NAME

Get lambda list for FUNCTION-NAME.

Package

trivial-documentation

Source

extract.lisp (file)

Function: macro-function-p FUNCTION-NAME

Tests if FUNCTION-NAME is bound to a macro function.

Package

trivial-documentation

Source

extract.lisp (file)

Function: make-definition KIND &rest PLIST

Base definition constructor. Prepend PLIST with :KIND property of value KIND.

Package

trivial-documentation

Source

extract.lisp (file)

Function: normalize-lambda-list LAMBDA-LIST

Flatten symbols with default values.

Package

trivial-documentation

Source

extract.lisp (file)

Function: symbol-name-< SYMBOL-X SYMBOL-Y

Predicate to test if symbol names of SYMBOL-X and SYMBOL-Y satisfy STRING<.

Package

trivial-documentation

Source

extract.lisp (file)

Function: type-definition TYPE-NAME

Compile definition for TYPE-NAME.

Package

trivial-documentation

Source

extract.lisp (file)

Function: variable-definition VARIABLE-NAME

Compile definition for VARIABLE.

Package

trivial-documentation

Source

extract.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, trivial-documentation.asd: The trivial-documentation<dot>asd file
File, Lisp, trivial-documentation/extract.lisp: The trivial-documentation/extract<dot>lisp file

L
Lisp File, trivial-documentation.asd: The trivial-documentation<dot>asd file
Lisp File, trivial-documentation/extract.lisp: The trivial-documentation/extract<dot>lisp file

T
trivial-documentation.asd: The trivial-documentation<dot>asd file
trivial-documentation/extract.lisp: The trivial-documentation/extract<dot>lisp file

Jump to:   F   L   T  

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

A.2 Functions

Jump to:   C   F   G   L   M   N   P   S   T   V  
Index Entry  Section

C
class-definition: Internal functions
class-precedence-list: Internal functions
class-slot-initargs: Internal functions
class-slots: Internal functions

F
Function, class-definition: Internal functions
Function, class-precedence-list: Internal functions
Function, class-slot-initargs: Internal functions
Function, class-slots: Internal functions
Function, function-definition: Internal functions
Function, function-p: Internal functions
Function, generic-function-p: Internal functions
Function, lambda-list: Internal functions
Function, macro-function-p: Internal functions
Function, make-definition: Internal functions
Function, normalize-lambda-list: Internal functions
Function, package-api: Exported functions
Function, symbol-definitions: Exported functions
Function, symbol-name-<: Internal functions
Function, type-definition: Internal functions
Function, variable-definition: Internal functions
function-definition: Internal functions
function-p: Internal functions

G
generic-function-p: Internal functions

L
lambda-list: Internal functions

M
macro-function-p: Internal functions
make-definition: Internal functions

N
normalize-lambda-list: Internal functions

P
package-api: Exported functions

S
symbol-definitions: Exported functions
symbol-name-<: Internal functions

T
type-definition: Internal functions

V
variable-definition: Internal functions

Jump to:   C   F   G   L   M   N   P   S   T   V  

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

A.3 Variables


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

A.4 Data types

Jump to:   P   S   T  
Index Entry  Section

P
Package, trivial-documentation: The trivial-documentation package

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

T
trivial-documentation: The trivial-documentation system
trivial-documentation: The trivial-documentation package

Jump to:   P   S   T