Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the eazy-documentation Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:57:45 2021 GMT+0.
| • Introduction | What eazy-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 |
One-shot solution to the CL library documentation generator.
defun),
or requires a user-defined extensions to the parser that extracts the
documentation strings (e.g. see docparser). In contrast, this library runs based on the heuristic
decision and ranking.Best documentation gives you the most with the least text.
Respect the code structure and ordering.
Example page containing the documentation of eazy-documentation itself can be found here.
Another example for NUMCL library.
Command line interface can be installed via Roswell: ros install guicho271828/eazy-documentation
Usage: eazy-documentation file-or-system output [OPTIONS]
The output is a single file when the output has a html extension; otherwise it will be considered as a directory name. It comes with a CSS and an empty javascript file.
Options are specified as follows:
Options:
| keyword | description |
|:----------------|:--------------------------------------------------------------------------|
| :title | Documentation title |
| :header | The header inserted after the title |
| :footer | The footer inserted at the bottom |
| :markup | Markup langage used in the docstring, should be supported by pandoc. |
| | |
| :whitelist | Whitelist of the package designators for the symbols being documented |
| :blacklist | Blacklist of the package designators for the symbols being documented |
| :external-only | Generate entries for external symbols only |
| | |
| :toc | Generate a table of contents (toc) |
| :max-depth | The maximum depth of a toc |
| | |
| :template-class | COMMON-HTML template class, no need to be changed. |
| :css-list | List of CSS scripts to be added to the template. |
| :js-list | List of Javascripts to be added to the template. |
| :font-list | List of Google fonts to be added to the template. |
| :clean | Overwrite CSS/JS in the target directory |
| | |
| :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> |
| :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master |
| :relative | When non-nil, the output is relative to the value of local-root. |
| :static-files | List of static README files etc. |
texinfo and up-to-date pandoc (note: some package
managers, e.g., Ubuntu's APT, provides a severely outdated version and results in a terrible output.
Install the latest version from https://pandoc.org/installing.html )
Masataro Asai (guicho2.71828@gmail.com)
Licensed under LGPL v3.
Copyright (c) 2019 IBM Corporation
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The eazy-documentation system |
Masataro Asai
LGPL
One-shot solution to the CL documentation generator.
0.1
eazy-documentation.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
Next: The eazy-documentation/0package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
/home/quickref/quicklisp/dists/quicklisp/software/eazy-documentation-20210411-git/eazy-documentation.asd
eazy-documentation (system)
Next: The eazy-documentation/1common․lisp file, Previous: The eazy-documentation․asd file, Up: Lisp files [Contents][Index]
eazy-documentation (system)
0package.lisp
Next: The eazy-documentation/1definition․lisp file, Previous: The eazy-documentation/0package․lisp file, Up: Lisp files [Contents][Index]
0package.lisp (file)
eazy-documentation (system)
1common.lisp
Next: The eazy-documentation/1raw-html․lisp file, Previous: The eazy-documentation/1common․lisp file, Up: Lisp files [Contents][Index]
1common.lisp (file)
eazy-documentation (system)
1definition.lisp
Next: The eazy-documentation/2extractor․lisp file, Previous: The eazy-documentation/1definition․lisp file, Up: Lisp files [Contents][Index]
1definition.lisp (file)
eazy-documentation (system)
1raw-html.lisp
Next: The eazy-documentation/3emitter․lisp file, Previous: The eazy-documentation/1raw-html․lisp file, Up: Lisp files [Contents][Index]
1raw-html.lisp (file)
eazy-documentation (system)
2extractor.lisp
Next: The eazy-documentation/4user․lisp file, Previous: The eazy-documentation/2extractor․lisp file, Up: Lisp files [Contents][Index]
2extractor.lisp (file)
eazy-documentation (system)
3emitter.lisp
Next: The eazy-documentation/5template․lisp file, Previous: The eazy-documentation/3emitter․lisp file, Up: Lisp files [Contents][Index]
3emitter.lisp (file)
eazy-documentation (system)
4user.lisp
Next: The eazy-documentation/6main․lisp file, Previous: The eazy-documentation/4user․lisp file, Up: Lisp files [Contents][Index]
4user.lisp (file)
eazy-documentation (system)
5template.lisp
eazy-template (class)
Previous: The eazy-documentation/5template․lisp file, Up: Lisp files [Contents][Index]
5template.lisp (file)
eazy-documentation (system)
6main.lisp
main (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The eazy-documentation package |
This package provides an easy way to extract documentations from
a lisp source code.
Advantages over the existing libraries:
* EAZY-DOCUMENTATION can generate documents from a single file or an ASDF system.
Run ‘(eazy-documentation:generate-html <file-or-system> "index.html")‘
No additional quirks are necessary.
* Extraction is heuristic and robust. It is easily automated and can handle
unknown user-defined macro whose name begins with DEF.
* As per Quickdocs, it respects the file and directory structure. Well-written, maintainable
libraries have a great readability in the source code. This should be respected
and the documentation generator should respect this structure.
* It minimizes the clutter in the auto-generateded output by detecting and
grouping the similar documentation entries.
For example, these entries are grouped together:
* Functions with the same lambda-list and docstrings.
* Variables with the same docstrings.
* Any DEF-something macro entries with the same name and missing documentations.
* Typesetting and syntax highlighting of docstring is done by
[Pandoc](https://pandoc.org/) which supports a wide range of language and
format support.
Run ‘curl -sSL https://get.haskellstack.org/ | sh && stack install pandoc‘
to install the latest Pandoc.
* The output is a common-doc object, thus easily pluggable to the existing emitter
for them.
0package.lisp (file)
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]
1raw-html.lisp (file)
1raw-html.lisp (file)
1raw-html.lisp (file)
1raw-html.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
6main.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables | ||
| • Internal functions | ||
| • Internal generic functions | ||
| • Internal classes | ||
| • Internal types |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
A list of CSS stylesheet pathnames to be loaded in the html by default.
3emitter.lisp (file)
A list of strings for Google font name
3emitter.lisp (file)
A list of JavaScript pathnames to be loaded in the html by default.
3emitter.lisp (file)
A list of thunks. Each thunk contains code to extract the docstring after loading the system.
This variable is mainly used for parsing (setf (documentation ...)) forms
because the docstring may not be available in the macro expansion time unlike macros such as DEFUN.
2extractor.lisp (file)
2extractor.lisp (file)
3emitter.lisp (file)
1common.lisp (file)
2extractor.lisp (file)
1common.lisp (file)
the list of supported extensions scraped by eazy-documentation
4user.lisp (file)
4user.lisp (file)
1common.lisp (file)
Declare statement that says ignorable for the keyword arguments in +keywords+.
1common.lisp (file)
The list of keyword argument list shared by several functions.
1common.lisp (file)
Next: Internal generic functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
2extractor.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
Supply missing command-line arguments using file information
4user.lisp (file)
Supply missing command-line arguments using system information
4user.lisp (file)
path/to/dir/file -> file
1common.lisp (file)
2extractor.lisp (file)
3emitter.lisp (file)
4user.lisp (file)
1common.lisp (file)
1common.lisp (file)
Compare the name and the doctype. Returns true when they are both EQ.
1definition.lisp (file)
Compare the name (and its package), doctype, file, args, docstring. Returns true when they look same according to a heuristic rule.
1definition.lisp (file)
Compare the file and docstring.
Returns true when they are both missing or EQUAL.
1definition.lisp (file)
path/to/dir/file -> path/to/dir
use uiop:pathname-directory-pathanme when you need path/to/dir/
1common.lisp (file)
3emitter.lisp (file)
3emitter.lisp (file)
2extractor.lisp (file)
2extractor.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
4user.lisp (file)
4user.lisp (file)
force making a div – make-content may omit them if it lacks classes
3emitter.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
3emitter.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
3emitter.lisp (file)
3emitter.lisp (file)
1definition.lisp (file)
3emitter.lisp (file)
Print a list of all macros in the current lisp image whose name starts with DEF.
0package.lisp (file)
1common.lisp (file)
3emitter.lisp (file)
3emitter.lisp (file)
1definition.lisp (file)
Heuristic decision to prune non-docstring
2extractor.lisp (file)
A custom format variant for printing a note while eazy-documentation is processing a file.
0package.lisp (file)
3emitter.lisp (file)
2extractor.lisp (file)
1common.lisp (file)
2extractor.lisp (file)
3emitter.lisp (file)
3emitter.lisp (file)
3emitter.lisp (file)
1common.lisp (file)
remove &whole and &env from a lambda list
2extractor.lisp (file)
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
3emitter.lisp (file)
1definition.lisp (file)
3emitter.lisp (file)
Create a span element with an id based on SYM.
3emitter.lisp (file)
4user.lisp (file)
3emitter.lisp (file)
3emitter.lisp (file)
Extract a tree of document links representing the table of contents of a
document. All the sections in the document must have references, so you should
call fill-unique-refs first.
Completely rewritten from common-html because it infers the depth incorrectly.
3emitter.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
1definition.lisp (file)
automatically generated writer method
1definition.lisp (file)
automatically generated reader method
1definition.lisp (file)
automatically generated writer method
1definition.lisp (file)
automatically generated reader method
1definition.lisp (file)
automatically generated writer method
1definition.lisp (file)
automatically generated reader method
1definition.lisp (file)
automatically generated writer method
1definition.lisp (file)
automatically generated reader method
1definition.lisp (file)
automatically generated writer method
1definition.lisp (file)
Next: Internal types, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
Instances represententing a documentation entry.
1definition.lisp (file)
standard-object (class)
symbol
:doctype
doctype (generic function)
(setf doctype) (generic function)
eazy-documentation::name
:name
name (generic function)
(setf name) (generic function)
list
:args
args (generic function)
(setf args) (generic function)
string
:docstring
docstring (generic function)
(setf docstring) (generic function)
pathname
:file
(or *compile-file-pathname* *load-pathname*)
file (generic function)
(setf file) (generic function)
5template.lisp (file)
template (class)
list
:css-list
eazy-documentation::*default-css*
list
:font-list
eazy-documentation::*default-fonts*
list
:js-list
eazy-documentation::*default-js*
Previous: Internal classes, Up: Internal definitions [Contents][Index]
1definition.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: | E F L |
|---|
| Jump to: | E F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
A B C D E F G I L M N P R S T |
|---|
| Jump to: | (
A B C D E F G I L M N P R S T |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
+
A C D F J N S |
|---|
| Jump to: | *
+
A C D F J N S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C D E N P S T |
|---|
| Jump to: | C D E N P S T |
|---|