Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the trivial-documentation Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:41:17 2018 GMT+0.
| • Introduction: | What trivial-documentation is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
Description:
trivial-documentation provides a unified API for scraping on-line documentation out of a running Lisp image.
Documentation:
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The trivial-documentation system: |
Max Rottenkolber <max@mr.gy>
GNU AGPL
Extract documentation and definitions for symbols and packages.
trivial-documentation.asd (file)
extract.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The trivial-documentation.asd file: | ||
| • The trivial-documentation/extract.lisp file: |
Next: The trivial-documentation/extract<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
trivial-documentation.asd
trivial-documentation (system)
Previous: The trivial-documentation<dot>asd file, Up: Lisp files [Contents][Index]
trivial-documentation (system)
extract.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The trivial-documentation package: |
Extract documentation and definitions for symbols and packages.
extract.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions: |
Previous: Exported definitions, Up: Exported definitions [Contents][Index]
*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).
extract.lisp (file)
*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.
extract.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions: |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Compile definition for CLASS-NAME.
extract.lisp (file)
Get class precedence list for CLASS-NAME.
extract.lisp (file)
Get class slot initargs for CLASS-NAME.
extract.lisp (file)
Get plist of slot names and docstrings for CLASS-NAME.
extract.lisp (file)
Compile definition for FUNCTION-NAME.
extract.lisp (file)
Tests if FUNCTION-NAME is bound to a function.
extract.lisp (file)
Tests if FUNCTION-NAME is bound to a generic function.
extract.lisp (file)
Get lambda list for FUNCTION-NAME.
extract.lisp (file)
Tests if FUNCTION-NAME is bound to a macro function.
extract.lisp (file)
Base definition constructor. Prepend PLIST with :KIND property of value KIND.
extract.lisp (file)
Flatten symbols with default values.
extract.lisp (file)
Predicate to test if symbol names of SYMBOL-X and SYMBOL-Y satisfy STRING<.
extract.lisp (file)
Compile definition for TYPE-NAME.
extract.lisp (file)
Compile definition for VARIABLE.
extract.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L T |
|---|
| Jump to: | F L T |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | C F G L M N P S T V |
|---|
| Jump to: | C F G L M N P S T V |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | P S T |
|---|
| Jump to: | P S T |
|---|