The helambdap Reference Manual

Table of Contents

The helambdap Reference Manual

This is the helambdap Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:55:30 2018 GMT+0.

1 Introduction

HEΛP
====

Copyright (c) 2012-2016 Marco Antoniotti
See file COPYING for licensing information


DESCRIPTION
-----------

HEΛP ("HELP") is yet another CL code documentation utility, which has
been inspired by JavaDoc and doxygen.

HEΛP produces, by default, a (mostly) XHTML set of documents. The
system strives to be simple to use by making a few choices, while
maintaining a number of hooks that can be used to customize the
system, e.g., by producing a different kind of output (e.g., Texinfo).

The simplest way to get HEΛP (pun intended) is to use the function
document, as in the example below, where a few assumptions are made.

We are in the directory where the code to be documented resides.  The
actual documentation will end up in the directory (using POSIX syntax
and conventions) `./docs/html/`.

~~~~
    cl-prompt> (document *the-current-directory* :documentation-title "My Library")
    ;;; Several messages, some warnings and error messages.
    ;;; More messages, more warnings and error messages (these last ones ignored.).
    ;;; Yadda, yadda, yadda....
    NIL
~~~~

As stated, the previous command will create the documentation (with an
index.htm file in the `./docs/html/` folder.  Alas, note that the
`*the-current-directory*` must be obtained in an
implementation-dependent way.  Note also that the default format for
the documentation is (mostly) XHTML.

The documentation thus generated is incomplete.  Some HTML files are
either skeletons or are not there (and your browser may complain
accordingly). It is up to you to fill these files with appropriate
content: a prominent example is the file named introduction.htm which
appears on the first page. It usually appears blank.


INSTALLATION
------------

HEΛP is available on quicklisp.

Otherwise, installation should be simple if you have quicklisp, ASDF,
or MK-DEFSYSTEM set up.  You will need also XHTMΛ and a few other
libraries.  Check out the system files for the current list.

Enjoy

Marco Antoniotti 2015-11-29

2 Systems

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

2.1 helambdap

Author

Marco Antoniotti <mantoniotti (you-know-the-drill) common-lisp.net>

License

BSD like

Description

The HELambdaP System.

Dependencies

• cl-fad
• split-sequence
• xhtmlambda

Source

helambdap.asd (file)

Components

• helambdap-pkg.lisp (file)
• helambdap-globals.lisp (file)
• utilities (module)
• naming.lisp (file)
• doc-bit.lisp (file)
• extract-doc.lisp (file)
• helambdap.lisp (file)
• collect-documentation.lisp (file)
• doc-structure.lisp (file)
• documentation-production.lisp (file)
• xhtml-common-definitions.lisp (file)
• xhtml-lambda-producer.lisp (file)
• impl-dependent (module)

3 Modules

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

3.1 helambdap/utilities

Dependency

helambdap-pkg.lisp (file)

Parent

helambdap (system)

Location

utilities/

Components

• text-utilities.lisp (file)
• filename-utilities.lisp (file)
• time-utilities.lisp (file)
• streams-utilities.lisp (file)
• symbols-utilities.lisp (file)
• lambda-list-parsing.lisp (file)

3.2 helambdap/impl-dependent

Dependency

helambdap-pkg.lisp (file)

Parent

helambdap (system)

Location

impl-dependent/

Components

• sbcl.lisp (file)
• asdf-deps.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 helambdap.asd

Location

helambdap.asd

Systems

helambdap (system)

4.1.2 helambdap/helambdap-pkg.lisp

Parent

helambdap (system)

Location

helambdap-pkg.lisp

Packages

it.unimib.disco.ma.cl.helambdap

4.1.3 helambdap/helambdap-globals.lisp

Dependency

helambdap-pkg.lisp (file)

Parent

helambdap (system)

Location

helambdap-globals.lisp

Exported Definitions

• *everything* (special variable)
• *exclude-directories* (special variable)
• *exclude-files* (special variable)
• *only-documented* (special variable)
• *only-exported* (special variable)

Internal Definitions

• *helambdap-site* (special variable)
• *source-extensions* (special variable)
• *supersede-documentation* (special variable)

4.1.4 helambdap/utilities/text-utilities.lisp

Parent

utilities (module)

Location

utilities/text-utilities.lisp

Internal Definitions

• empty-string-p (function)
• first-line-special (function)
• newline (function)
• newlines (function)
• non-empty-string-p (function)
• sanitize-quotes-for-html (function)
• sanitize-string-for-html (function)
• split-all-lines (function)
• split-at-tex-paragraphs (function)
• split-lines-for-html (function)

4.1.5 helambdap/utilities/filename-utilities.lisp

Parent

utilities (module)

Location

utilities/filename-utilities.lisp

Internal Definitions

• base-name (function)
• directory-name (function)
• enclosing-directory (function)
• quote-wild-in-pathname-name (function)

4.1.6 helambdap/utilities/time-utilities.lisp

Parent

utilities (module)

Location

utilities/time-utilities.lisp

Internal Definitions

• +months+ (special variable)
• +weekdays+ (special variable)
• text-timestamp (function)

4.1.7 helambdap/utilities/streams-utilities.lisp

Parent

utilities (module)

Location

utilities/streams-utilities.lisp

Internal Definitions

• *backlog-length* (special variable)
• *backtraceable-streams* (special variable)
• *whitespace-characters* (special variable)
• clean-stream-backlog (function)
• get-char (function)
• look-at-char (function)
• stream-backlog (function)
• (setf stream-backlog) (function)
• unget-char (function)
• unget-chars (function)
• with-backlogged-stream (macro)

4.1.8 helambdap/utilities/symbols-utilities.lisp

Parent

utilities (module)

Location

utilities/symbols-utilities.lisp

Internal Definitions

• assimilate-package (function)
• external-symbol-p (function)
• inherited-symbol-p (function)
• internal-symbol-p (function)
• symbol-status-in-package (function)
• uninterned-symbol-p (function)

4.1.9 helambdap/utilities/lambda-list-parsing.lisp

Parent

utilities (module)

Location

utilities/lambda-list-parsing.lisp

Internal Definitions

• copy-destructuring-lambda-list (function)
• copy-generic-function-lambda-list (function)
• copy-lambda-list-item (function)
• copy-lambda-list-var (function)
• copy-macro-lambda-list (function)
• copy-ordinary-lambda-list (function)
• copy-specialized-lambda-list (function)
• destructuring-lambda-list (structure)
• destructuring-lambda-list-allow-other-keys (function)
• destructuring-lambda-list-auxiliary-vars (function)
• destructuring-lambda-list-keyword-vars (function)
• destructuring-lambda-list-optional-vars (function)
• destructuring-lambda-list-ordinary-vars (function)
• destructuring-lambda-list-p (function)
• destructuring-lambda-list-rest-var (function)
• generic-function-lambda-list (structure)
• generic-function-lambda-list-allow-other-keys (function)
• generic-function-lambda-list-auxiliary-vars (function)
• generic-function-lambda-list-keyword-vars (function)
• generic-function-lambda-list-optional-vars (function)
• generic-function-lambda-list-ordinary-vars (function)
• generic-function-lambda-list-p (function)
• generic-function-lambda-list-rest-var (function)
• lambda-list-item (structure)
• lambda-list-item-p (function)
• lambda-list-type (type)
• lambda-list-var (structure)
• lambda-list-var-p (function)
• lambda-list-var-type (type)
• ll-allow-other-keys (function)
• ll-auxiliary-vars (function)
• ll-keyword-vars (function)
• ll-optional-vars (function)
• ll-ordinary-vars (function)
• ll-rest-var (function)
• ll-vars (generic function)
• ll-vars (method)
• ll-vars (method)
• ll-vars (method)
• ll-vars (method)
• lli-form (function)
• lli-item (function)
• lli-kind (function)
• lli-name (function)
• llv-form (function)
• llv-item (function)
• llv-kind (function)
• llv-name (function)
• macro-lambda-list (structure)
• macro-lambda-list-allow-other-keys (function)
• macro-lambda-list-auxiliary-vars (function)
• macro-lambda-list-body-var (function)
• macro-lambda-list-env-var (function)
• macro-lambda-list-keyword-vars (function)
• macro-lambda-list-optional-vars (function)
• macro-lambda-list-ordinary-vars (function)
• macro-lambda-list-p (function)
• macro-lambda-list-rest-var (function)
• macro-lambda-list-whole-var (function)
• make-destructuring-lambda-list (function)
• make-generic-function-lambda-list (function)
• make-macro-lambda-list (function)
• make-ordinary-lambda-list (function)
• make-specialized-lambda-list (function)
• mkllitem (function)
• mkllvar (function)
• ordinary-lambda-list (structure)
• ordinary-lambda-list-allow-other-keys (function)
• ordinary-lambda-list-auxiliary-vars (function)
• ordinary-lambda-list-keyword-vars (function)
• ordinary-lambda-list-optional-vars (function)
• ordinary-lambda-list-ordinary-vars (function)
• ordinary-lambda-list-p (function)
• ordinary-lambda-list-rest-var (function)
• parse-ll (generic function)
• parse-ll (method)
• parse-ll (method)
• parse-ll (method)
• parse-ll (method)
• parse-ll (method)
• pll (function)
• specialized-lambda-list (structure)
• specialized-lambda-list-allow-other-keys (function)
• specialized-lambda-list-auxiliary-vars (function)
• specialized-lambda-list-keyword-vars (function)
• specialized-lambda-list-optional-vars (function)
• specialized-lambda-list-ordinary-vars (function)
• specialized-lambda-list-p (function)
• specialized-lambda-list-rest-var (function)
• t_lambda-list (structure)
• t_lambda-list-p (function)

4.1.10 helambdap/naming.lisp

Dependency

helambdap-pkg.lisp (file)

Parent

helambdap (system)

Location

naming.lisp

Internal Definitions

• %make-naming (function)
• copy-naming (function)
• make-naming (function)
• make-naming* (function)
• naming (structure)
• naming-id (function)
• naming-kind (function)
• naming-nesting-path (function)
• naming-p (function)

4.1.11 helambdap/doc-bit.lisp

Dependencies

• naming.lisp (file)
• helambdap-globals.lisp (file)

Parent

helambdap (system)

Location

doc-bit.lisp

Internal Definitions

• article-doc-bit (structure)
• article-doc-bit-components (function)
• (setf article-doc-bit-components) (function)
• article-doc-bit-doc-string (function)
• (setf article-doc-bit-doc-string) (function)
• article-doc-bit-kind (function)
• article-doc-bit-kind-tag (function)
• article-doc-bit-location (function)
• (setf article-doc-bit-location) (function)
• article-doc-bit-name (function)
• article-doc-bit-p (function)
• article-doc-bit-timestamp (function)
• (setf article-doc-bit-timestamp) (function)
• asdf-system-doc-bit (structure)
• asdf-system-doc-bit-depends-on (function)
• asdf-system-doc-bit-doc-string (function)
• (setf asdf-system-doc-bit-doc-string) (function)
• asdf-system-doc-bit-kind (function)
• asdf-system-doc-bit-kind-tag (function)
• asdf-system-doc-bit-location (function)
• (setf asdf-system-doc-bit-location) (function)
• asdf-system-doc-bit-name (function)
• asdf-system-doc-bit-p (function)
• asdf-system-doc-bit-timestamp (function)
• (setf asdf-system-doc-bit-timestamp) (function)
• book-doc-bit (structure)
• book-doc-bit-divisions (function)
• (setf book-doc-bit-divisions) (function)
• book-doc-bit-doc-string (function)
• (setf book-doc-bit-doc-string) (function)
• book-doc-bit-kind (function)
• book-doc-bit-kind-tag (function)
• book-doc-bit-location (function)
• (setf book-doc-bit-location) (function)
• book-doc-bit-name (function)
• book-doc-bit-navigation (function)
• (setf book-doc-bit-navigation) (function)
• book-doc-bit-p (function)
• book-doc-bit-timestamp (function)
• (setf book-doc-bit-timestamp) (function)
• chapter-doc-bit (structure)
• chapter-doc-bit-components (function)
• (setf chapter-doc-bit-components) (function)
• chapter-doc-bit-doc-string (function)
• (setf chapter-doc-bit-doc-string) (function)
• chapter-doc-bit-kind (function)
• chapter-doc-bit-kind-tag (function)
• chapter-doc-bit-location (function)
• (setf chapter-doc-bit-location) (function)
• chapter-doc-bit-name (function)
• chapter-doc-bit-p (function)
• chapter-doc-bit-timestamp (function)
• (setf chapter-doc-bit-timestamp) (function)
• class-doc-bit (structure)
• class-doc-bit-doc-string (function)
• (setf class-doc-bit-doc-string) (function)
• class-doc-bit-kind (function)
• class-doc-bit-kind-tag (function)
• class-doc-bit-location (function)
• (setf class-doc-bit-location) (function)
• class-doc-bit-name (function)
• class-doc-bit-p (function)
• class-doc-bit-slots (function)
• class-doc-bit-superclasses (function)
• class-doc-bit-timestamp (function)
• (setf class-doc-bit-timestamp) (function)
• compiler-macro-doc-bit (structure)
• compiler-macro-doc-bit-doc-string (function)
• (setf compiler-macro-doc-bit-doc-string) (function)
• compiler-macro-doc-bit-ftype-declarations (function)
• compiler-macro-doc-bit-kind (function)
• compiler-macro-doc-bit-kind-tag (function)
• compiler-macro-doc-bit-lambda-list (function)
• compiler-macro-doc-bit-location (function)
• (setf compiler-macro-doc-bit-location) (function)
• compiler-macro-doc-bit-name (function)
• compiler-macro-doc-bit-p (function)
• compiler-macro-doc-bit-timestamp (function)
• (setf compiler-macro-doc-bit-timestamp) (function)
• compiler-macro-doc-bit-type-declarations (function)
• condition-doc-bit (structure)
• condition-doc-bit-doc-string (function)
• (setf condition-doc-bit-doc-string) (function)
• condition-doc-bit-kind (function)
• condition-doc-bit-kind-tag (function)
• condition-doc-bit-location (function)
• (setf condition-doc-bit-location) (function)
• condition-doc-bit-name (function)
• condition-doc-bit-p (function)
• condition-doc-bit-slots (function)
• condition-doc-bit-superclasses (function)
• condition-doc-bit-timestamp (function)
• (setf condition-doc-bit-timestamp) (function)
• constant-doc-bit (structure)
• constant-doc-bit-doc-string (function)
• (setf constant-doc-bit-doc-string) (function)
• constant-doc-bit-initial-value (function)
• constant-doc-bit-kind (function)
• constant-doc-bit-kind-tag (function)
• constant-doc-bit-location (function)
• (setf constant-doc-bit-location) (function)
• constant-doc-bit-name (function)
• constant-doc-bit-p (function)
• constant-doc-bit-timestamp (function)
• (setf constant-doc-bit-timestamp) (function)
• copy-article-doc-bit (function)
• copy-asdf-system-doc-bit (function)
• copy-book-doc-bit (function)
• copy-chapter-doc-bit (function)
• copy-class-doc-bit (function)
• copy-compiler-macro-doc-bit (function)
• copy-condition-doc-bit (function)
• copy-constant-doc-bit (function)
• copy-deftype-doc-bit (function)
• copy-doc-bit (function)
• copy-function-doc-bit (function)
• copy-generic-function-doc-bit (function)
• copy-literal-doc-bit (function)
• copy-macro-doc-bit (function)
• copy-method-combination-doc-bit (function)
• copy-method-doc-bit (function)
• copy-modify-macro-doc-bit (function)
• copy-package-doc-bit (function)
• copy-parameter-doc-bit (function)
• copy-parameterized-doc-bit (function)
• copy-part-doc-bit (function)
• copy-set-doc-bit (function)
• copy-setf-expander-doc-bit (function)
• copy-slotted-doc-bit (function)
• copy-struct-doc-bit (function)
• copy-system-doc-bit (function)
• copy-type-doc-bit (function)
• copy-variable-doc-bit (function)
• def-doc-bit (macro)
• deftype-doc-bit (structure)
• deftype-doc-bit-doc-string (function)
• (setf deftype-doc-bit-doc-string) (function)
• deftype-doc-bit-ftype-declarations (function)
• deftype-doc-bit-kind (function)
• deftype-doc-bit-kind-tag (function)
• deftype-doc-bit-lambda-list (function)
• deftype-doc-bit-location (function)
• (setf deftype-doc-bit-location) (function)
• deftype-doc-bit-name (function)
• deftype-doc-bit-p (function)
• deftype-doc-bit-timestamp (function)
• (setf deftype-doc-bit-timestamp) (function)
• deftype-doc-bit-type-declarations (function)
• doc-bit (structure)
• doc-bit-doc-string (function)
• (setf doc-bit-doc-string) (function)
• doc-bit-identifier (function)
• doc-bit-kind (function)
• doc-bit-kind-tag (function)
• doc-bit-location (function)
• (setf doc-bit-location) (function)
• doc-bit-name (function)
• doc-bit-p (function)
• doc-bit-package (function)
• doc-bit-pathname-name (function)
• doc-bit-timestamp (function)
• (setf doc-bit-timestamp) (function)
• function-doc-bit (structure)
• function-doc-bit-doc-string (function)
• (setf function-doc-bit-doc-string) (function)
• function-doc-bit-ftype-declarations (function)
• function-doc-bit-kind (function)
• function-doc-bit-kind-tag (function)
• function-doc-bit-lambda-list (function)
• function-doc-bit-location (function)
• (setf function-doc-bit-location) (function)
• function-doc-bit-name (function)
• function-doc-bit-p (function)
• function-doc-bit-timestamp (function)
• (setf function-doc-bit-timestamp) (function)
• function-doc-bit-type-declarations (function)
• function-doc-bit-values (function)
• generic-function-doc-bit (structure)
• generic-function-doc-bit-doc-string (function)
• (setf generic-function-doc-bit-doc-string) (function)
• generic-function-doc-bit-ftype-declarations (function)
• generic-function-doc-bit-kind (function)
• generic-function-doc-bit-kind-tag (function)
• generic-function-doc-bit-lambda-list (function)
• generic-function-doc-bit-location (function)
• (setf generic-function-doc-bit-location) (function)
• generic-function-doc-bit-methods (function)
• (setf generic-function-doc-bit-methods) (function)
• generic-function-doc-bit-name (function)
• generic-function-doc-bit-p (function)
• generic-function-doc-bit-timestamp (function)
• (setf generic-function-doc-bit-timestamp) (function)
• generic-function-doc-bit-type-declarations (function)
• generic-function-doc-bit-values (function)
• literal-doc-bit (structure)
• literal-doc-bit-content (function)
• literal-doc-bit-doc-string (function)
• (setf literal-doc-bit-doc-string) (function)
• literal-doc-bit-kind (function)
• literal-doc-bit-kind-tag (function)
• literal-doc-bit-location (function)
• (setf literal-doc-bit-location) (function)
• literal-doc-bit-name (function)
• literal-doc-bit-p (function)
• literal-doc-bit-timestamp (function)
• (setf literal-doc-bit-timestamp) (function)
• macro-doc-bit (structure)
• macro-doc-bit-doc-string (function)
• (setf macro-doc-bit-doc-string) (function)
• macro-doc-bit-ftype-declarations (function)
• macro-doc-bit-kind (function)
• macro-doc-bit-kind-tag (function)
• macro-doc-bit-lambda-list (function)
• macro-doc-bit-location (function)
• (setf macro-doc-bit-location) (function)
• macro-doc-bit-name (function)
• macro-doc-bit-p (function)
• macro-doc-bit-timestamp (function)
• (setf macro-doc-bit-timestamp) (function)
• macro-doc-bit-type-declarations (function)
• make-article-doc-bit (function)
• make-asdf-system-doc-bit (function)
• make-book-doc-bit (function)
• make-chapter-doc-bit (function)
• make-class-doc-bit (function)
• make-compiler-macro-doc-bit (function)
• make-condition-doc-bit (function)
• make-constant-doc-bit (function)
• make-deftype-doc-bit (function)
• make-doc-bit (function)
• make-doc-bit-pathname (function)
• make-function-doc-bit (function)
• make-generic-function-doc-bit (function)
• make-literal-doc-bit (function)
• make-macro-doc-bit (function)
• make-method-combination-doc-bit (function)
• make-method-doc-bit (function)
• make-modify-macro-doc-bit (function)
• make-package-doc-bit (function)
• make-parameter-doc-bit (function)
• make-part-doc-bit (function)
• make-set-doc-bit (function)
• make-setf-expander-doc-bit (function)
• make-struct-doc-bit (function)
• make-type-doc-bit (function)
• make-variable-doc-bit (function)
• method-combination-doc-bit (structure)
• method-combination-doc-bit-doc-string (function)
• (setf method-combination-doc-bit-doc-string) (function)
• method-combination-doc-bit-kind (function)
• method-combination-doc-bit-kind-tag (function)
• method-combination-doc-bit-location (function)
• (setf method-combination-doc-bit-location) (function)
• method-combination-doc-bit-name (function)
• method-combination-doc-bit-p (function)
• method-combination-doc-bit-timestamp (function)
• (setf method-combination-doc-bit-timestamp) (function)
• method-doc-bit (structure)
• method-doc-bit-doc-string (function)
• (setf method-doc-bit-doc-string) (function)
• method-doc-bit-ftype-declarations (function)
• method-doc-bit-kind (function)
• method-doc-bit-kind-tag (function)
• method-doc-bit-lambda-list (function)
• method-doc-bit-location (function)
• (setf method-doc-bit-location) (function)
• method-doc-bit-name (function)
• method-doc-bit-p (function)
• method-doc-bit-qualifiers (function)
• method-doc-bit-timestamp (function)
• (setf method-doc-bit-timestamp) (function)
• method-doc-bit-type-declarations (function)
• method-doc-bit-values (function)
• modify-macro-doc-bit (structure)
• modify-macro-doc-bit-doc-string (function)
• (setf modify-macro-doc-bit-doc-string) (function)
• modify-macro-doc-bit-ftype-declarations (function)
• modify-macro-doc-bit-kind (function)
• modify-macro-doc-bit-kind-tag (function)
• modify-macro-doc-bit-lambda-list (function)
• modify-macro-doc-bit-location (function)
• (setf modify-macro-doc-bit-location) (function)
• modify-macro-doc-bit-name (function)
• modify-macro-doc-bit-p (function)
• modify-macro-doc-bit-timestamp (function)
• (setf modify-macro-doc-bit-timestamp) (function)
• modify-macro-doc-bit-type-declarations (function)
• new-doc-bit (generic function)
• package-doc-bit (structure)
• package-doc-bit-doc-string (function)
• (setf package-doc-bit-doc-string) (function)
• package-doc-bit-kind (function)
• package-doc-bit-kind-tag (function)
• package-doc-bit-location (function)
• (setf package-doc-bit-location) (function)
• package-doc-bit-name (function)
• package-doc-bit-nicknames (function)
• package-doc-bit-p (function)
• package-doc-bit-timestamp (function)
• (setf package-doc-bit-timestamp) (function)
• package-doc-bit-use-list (function)
• parameter-doc-bit (structure)
• parameter-doc-bit-doc-string (function)
• (setf parameter-doc-bit-doc-string) (function)
• parameter-doc-bit-initial-value (function)
• parameter-doc-bit-kind (function)
• parameter-doc-bit-kind-tag (function)
• parameter-doc-bit-location (function)
• (setf parameter-doc-bit-location) (function)
• parameter-doc-bit-name (function)
• parameter-doc-bit-p (function)
• parameter-doc-bit-timestamp (function)
• (setf parameter-doc-bit-timestamp) (function)
• parameterized-doc-bit (structure)
• parameterized-doc-bit-doc-string (function)
• (setf parameterized-doc-bit-doc-string) (function)
• parameterized-doc-bit-ftype-declarations (function)
• parameterized-doc-bit-kind (function)
• parameterized-doc-bit-kind-tag (function)
• parameterized-doc-bit-lambda-list (function)
• parameterized-doc-bit-location (function)
• (setf parameterized-doc-bit-location) (function)
• parameterized-doc-bit-name (function)
• parameterized-doc-bit-p (function)
• parameterized-doc-bit-timestamp (function)
• (setf parameterized-doc-bit-timestamp) (function)
• parameterized-doc-bit-type-declarations (function)
• part-doc-bit (structure)
• part-doc-bit-components (function)
• (setf part-doc-bit-components) (function)
• part-doc-bit-doc-string (function)
• (setf part-doc-bit-doc-string) (function)
• part-doc-bit-kind (function)
• part-doc-bit-kind-tag (function)
• part-doc-bit-location (function)
• (setf part-doc-bit-location) (function)
• part-doc-bit-name (function)
• part-doc-bit-p (function)
• part-doc-bit-timestamp (function)
• (setf part-doc-bit-timestamp) (function)
• set-doc-bit (structure)
• set-doc-bit-doc-string (function)
• (setf set-doc-bit-doc-string) (function)
• set-doc-bit-kind (function)
• set-doc-bit-kind-tag (function)
• set-doc-bit-location (function)
• (setf set-doc-bit-location) (function)
• set-doc-bit-name (function)
• set-doc-bit-p (function)
• set-doc-bit-timestamp (function)
• (setf set-doc-bit-timestamp) (function)
• setf-expander-doc-bit (structure)
• setf-expander-doc-bit-doc-string (function)
• (setf setf-expander-doc-bit-doc-string) (function)
• setf-expander-doc-bit-ftype-declarations (function)
• setf-expander-doc-bit-kind (function)
• setf-expander-doc-bit-kind-tag (function)
• setf-expander-doc-bit-lambda-list (function)
• setf-expander-doc-bit-location (function)
• (setf setf-expander-doc-bit-location) (function)
• setf-expander-doc-bit-name (function)
• setf-expander-doc-bit-p (function)
• setf-expander-doc-bit-timestamp (function)
• (setf setf-expander-doc-bit-timestamp) (function)
• setf-expander-doc-bit-type-declarations (function)
• slotted-doc-bit (structure)
• slotted-doc-bit-doc-string (function)
• (setf slotted-doc-bit-doc-string) (function)
• slotted-doc-bit-kind (function)
• slotted-doc-bit-kind-tag (function)
• slotted-doc-bit-location (function)
• (setf slotted-doc-bit-location) (function)
• slotted-doc-bit-name (function)
• slotted-doc-bit-p (function)
• slotted-doc-bit-slots (function)
• slotted-doc-bit-timestamp (function)
• (setf slotted-doc-bit-timestamp) (function)
• struct-doc-bit (structure)
• struct-doc-bit-doc-string (function)
• (setf struct-doc-bit-doc-string) (function)
• struct-doc-bit-include (function)
• struct-doc-bit-kind (function)
• struct-doc-bit-kind-tag (function)
• struct-doc-bit-location (function)
• (setf struct-doc-bit-location) (function)
• struct-doc-bit-name (function)
• struct-doc-bit-p (function)
• struct-doc-bit-slots (function)
• struct-doc-bit-timestamp (function)
• (setf struct-doc-bit-timestamp) (function)
• system-doc-bit (structure)
• system-doc-bit-depends-on (function)
• system-doc-bit-doc-string (function)
• (setf system-doc-bit-doc-string) (function)
• system-doc-bit-kind (function)
• system-doc-bit-kind-tag (function)
• system-doc-bit-location (function)
• (setf system-doc-bit-location) (function)
• system-doc-bit-name (function)
• system-doc-bit-p (function)
• system-doc-bit-timestamp (function)
• (setf system-doc-bit-timestamp) (function)
• type-doc-bit (structure)
• type-doc-bit-doc-string (function)
• (setf type-doc-bit-doc-string) (function)
• type-doc-bit-kind (function)
• type-doc-bit-kind-tag (function)
• type-doc-bit-location (function)
• (setf type-doc-bit-location) (function)
• type-doc-bit-name (function)
• type-doc-bit-p (function)
• type-doc-bit-timestamp (function)
• (setf type-doc-bit-timestamp) (function)
• variable-doc-bit (structure)
• variable-doc-bit-doc-string (function)
• (setf variable-doc-bit-doc-string) (function)
• variable-doc-bit-initial-value (function)
• variable-doc-bit-kind (function)
• variable-doc-bit-kind-tag (function)
• variable-doc-bit-location (function)
• (setf variable-doc-bit-location) (function)
• variable-doc-bit-name (function)
• variable-doc-bit-p (function)
• variable-doc-bit-timestamp (function)
• (setf variable-doc-bit-timestamp) (function)

4.1.12 helambdap/extract-doc.lisp

Dependency

doc-bit.lisp (file)

Parent

helambdap (system)

Location

extract-doc.lisp

Exported Definitions

• define-documentation-extractor (macro)
• extract-documentation (generic function)
• extract-documentation (method)
• extract-documentation (method)
• extract-documentation (method)
• extract-documentation (method)
• extract-form-documentation (generic function)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-named-form-documentation (generic function)
• extract-named-form-documentation (method)

Internal Definitions

• *current-package* (special variable)
• *try-to-ensure-packages* (special variable)
• collect-declarations (function)
• extract-symbol-form-documentation (function)
• extricate-doc-string (function)
• flatten-if (function)
• form-documentation (function)
• is-declaration (function)
• read-form (function)

4.1.13 helambdap/helambdap.lisp

Dependency

doc-bit.lisp (file)

Parent

helambdap (system)

Location

helambdap.lisp

Exported Definitions

• clear-doc-bits-db (function)
• doc-bits-data-base (structure)
• doc-bits-data-base-p (function)
• documentation (generic function)
• documentation (method)
• documentation (method)
• get-doc-bits (function)
• init-doc-bits-db (function)
• insert-doc-bit (function)
• save-doc-bits-db (generic function)
• save-doc-bits-db (method)
• save-doc-bits-db (method)
• save-doc-bits-db (method)

Internal Definitions

• *doc-bits-db* (special variable)
• *doc-bits-db-file* (special variable)
• copy-doc-bits-data-base (function)
• dbdb (function)
• doc-bits-data-base-dbdb (function)
• fill-doc-bits-db (function)
• load-doc-bits-db (generic function)
• load-doc-bits-db (method)
• load-doc-bits-db (method)
• make-doc-bits-data-base (function)

4.1.14 helambdap/collect-documentation.lisp

Dependency

doc-bit.lisp (file)

Parent

helambdap (system)

Location

collect-documentation.lisp

Internal Definitions

• *info-file-name* (special variable)
• *intro-file-name* (special variable)
• *structure-file-name* (special variable)
• collect-documentation (generic function)
• collect-documentation (method)
• collect-documentation (method)
• collect-documentation (method)
• directory-last-name (function)
• directory-source-files (function)
• sift-standard-doc-bits (function)
• subdirectories (function)

4.1.15 helambdap/doc-structure.lisp

Dependencies

• helambdap-pkg.lisp (file)
• utilities (module)

Parent

helambdap (system)

Location

doc-structure.lisp

Internal Definitions

• %make-doc-file (function)
• %make-file (function)
• %make-file-set (function)
• %make-frame (function)
• %make-frameset (function)
• %make-framesets (function)
• %make-style-file (function)
• %make-texinfo-file (function)
• *default-documentation-structure* (special variable)
• *default-html-extension* (special variable)
• *doc-structures* (special variable)
• *helambdap-css-filename* (special variable)
• *helambdap-css-filename-up* (special variable)
• *helambdap-css-pathname* (special variable)
• *texinfo-documentation-structure* (special variable)
• *xhtml-frame-documentation-structure* (special variable)
• *xhtml-simple-frame-documentation-structure* (special variable)
• compute-element-path (generic function)
• compute-element-path (method)
• compute-element-path (method)
• copy-doc-file (function)
• copy-element (function)
• copy-file (function)
• copy-file-set (function)
• copy-frame (function)
• copy-frameset (function)
• copy-framesets (function)
• copy-style-file (function)
• copy-texinfo-file (function)
• doc-file (function)
• doc-file (structure)
• doc-file-doc-structure (function)
• (setf doc-file-doc-structure) (function)
• doc-file-name (function)
• doc-file-p (function)
• doc-file-parent (function)
• (setf doc-file-parent) (function)
• doc-file-pathname-type (function)
• doc-file-source (function)
• (setf doc-file-source) (function)
• doc-file-style (function)
• (setf doc-file-style) (function)
• documentation-structure (class)
• documentation-structure-name (method)
• documentation-structure-root (method)
• documentation-structure-structure (method)
• element (structure)
• element-doc-structure (function)
• (setf element-doc-structure) (function)
• element-location-depth (function)
• element-location-path (function)
• element-name (function)
• element-p (function)
• element-parent (function)
• (setf element-parent) (function)
• element-source (function)
• (setf element-source) (function)
• element-style (function)
• (setf element-style) (function)
• erase-doc-structure (function)
• file (function)
• file (structure)
• file-doc-structure (function)
• (setf file-doc-structure) (function)
• file-name (function)
• file-p (function)
• file-parent (function)
• (setf file-parent) (function)
• file-pathname (generic function)
• file-pathname (method)
• file-pathname (method)
• file-set (function)
• file-set (structure)
• file-set-doc-structure (function)
• (setf file-set-doc-structure) (function)
• file-set-files (function)
• (setf file-set-files) (function)
• file-set-index (function)
• (setf file-set-index) (function)
• file-set-name (function)
• file-set-p (function)
• file-set-parent (function)
• (setf file-set-parent) (function)
• file-set-source (function)
• (setf file-set-source) (function)
• file-set-style (function)
• (setf file-set-style) (function)
• file-source (function)
• (setf file-source) (function)
• file-style (function)
• (setf file-style) (function)
• find-doc-structure (function)
• frame (function)
• frame (structure)
• frame-doc-structure (function)
• (setf frame-doc-structure) (function)
• frame-name (function)
• frame-p (function)
• frame-parent (function)
• (setf frame-parent) (function)
• frame-source (function)
• (setf frame-source) (function)
• frame-style (function)
• (setf frame-style) (function)
• frameset (function)
• frameset (structure)
• frameset-content (function)
• (setf frameset-content) (function)
• frameset-doc-structure (function)
• (setf frameset-doc-structure) (function)
• frameset-footer (function)
• frameset-footer-name (function)
• frameset-header (function)
• frameset-header-name (function)
• frameset-location (function)
• frameset-name (function)
• frameset-navigation (function)
• frameset-navigation-name (function)
• frameset-order (function)
• (setf frameset-order) (function)
• frameset-p (function)
• frameset-parent (function)
• (setf frameset-parent) (function)
• frameset-sidebar (function)
• frameset-sidebar-name (function)
• frameset-source (function)
• (setf frameset-source) (function)
• frameset-style (function)
• (setf frameset-style) (function)
• framesets (function)
• framesets (structure)
• framesets-doc-structure (function)
• (setf framesets-doc-structure) (function)
• framesets-list (function)
• (setf framesets-list) (function)
• framesets-name (function)
• framesets-p (function)
• framesets-parent (function)
• (setf framesets-parent) (function)
• framesets-source (function)
• (setf framesets-source) (function)
• framesets-style (function)
• (setf framesets-style) (function)
• initialize-element (generic function)
• initialize-element (method)
• make-documentation-structure (function)
• make-element (function)
• pprint-documentation-structure (function)
• pprint-element (generic function)
• pprint-element (method)
• pprint-element (method)
• pprint-element (method)
• property (function)
• (setf property) (function)
• property-table (method)
• read-structure-file (function)
• register-doc-structure (function)
• register-element (generic function)
• register-element (method)
• register-element (method)
• register-element (method)
• set-property (function)
• structure-table (method)
• style-file (function)
• style-file (structure)
• style-file-doc-structure (function)
• (setf style-file-doc-structure) (function)
• style-file-name (function)
• style-file-p (function)
• style-file-parent (function)
• (setf style-file-parent) (function)
• style-file-source (function)
• (setf style-file-source) (function)
• style-file-style (function)
• (setf style-file-style) (function)
• texinfo-file (function)
• texinfo-file (structure)
• texinfo-file-contents (function)
• (setf texinfo-file-contents) (function)
• texinfo-file-doc-structure (function)
• (setf texinfo-file-doc-structure) (function)
• texinfo-file-location (function)
• (setf texinfo-file-location) (function)
• texinfo-file-name (function)
• texinfo-file-p (function)
• texinfo-file-parent (function)
• (setf texinfo-file-parent) (function)
• texinfo-file-source (function)
• (setf texinfo-file-source) (function)
• texinfo-file-style (function)
• (setf texinfo-file-style) (function)

4.1.16 helambdap/documentation-production.lisp

Dependencies

• impl-dependent (module)
• doc-structure.lisp (file)

Parent

helambdap (system)

Location

documentation-production.lisp

Exported Definitions

• build-documentation (generic function)
• build-documentation (method)
• build-documentation (method)
• document (function)
• produce-documentation (generic function)

Internal Definitions

build-doc-skeleton (generic function)

4.1.17 helambdap/xhtml-common-definitions.lisp

Dependency

helambdap-pkg.lisp (file)

Parent

helambdap (system)

Location

xhtml-common-definitions.lisp

Exported Definitions

• +doctype-frameset-control-string+ (special variable)
• +doctype-html5-control-string+ (special variable)
• +doctype-xhtml1-string-control-string+ (special variable)
• +frameset-doctype-public-id+ (special variable)
• +frameset-doctype-system-id+ (special variable)

4.1.18 helambdap/xhtml-lambda-producer.lisp

Dependencies

• doc-structure.lisp (file)
• utilities (module)
• documentation-production.lisp (file)
• xhtml-common-definitions.lisp (file)

Parent

helambdap (system)

Location

xhtml-lambda-producer.lisp

Exported Definitions

• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)

Internal Definitions

• *formatted-section-right-margin* (special variable)
• *xhtml-indent* (special variable)
• +lambda-list-kwds+ (special variable)
• arg-name (function)
• bypass-pprint (function)
• dump-doc-bit-html (function)
• extract-section-name (function)
• extract-section-names (function)
• extract-sections (generic function)
• extract-sections (method)
• extract-sections (method)
• extract-sections (method)
• frameset-body-title (generic function)
• frameset-body-title (method)
• frameset-head-title (generic function)
• frameset-head-title (method)
• framesets-of (generic function)
• framesets-of (method)
• framesets-of (method)
• framesets-of (method)
• paragraphize-doc-string (function)
• parse-doc-hyperspec-style (function)
• process-arg-n-value-pars (function)
• process-doc-string (generic function)
• process-doc-string (method)
• process-doc-string (method)
• process-returns-declaration (function)
• produce-doc-bit-title-name (function)
• produce-doc-file-placeholder (function)
• produce-file-set-placeholder (function)
• produce-footer-file (generic function)
• produce-footer-file (method)
• produce-footer-frame (generic function)
• produce-footer-frame (method)
• produce-frame (generic function)
• produce-frame (method)
• produce-frame (method)
• produce-header-file (generic function)
• produce-header-file (method)
• produce-header-frame (generic function)
• produce-header-frame (method)
• produce-navigation-file (generic function)
• produce-navigation-file (method)
• produce-navigation-file (method)
• produce-navigation-frame (generic function)
• produce-navigation-frame (method)
• produce-navigation-map (function)
• produce-package-navigation-list (function)
• render-lambda-list (generic function)
• render-lambda-list (method)
• render-lambda-list (method)
• render-lambda-list (method)
• render-lambda-list (method)
• render-syntax-section (generic function)
• render-syntax-section (method)
• render-syntax-section (method)
• render-syntax-section (method)

4.1.19 helambdap/impl-dependent/sbcl.lisp

Parent

impl-dependent (module)

Location

impl-dependent/sbcl.lisp

4.1.20 helambdap/impl-dependent/asdf-deps.lisp

Parent

impl-dependent (module)

Location

impl-dependent/asdf-deps.lisp

5 Packages

Packages are listed by definition order.

5.1 it.unimib.disco.ma.cl.helambdap

The HELambdaP Package.

The package containing the implementation of the ’semi-offline’ documentation system for Common Lisp.

Source

helambdap-pkg.lisp (file)

Nicknames

• helambdap
• helambdap

Use List

common-lisp

Exported Definitions

• *everything* (special variable)
• *exclude-directories* (special variable)
• *exclude-files* (special variable)
• *only-documented* (special variable)
• *only-exported* (special variable)
• +doctype-frameset-control-string+ (special variable)
• +doctype-html5-control-string+ (special variable)
• +doctype-xhtml1-string-control-string+ (special variable)
• +frameset-doctype-public-id+ (special variable)
• +frameset-doctype-system-id+ (special variable)
• build-documentation (generic function)
• build-documentation (method)
• build-documentation (method)
• clear-doc-bits-db (function)
• define-documentation-extractor (macro)
• doc-bits-data-base (structure)
• doc-bits-data-base-p (function)
• document (function)
• documentation (generic function)
• documentation (method)
• documentation (method)
• extract-documentation (generic function)
• extract-documentation (method)
• extract-documentation (method)
• extract-documentation (method)
• extract-documentation (method)
• extract-form-documentation (generic function)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-form-documentation (method)
• extract-named-form-documentation (generic function)
• extract-named-form-documentation (method)
• get-doc-bits (function)
• init-doc-bits-db (function)
• insert-doc-bit (function)
• produce-documentation (generic function)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• produce-documentation (method)
• save-doc-bits-db (generic function)
• save-doc-bits-db (method)
• save-doc-bits-db (method)
• save-doc-bits-db (method)

Internal Definitions

• %make-doc-file (function)
• %make-file (function)
• %make-file-set (function)
• %make-frame (function)
• %make-frameset (function)
• %make-framesets (function)
• %make-naming (function)
• %make-style-file (function)
• %make-texinfo-file (function)
• *backlog-length* (special variable)
• *backtraceable-streams* (special variable)
• *current-package* (special variable)
• *default-documentation-structure* (special variable)
• *default-html-extension* (special variable)
• *doc-bits-db* (special variable)
• *doc-bits-db-file* (special variable)
• *doc-structures* (special variable)
• *formatted-section-right-margin* (special variable)
• *helambdap-css-filename* (special variable)
• *helambdap-css-filename-up* (special variable)
• *helambdap-css-pathname* (special variable)
• *helambdap-site* (special variable)
• *info-file-name* (special variable)
• *intro-file-name* (special variable)
• *source-extensions* (special variable)
• *structure-file-name* (special variable)
• *supersede-documentation* (special variable)
• *texinfo-documentation-structure* (special variable)
• *try-to-ensure-packages* (special variable)
• *whitespace-characters* (special variable)
• *xhtml-frame-documentation-structure* (special variable)
• *xhtml-indent* (special variable)
• *xhtml-simple-frame-documentation-structure* (special variable)
• +lambda-list-kwds+ (special variable)
• +months+ (special variable)
• +weekdays+ (special variable)
• arg-name (function)
• article-doc-bit (structure)
• article-doc-bit-components (function)
• (setf article-doc-bit-components) (function)
• article-doc-bit-doc-string (function)
• (setf article-doc-bit-doc-string) (function)
• article-doc-bit-kind (function)
• article-doc-bit-kind-tag (function)
• article-doc-bit-location (function)
• (setf article-doc-bit-location) (function)
• article-doc-bit-name (function)
• article-doc-bit-p (function)
• article-doc-bit-timestamp (function)
• (setf article-doc-bit-timestamp) (function)
• asdf-system-doc-bit (structure)
• asdf-system-doc-bit-depends-on (function)
• asdf-system-doc-bit-doc-string (function)
• (setf asdf-system-doc-bit-doc-string) (function)
• asdf-system-doc-bit-kind (function)
• asdf-system-doc-bit-kind-tag (function)
• asdf-system-doc-bit-location (function)
• (setf asdf-system-doc-bit-location) (function)
• asdf-system-doc-bit-name (function)
• asdf-system-doc-bit-p (function)
• asdf-system-doc-bit-timestamp (function)
• (setf asdf-system-doc-bit-timestamp) (function)
• assimilate-package (function)
• base-name (function)
• book-doc-bit (structure)
• book-doc-bit-divisions (function)
• (setf book-doc-bit-divisions) (function)
• book-doc-bit-doc-string (function)
• (setf book-doc-bit-doc-string) (function)
• book-doc-bit-kind (function)
• book-doc-bit-kind-tag (function)
• book-doc-bit-location (function)
• (setf book-doc-bit-location) (function)
• book-doc-bit-name (function)
• book-doc-bit-navigation (function)
• (setf book-doc-bit-navigation) (function)
• book-doc-bit-p (function)
• book-doc-bit-timestamp (function)
• (setf book-doc-bit-timestamp) (function)
• build-doc-skeleton (generic function)
• bypass-pprint (function)
• chapter-doc-bit (structure)
• chapter-doc-bit-components (function)
• (setf chapter-doc-bit-components) (function)
• chapter-doc-bit-doc-string (function)
• (setf chapter-doc-bit-doc-string) (function)
• chapter-doc-bit-kind (function)
• chapter-doc-bit-kind-tag (function)
• chapter-doc-bit-location (function)
• (setf chapter-doc-bit-location) (function)
• chapter-doc-bit-name (function)
• chapter-doc-bit-p (function)
• chapter-doc-bit-timestamp (function)
• (setf chapter-doc-bit-timestamp) (function)
• class-doc-bit (structure)
• class-doc-bit-doc-string (function)
• (setf class-doc-bit-doc-string) (function)
• class-doc-bit-kind (function)
• class-doc-bit-kind-tag (function)
• class-doc-bit-location (function)
• (setf class-doc-bit-location) (function)
• class-doc-bit-name (function)
• class-doc-bit-p (function)
• class-doc-bit-slots (function)
• class-doc-bit-superclasses (function)
• class-doc-bit-timestamp (function)
• (setf class-doc-bit-timestamp) (function)
• clean-stream-backlog (function)
• collect-declarations (function)
• collect-documentation (generic function)
• collect-documentation (method)
• collect-documentation (method)
• collect-documentation (method)
• compiler-macro-doc-bit (structure)
• compiler-macro-doc-bit-doc-string (function)
• (setf compiler-macro-doc-bit-doc-string) (function)
• compiler-macro-doc-bit-ftype-declarations (function)
• compiler-macro-doc-bit-kind (function)
• compiler-macro-doc-bit-kind-tag (function)
• compiler-macro-doc-bit-lambda-list (function)
• compiler-macro-doc-bit-location (function)
• (setf compiler-macro-doc-bit-location) (function)
• compiler-macro-doc-bit-name (function)
• compiler-macro-doc-bit-p (function)
• compiler-macro-doc-bit-timestamp (function)
• (setf compiler-macro-doc-bit-timestamp) (function)
• compiler-macro-doc-bit-type-declarations (function)
• compute-element-path (generic function)
• compute-element-path (method)
• compute-element-path (method)
• condition-doc-bit (structure)
• condition-doc-bit-doc-string (function)
• (setf condition-doc-bit-doc-string) (function)
• condition-doc-bit-kind (function)
• condition-doc-bit-kind-tag (function)
• condition-doc-bit-location (function)
• (setf condition-doc-bit-location) (function)
• condition-doc-bit-name (function)
• condition-doc-bit-p (function)
• condition-doc-bit-slots (function)
• condition-doc-bit-superclasses (function)
• condition-doc-bit-timestamp (function)
• (setf condition-doc-bit-timestamp) (function)
• constant-doc-bit (structure)
• constant-doc-bit-doc-string (function)
• (setf constant-doc-bit-doc-string) (function)
• constant-doc-bit-initial-value (function)
• constant-doc-bit-kind (function)
• constant-doc-bit-kind-tag (function)
• constant-doc-bit-location (function)
• (setf constant-doc-bit-location) (function)
• constant-doc-bit-name (function)
• constant-doc-bit-p (function)
• constant-doc-bit-timestamp (function)
• (setf constant-doc-bit-timestamp) (function)
• copy-article-doc-bit (function)
• copy-asdf-system-doc-bit (function)
• copy-book-doc-bit (function)
• copy-chapter-doc-bit (function)
• copy-class-doc-bit (function)
• copy-compiler-macro-doc-bit (function)
• copy-condition-doc-bit (function)
• copy-constant-doc-bit (function)
• copy-deftype-doc-bit (function)
• copy-destructuring-lambda-list (function)
• copy-doc-bit (function)
• copy-doc-bits-data-base (function)
• copy-doc-file (function)
• copy-element (function)
• copy-file (function)
• copy-file-set (function)
• copy-frame (function)
• copy-frameset (function)
• copy-framesets (function)
• copy-function-doc-bit (function)
• copy-generic-function-doc-bit (function)
• copy-generic-function-lambda-list (function)
• copy-lambda-list-item (function)
• copy-lambda-list-var (function)
• copy-literal-doc-bit (function)
• copy-macro-doc-bit (function)
• copy-macro-lambda-list (function)
• copy-method-combination-doc-bit (function)
• copy-method-doc-bit (function)
• copy-modify-macro-doc-bit (function)
• copy-naming (function)
• copy-ordinary-lambda-list (function)
• copy-package-doc-bit (function)
• copy-parameter-doc-bit (function)
• copy-parameterized-doc-bit (function)
• copy-part-doc-bit (function)
• copy-set-doc-bit (function)
• copy-setf-expander-doc-bit (function)
• copy-slotted-doc-bit (function)
• copy-specialized-lambda-list (function)
• copy-struct-doc-bit (function)
• copy-style-file (function)
• copy-system-doc-bit (function)
• copy-texinfo-file (function)
• copy-type-doc-bit (function)
• copy-variable-doc-bit (function)
• dbdb (function)
• def-doc-bit (macro)
• deftype-doc-bit (structure)
• deftype-doc-bit-doc-string (function)
• (setf deftype-doc-bit-doc-string) (function)
• deftype-doc-bit-ftype-declarations (function)
• deftype-doc-bit-kind (function)
• deftype-doc-bit-kind-tag (function)
• deftype-doc-bit-lambda-list (function)
• deftype-doc-bit-location (function)
• (setf deftype-doc-bit-location) (function)
• deftype-doc-bit-name (function)
• deftype-doc-bit-p (function)
• deftype-doc-bit-timestamp (function)
• (setf deftype-doc-bit-timestamp) (function)
• deftype-doc-bit-type-declarations (function)
• destructuring-lambda-list (structure)
• destructuring-lambda-list-allow-other-keys (function)
• destructuring-lambda-list-auxiliary-vars (function)
• destructuring-lambda-list-keyword-vars (function)
• destructuring-lambda-list-optional-vars (function)
• destructuring-lambda-list-ordinary-vars (function)
• destructuring-lambda-list-p (function)
• destructuring-lambda-list-rest-var (function)
• directory-last-name (function)
• directory-name (function)
• directory-source-files (function)
• doc-bit (structure)
• doc-bit-doc-string (function)
• (setf doc-bit-doc-string) (function)
• doc-bit-identifier (function)
• doc-bit-kind (function)
• doc-bit-kind-tag (function)
• doc-bit-location (function)
• (setf doc-bit-location) (function)
• doc-bit-name (function)
• doc-bit-p (function)
• doc-bit-package (function)
• doc-bit-pathname-name (function)
• doc-bit-timestamp (function)
• (setf doc-bit-timestamp) (function)
• doc-bits-data-base-dbdb (function)
• doc-file (function)
• doc-file (structure)
• doc-file-doc-structure (function)
• (setf doc-file-doc-structure) (function)
• doc-file-name (function)
• doc-file-p (function)
• doc-file-parent (function)
• (setf doc-file-parent) (function)
• doc-file-pathname-type (function)
• doc-file-source (function)
• (setf doc-file-source) (function)
• doc-file-style (function)
• (setf doc-file-style) (function)
• documentation-structure (class)
• documentation-structure-name (generic function)
• documentation-structure-name (method)
• documentation-structure-root (generic function)
• documentation-structure-root (method)
• documentation-structure-structure (generic function)
• documentation-structure-structure (method)
• dump-doc-bit-html (function)
• element (structure)
• element-doc-structure (function)
• (setf element-doc-structure) (function)
• element-location-depth (function)
• element-location-path (function)
• element-name (function)
• element-p (function)
• element-parent (function)
• (setf element-parent) (function)
• element-source (function)
• (setf element-source) (function)
• element-style (function)
• (setf element-style) (function)
• empty-string-p (function)
• enclosing-directory (function)
• erase-doc-structure (function)
• external-symbol-p (function)
• extract-section-name (function)
• extract-section-names (function)
• extract-sections (generic function)
• extract-sections (method)
• extract-sections (method)
• extract-sections (method)
• extract-symbol-form-documentation (function)
• extricate-doc-string (function)
• file (function)
• file (structure)
• file-doc-structure (function)
• (setf file-doc-structure) (function)
• file-name (function)
• file-p (function)
• file-parent (function)
• (setf file-parent) (function)
• file-pathname (generic function)
• file-pathname (method)
• file-pathname (method)
• file-set (function)
• file-set (structure)
• file-set-doc-structure (function)
• (setf file-set-doc-structure) (function)
• file-set-files (function)
• (setf file-set-files) (function)
• file-set-index (function)
• (setf file-set-index) (function)
• file-set-name (function)
• file-set-p (function)
• file-set-parent (function)
• (setf file-set-parent) (function)
• file-set-source (function)
• (setf file-set-source) (function)
• file-set-style (function)
• (setf file-set-style) (function)
• file-source (function)
• (setf file-source) (function)
• file-style (function)
• (setf file-style) (function)
• fill-doc-bits-db (function)
• find-doc-structure (function)
• first-line-special (function)
• flatten-if (function)
• form-documentation (function)
• frame (function)
• frame (structure)
• frame-doc-structure (function)
• (setf frame-doc-structure) (function)
• frame-name (function)
• frame-p (function)
• frame-parent (function)
• (setf frame-parent) (function)
• frame-source (function)
• (setf frame-source) (function)
• frame-style (function)
• (setf frame-style) (function)
• frameset (function)
• frameset (structure)
• frameset-body-title (generic function)
• frameset-body-title (method)
• frameset-content (function)
• (setf frameset-content) (function)
• frameset-doc-structure (function)
• (setf frameset-doc-structure) (function)
• frameset-footer (function)
• frameset-footer-name (function)
• frameset-head-title (generic function)
• frameset-head-title (method)
• frameset-header (function)
• frameset-header-name (function)
• frameset-location (function)
• frameset-name (function)
• frameset-navigation (function)
• frameset-navigation-name (function)
• frameset-order (function)
• (setf frameset-order) (function)
• frameset-p (function)
• frameset-parent (function)
• (setf frameset-parent) (function)
• frameset-sidebar (function)
• frameset-sidebar-name (function)
• frameset-source (function)
• (setf frameset-source) (function)
• frameset-style (function)
• (setf frameset-style) (function)
• framesets (function)
• framesets (structure)
• framesets-doc-structure (function)
• (setf framesets-doc-structure) (function)
• framesets-list (function)
• (setf framesets-list) (function)
• framesets-name (function)
• framesets-of (generic function)
• framesets-of (method)
• framesets-of (method)
• framesets-of (method)
• framesets-p (function)
• framesets-parent (function)
• (setf framesets-parent) (function)
• framesets-source (function)
• (setf framesets-source) (function)
• framesets-style (function)
• (setf framesets-style) (function)
• function-doc-bit (structure)
• function-doc-bit-doc-string (function)
• (setf function-doc-bit-doc-string) (function)
• function-doc-bit-ftype-declarations (function)
• function-doc-bit-kind (function)
• function-doc-bit-kind-tag (function)
• function-doc-bit-lambda-list (function)
• function-doc-bit-location (function)
• (setf function-doc-bit-location) (function)
• function-doc-bit-name (function)
• function-doc-bit-p (function)
• function-doc-bit-timestamp (function)
• (setf function-doc-bit-timestamp) (function)
• function-doc-bit-type-declarations (function)
• function-doc-bit-values (function)
• generic-function-doc-bit (structure)
• generic-function-doc-bit-doc-string (function)
• (setf generic-function-doc-bit-doc-string) (function)
• generic-function-doc-bit-ftype-declarations (function)
• generic-function-doc-bit-kind (function)
• generic-function-doc-bit-kind-tag (function)
• generic-function-doc-bit-lambda-list (function)
• generic-function-doc-bit-location (function)
• (setf generic-function-doc-bit-location) (function)
• generic-function-doc-bit-methods (function)
• (setf generic-function-doc-bit-methods) (function)
• generic-function-doc-bit-name (function)
• generic-function-doc-bit-p (function)
• generic-function-doc-bit-timestamp (function)
• (setf generic-function-doc-bit-timestamp) (function)
• generic-function-doc-bit-type-declarations (function)
• generic-function-doc-bit-values (function)
• generic-function-lambda-list (structure)
• generic-function-lambda-list-allow-other-keys (function)
• generic-function-lambda-list-auxiliary-vars (function)
• generic-function-lambda-list-keyword-vars (function)
• generic-function-lambda-list-optional-vars (function)
• generic-function-lambda-list-ordinary-vars (function)
• generic-function-lambda-list-p (function)
• generic-function-lambda-list-rest-var (function)
• get-char (function)
• inherited-symbol-p (function)
• initialize-element (generic function)
• initialize-element (method)
• internal-symbol-p (function)
• is-declaration (function)
• lambda-list-item (structure)
• lambda-list-item-p (function)
• lambda-list-type (type)
• lambda-list-var (structure)
• lambda-list-var-p (function)
• lambda-list-var-type (type)
• literal-doc-bit (structure)
• literal-doc-bit-content (function)
• literal-doc-bit-doc-string (function)
• (setf literal-doc-bit-doc-string) (function)
• literal-doc-bit-kind (function)
• literal-doc-bit-kind-tag (function)
• literal-doc-bit-location (function)
• (setf literal-doc-bit-location) (function)
• literal-doc-bit-name (function)
• literal-doc-bit-p (function)
• literal-doc-bit-timestamp (function)
• (setf literal-doc-bit-timestamp) (function)
• ll-allow-other-keys (function)
• ll-auxiliary-vars (function)
• ll-keyword-vars (function)
• ll-optional-vars (function)
• ll-ordinary-vars (function)
• ll-rest-var (function)
• ll-vars (generic function)
• ll-vars (method)
• ll-vars (method)
• ll-vars (method)
• ll-vars (method)
• lli-form (function)
• lli-item (function)
• lli-kind (function)
• lli-name (function)
• llv-form (function)
• llv-item (function)
• llv-kind (function)
• llv-name (function)
• load-doc-bits-db (generic function)
• load-doc-bits-db (method)
• load-doc-bits-db (method)
• look-at-char (function)
• macro-doc-bit (structure)
• macro-doc-bit-doc-string (function)
• (setf macro-doc-bit-doc-string) (function)
• macro-doc-bit-ftype-declarations (function)
• macro-doc-bit-kind (function)
• macro-doc-bit-kind-tag (function)
• macro-doc-bit-lambda-list (function)
• macro-doc-bit-location (function)
• (setf macro-doc-bit-location) (function)
• macro-doc-bit-name (function)
• macro-doc-bit-p (function)
• macro-doc-bit-timestamp (function)
• (setf macro-doc-bit-timestamp) (function)
• macro-doc-bit-type-declarations (function)
• macro-lambda-list (structure)
• macro-lambda-list-allow-other-keys (function)
• macro-lambda-list-auxiliary-vars (function)
• macro-lambda-list-body-var (function)
• macro-lambda-list-env-var (function)
• macro-lambda-list-keyword-vars (function)
• macro-lambda-list-optional-vars (function)
• macro-lambda-list-ordinary-vars (function)
• macro-lambda-list-p (function)
• macro-lambda-list-rest-var (function)
• macro-lambda-list-whole-var (function)
• make-article-doc-bit (function)
• make-asdf-system-doc-bit (function)
• make-book-doc-bit (function)
• make-chapter-doc-bit (function)
• make-class-doc-bit (function)
• make-compiler-macro-doc-bit (function)
• make-condition-doc-bit (function)
• make-constant-doc-bit (function)
• make-deftype-doc-bit (function)
• make-destructuring-lambda-list (function)
• make-doc-bit (function)
• make-doc-bit-pathname (function)
• make-doc-bits-data-base (function)
• make-documentation-structure (function)
• make-element (function)
• make-function-doc-bit (function)
• make-generic-function-doc-bit (function)
• make-generic-function-lambda-list (function)
• make-literal-doc-bit (function)
• make-macro-doc-bit (function)
• make-macro-lambda-list (function)
• make-method-combination-doc-bit (function)
• make-method-doc-bit (function)
• make-modify-macro-doc-bit (function)
• make-naming (function)
• make-naming* (function)
• make-ordinary-lambda-list (function)
• make-package-doc-bit (function)
• make-parameter-doc-bit (function)
• make-part-doc-bit (function)
• make-set-doc-bit (function)
• make-setf-expander-doc-bit (function)
• make-specialized-lambda-list (function)
• make-struct-doc-bit (function)
• make-type-doc-bit (function)
• make-variable-doc-bit (function)
• method-combination-doc-bit (structure)
• method-combination-doc-bit-doc-string (function)
• (setf method-combination-doc-bit-doc-string) (function)
• method-combination-doc-bit-kind (function)
• method-combination-doc-bit-kind-tag (function)
• method-combination-doc-bit-location (function)
• (setf method-combination-doc-bit-location) (function)
• method-combination-doc-bit-name (function)
• method-combination-doc-bit-p (function)
• method-combination-doc-bit-timestamp (function)
• (setf method-combination-doc-bit-timestamp) (function)
• method-doc-bit (structure)
• method-doc-bit-doc-string (function)
• (setf method-doc-bit-doc-string) (function)
• method-doc-bit-ftype-declarations (function)
• method-doc-bit-kind (function)
• method-doc-bit-kind-tag (function)
• method-doc-bit-lambda-list (function)
• method-doc-bit-location (function)
• (setf method-doc-bit-location) (function)
• method-doc-bit-name (function)
• method-doc-bit-p (function)
• method-doc-bit-qualifiers (function)
• method-doc-bit-timestamp (function)
• (setf method-doc-bit-timestamp) (function)
• method-doc-bit-type-declarations (function)
• method-doc-bit-values (function)
• mkllitem (function)
• mkllvar (function)
• modify-macro-doc-bit (structure)
• modify-macro-doc-bit-doc-string (function)
• (setf modify-macro-doc-bit-doc-string) (function)
• modify-macro-doc-bit-ftype-declarations (function)
• modify-macro-doc-bit-kind (function)
• modify-macro-doc-bit-kind-tag (function)
• modify-macro-doc-bit-lambda-list (function)
• modify-macro-doc-bit-location (function)
• (setf modify-macro-doc-bit-location) (function)
• modify-macro-doc-bit-name (function)
• modify-macro-doc-bit-p (function)
• modify-macro-doc-bit-timestamp (function)
• (setf modify-macro-doc-bit-timestamp) (function)
• modify-macro-doc-bit-type-declarations (function)
• naming (structure)
• naming-id (function)
• naming-kind (function)
• naming-nesting-path (function)
• naming-p (function)
• new-doc-bit (generic function)
• newline (function)
• newlines (function)
• non-empty-string-p (function)
• ordinary-lambda-list (structure)
• ordinary-lambda-list-allow-other-keys (function)
• ordinary-lambda-list-auxiliary-vars (function)
• ordinary-lambda-list-keyword-vars (function)
• ordinary-lambda-list-optional-vars (function)
• ordinary-lambda-list-ordinary-vars (function)
• ordinary-lambda-list-p (function)
• ordinary-lambda-list-rest-var (function)
• package-doc-bit (structure)
• package-doc-bit-doc-string (function)
• (setf package-doc-bit-doc-string) (function)
• package-doc-bit-kind (function)
• package-doc-bit-kind-tag (function)
• package-doc-bit-location (function)
• (setf package-doc-bit-location) (function)
• package-doc-bit-name (function)
• package-doc-bit-nicknames (function)
• package-doc-bit-p (function)
• package-doc-bit-timestamp (function)
• (setf package-doc-bit-timestamp) (function)
• package-doc-bit-use-list (function)
• paragraphize-doc-string (function)
• parameter-doc-bit (structure)
• parameter-doc-bit-doc-string (function)
• (setf parameter-doc-bit-doc-string) (function)
• parameter-doc-bit-initial-value (function)
• parameter-doc-bit-kind (function)
• parameter-doc-bit-kind-tag (function)
• parameter-doc-bit-location (function)
• (setf parameter-doc-bit-location) (function)
• parameter-doc-bit-name (function)
• parameter-doc-bit-p (function)
• parameter-doc-bit-timestamp (function)
• (setf parameter-doc-bit-timestamp) (function)
• parameterized-doc-bit (structure)
• parameterized-doc-bit-doc-string (function)
• (setf parameterized-doc-bit-doc-string) (function)
• parameterized-doc-bit-ftype-declarations (function)
• parameterized-doc-bit-kind (function)
• parameterized-doc-bit-kind-tag (function)
• parameterized-doc-bit-lambda-list (function)
• parameterized-doc-bit-location (function)
• (setf parameterized-doc-bit-location) (function)
• parameterized-doc-bit-name (function)
• parameterized-doc-bit-p (function)
• parameterized-doc-bit-timestamp (function)
• (setf parameterized-doc-bit-timestamp) (function)
• parameterized-doc-bit-type-declarations (function)
• parse-doc-hyperspec-style (function)
• parse-ll (generic function)
• parse-ll (method)
• parse-ll (method)
• parse-ll (method)
• parse-ll (method)
• parse-ll (method)
• part-doc-bit (structure)
• part-doc-bit-components (function)
• (setf part-doc-bit-components) (function)
• part-doc-bit-doc-string (function)
• (setf part-doc-bit-doc-string) (function)
• part-doc-bit-kind (function)
• part-doc-bit-kind-tag (function)
• part-doc-bit-location (function)
• (setf part-doc-bit-location) (function)
• part-doc-bit-name (function)
• part-doc-bit-p (function)
• part-doc-bit-timestamp (function)
• (setf part-doc-bit-timestamp) (function)
• pll (function)
• pprint-documentation-structure (function)
• pprint-element (generic function)
• pprint-element (method)
• pprint-element (method)
• pprint-element (method)
• process-arg-n-value-pars (function)
• process-doc-string (generic function)
• process-doc-string (method)
• process-doc-string (method)
• process-returns-declaration (function)
• produce-doc-bit-title-name (function)
• produce-doc-file-placeholder (function)
• produce-file-set-placeholder (function)
• produce-footer-file (generic function)
• produce-footer-file (method)
• produce-footer-frame (generic function)
• produce-footer-frame (method)
• produce-frame (generic function)
• produce-frame (method)
• produce-frame (method)
• produce-header-file (generic function)
• produce-header-file (method)
• produce-header-frame (generic function)
• produce-header-frame (method)
• produce-navigation-file (generic function)
• produce-navigation-file (method)
• produce-navigation-file (method)
• produce-navigation-frame (generic function)
• produce-navigation-frame (method)
• produce-navigation-map (function)
• produce-package-navigation-list (function)
• property (function)
• (setf property) (function)
• property-table (generic function)
• property-table (method)
• quote-wild-in-pathname-name (function)
• read-form (function)
• read-structure-file (function)
• register-doc-structure (function)
• register-element (generic function)
• register-element (method)
• register-element (method)
• register-element (method)
• render-lambda-list (generic function)
• render-lambda-list (method)
• render-lambda-list (method)
• render-lambda-list (method)
• render-lambda-list (method)
• render-syntax-section (generic function)
• render-syntax-section (method)
• render-syntax-section (method)
• render-syntax-section (method)
• sanitize-quotes-for-html (function)
• sanitize-string-for-html (function)
• set-doc-bit (structure)
• set-doc-bit-doc-string (function)
• (setf set-doc-bit-doc-string) (function)
• set-doc-bit-kind (function)
• set-doc-bit-kind-tag (function)
• set-doc-bit-location (function)
• (setf set-doc-bit-location) (function)
• set-doc-bit-name (function)
• set-doc-bit-p (function)
• set-doc-bit-timestamp (function)
• (setf set-doc-bit-timestamp) (function)
• set-property (function)
• setf-expander-doc-bit (structure)
• setf-expander-doc-bit-doc-string (function)
• (setf setf-expander-doc-bit-doc-string) (function)
• setf-expander-doc-bit-ftype-declarations (function)
• setf-expander-doc-bit-kind (function)
• setf-expander-doc-bit-kind-tag (function)
• setf-expander-doc-bit-lambda-list (function)
• setf-expander-doc-bit-location (function)
• (setf setf-expander-doc-bit-location) (function)
• setf-expander-doc-bit-name (function)
• setf-expander-doc-bit-p (function)
• setf-expander-doc-bit-timestamp (function)
• (setf setf-expander-doc-bit-timestamp) (function)
• setf-expander-doc-bit-type-declarations (function)
• sift-standard-doc-bits (function)
• slotted-doc-bit (structure)
• slotted-doc-bit-doc-string (function)
• (setf slotted-doc-bit-doc-string) (function)
• slotted-doc-bit-kind (function)
• slotted-doc-bit-kind-tag (function)
• slotted-doc-bit-location (function)
• (setf slotted-doc-bit-location) (function)
• slotted-doc-bit-name (function)
• slotted-doc-bit-p (function)
• slotted-doc-bit-slots (function)
• slotted-doc-bit-timestamp (function)
• (setf slotted-doc-bit-timestamp) (function)
• specialized-lambda-list (structure)
• specialized-lambda-list-allow-other-keys (function)
• specialized-lambda-list-auxiliary-vars (function)
• specialized-lambda-list-keyword-vars (function)
• specialized-lambda-list-optional-vars (function)
• specialized-lambda-list-ordinary-vars (function)
• specialized-lambda-list-p (function)
• specialized-lambda-list-rest-var (function)
• split-all-lines (function)
• split-at-tex-paragraphs (function)
• split-lines-for-html (function)
• stream-backlog (function)
• (setf stream-backlog) (function)
• struct-doc-bit (structure)
• struct-doc-bit-doc-string (function)
• (setf struct-doc-bit-doc-string) (function)
• struct-doc-bit-include (function)
• struct-doc-bit-kind (function)
• struct-doc-bit-kind-tag (function)
• struct-doc-bit-location (function)
• (setf struct-doc-bit-location) (function)
• struct-doc-bit-name (function)
• struct-doc-bit-p (function)
• struct-doc-bit-slots (function)
• struct-doc-bit-timestamp (function)
• (setf struct-doc-bit-timestamp) (function)
• structure-table (generic function)
• structure-table (method)
• style-file (function)
• style-file (structure)
• style-file-doc-structure (function)
• (setf style-file-doc-structure) (function)
• style-file-name (function)
• style-file-p (function)
• style-file-parent (function)
• (setf style-file-parent) (function)
• style-file-source (function)
• (setf style-file-source) (function)
• style-file-style (function)
• (setf style-file-style) (function)
• subdirectories (function)
• symbol-status-in-package (function)
• system-doc-bit (structure)
• system-doc-bit-depends-on (function)
• system-doc-bit-doc-string (function)
• (setf system-doc-bit-doc-string) (function)
• system-doc-bit-kind (function)
• system-doc-bit-kind-tag (function)
• system-doc-bit-location (function)
• (setf system-doc-bit-location) (function)
• system-doc-bit-name (function)
• system-doc-bit-p (function)
• system-doc-bit-timestamp (function)
• (setf system-doc-bit-timestamp) (function)
• t_lambda-list (structure)
• t_lambda-list-p (function)
• texinfo-file (function)
• texinfo-file (structure)
• texinfo-file-contents (function)
• (setf texinfo-file-contents) (function)
• texinfo-file-doc-structure (function)
• (setf texinfo-file-doc-structure) (function)
• texinfo-file-location (function)
• (setf texinfo-file-location) (function)
• texinfo-file-name (function)
• texinfo-file-p (function)
• texinfo-file-parent (function)
• (setf texinfo-file-parent) (function)
• texinfo-file-source (function)
• (setf texinfo-file-source) (function)
• texinfo-file-style (function)
• (setf texinfo-file-style) (function)
• text-timestamp (function)
• type-doc-bit (structure)
• type-doc-bit-doc-string (function)
• (setf type-doc-bit-doc-string) (function)
• type-doc-bit-kind (function)
• type-doc-bit-kind-tag (function)
• type-doc-bit-location (function)
• (setf type-doc-bit-location) (function)
• type-doc-bit-name (function)
• type-doc-bit-p (function)
• type-doc-bit-timestamp (function)
• (setf type-doc-bit-timestamp) (function)
• unget-char (function)
• unget-chars (function)
• uninterned-symbol-p (function)
• variable-doc-bit (structure)
• variable-doc-bit-doc-string (function)
• (setf variable-doc-bit-doc-string) (function)
• variable-doc-bit-initial-value (function)
• variable-doc-bit-kind (function)
• variable-doc-bit-kind-tag (function)
• variable-doc-bit-location (function)
• (setf variable-doc-bit-location) (function)
• variable-doc-bit-name (function)
• variable-doc-bit-p (function)
• variable-doc-bit-timestamp (function)
• (setf variable-doc-bit-timestamp) (function)
• with-backlogged-stream (macro)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *everything*

Controls whether the system must produce documentation for everything.

When *EVERYTHING* is true, HELAMBDAP produces documentation for every bit in the ’search’ path requested regardless of the values of *ONLY-DOCUMENTED* and *ONLY-EXPORTED*.

See Also:

*ONLY-DOCUMENTED* and *ONLY-EXPORTED*.

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap-globals.lisp (file)

Special Variable: *exclude-directories*

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap-globals.lisp (file)

Special Variable: *exclude-files*

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap-globals.lisp (file)

Special Variable: *only-documented*

Controls whether the system must produce documentation only for user-documented items.

When *ONLY-DOCUMENTED* is true, then the system produces documentation only for those items the user has actually written a documentation string.

See Also:

*EVERYTHING* and *ONLY-EXPORTED*.

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap-globals.lisp (file)

Special Variable: *only-exported*

Controls whether the system must produce documentation only for ’exported’ items (i.e., symbols).

When *ONLY-EXPORTED* is true, then the system produces documentation only for those items (symbols) that are exported from their package.

See Also:

*EVERYTHING* and *ONLY-DOCUMENTED*.

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap-globals.lisp (file)

Special Variable: +doctype-frameset-control-string+

The standard ’DOCTYPE’ w3c Frameset DTD (X)HTML string.

Package

it.unimib.disco.ma.cl.helambdap

Source

xhtml-common-definitions.lisp (file)

Special Variable: +doctype-html5-control-string+

The standard HTML5 doctype declaration.

Package

it.unimib.disco.ma.cl.helambdap

Source

xhtml-common-definitions.lisp (file)

Special Variable: +doctype-xhtml1-string-control-string+

The standard ’DOCTYPE’ w3c DTD XHTML Strict DTD (X)HTML string.

Package

it.unimib.disco.ma.cl.helambdap

Source

xhtml-common-definitions.lisp (file)

Special Variable: +frameset-doctype-public-id+

Package

it.unimib.disco.ma.cl.helambdap

Source

xhtml-common-definitions.lisp (file)

Special Variable: +frameset-doctype-system-id+

Package

it.unimib.disco.ma.cl.helambdap

Source

xhtml-common-definitions.lisp (file)

6.1.2 Macros

Macro: define-documentation-extractor SPEC &body FORMS

Defines a specialized procedure to extract a doc string from a definition.

Package

it.unimib.disco.ma.cl.helambdap

Source

extract-doc.lisp (file)

6.1.3 Functions

Function: clear-doc-bits-db &optional DBDB

Clears the doc-bits data base.

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap.lisp (file)

Function: doc-bits-data-base-p OBJECT

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap.lisp (file)

Function: document FOR-WHAT &key DOCUMENTATION-TITLE FORMAT LAYOUT SOURCE DESTINATION (SUPERSEDE *SUPERSEDE-DOCUMENTATION*) (ONLY-DOCUMENTED *ONLY-DOCUMENTED*) (ONLY-EXPORTED *ONLY-EXPORTED*) (EVERYTHING *EVERYTHING*) (EXCLUDE-DIRECTORIES *EXCLUDE-DIRECTORIES*) (EXCLUDE-FILES *EXCLUDE-FILES*) SPECIAL-METHODS-DEFS-FILES CLEAR-DOCUMENTATION-DB &allow-other-keys

Produces the documentation for something.

The function is a wrapper for BUILD-DOCUMENTATION defaulting a few
parameters, in particular the output FORMAT (which defaults to HTML).

Arguments and Values:

FOR-WHAT — what to document; can be a pathname or a ’system’.
DOCUMENTATION-TITLE — a STRING which will appear as the documentation title.
FORMAT — a SYMBOL designating the desired kind of output.
DESTINATION — a (directory) PATHANME where the documentation will be produced. ONLY-DOCUMENTED — a BOOLEAN: whether to produce documentation only for documented items. ONLY-EXPORTED — a BOOLEAN: whether to produce documentation only for ’exported’ items. EVERYTHING — a BOOLEAN: whether to produce documentation for everything, no matter what. EXCLUDE-DIRECTORIES — a LIST of directory pathnames not to be considered.
EXCLUDE-FILES — a list of FILES not to be considered.
SPECIAL-METHODS-DEFS-FILES — a list of FILES to be LOADed before running the parsers. CLEAR-DOCUMENTATION-DB — a KEYWORD stating if and when the documentation db should be cleared.

Notes:

At the time of this writing, ASDF and MK-DEFSYSTEM are supported.

The arguments SOURCE and SUPERSEDE are, at the time of this writing,
effectively ignored.

The argument SPECIAL-METHODS-DEFS-FILES is a list of Common Lisp files
that will be loaded before running the documentation parsers; it is
assumed that these files will contain mostly
DEFINE-DOCUMENTATION-EXTRACTOR and EXTRACT-NAMED-FORM-DOCUMENTATION
definitions. The loading of these files is wrapped in an
IGNORE-ERRORS form: failure to load one of them will not completely
hamper the documentation procedure.

Package

it.unimib.disco.ma.cl.helambdap

Source

documentation-production.lisp (file)

Function: get-doc-bits NAME &optional DBDB

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap.lisp (file)

Function: init-doc-bits-db ()

Initializes the doc-bits data base.

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap.lisp (file)

Function: insert-doc-bit DOC-BIT &optional DBDB

Inserts a doc-bit in the doc-bits data base.

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap.lisp (file)

6.1.4 Generic functions

Generic Function: build-documentation FOR-WHAT FORMAT &key LAYOUT SOURCE DESTINATION DOCUMENTATION-TITLE &allow-other-keys

Produces the documentation according to a number of parameters

Package

it.unimib.disco.ma.cl.helambdap

Source

documentation-production.lisp (file)

Methods

Method: build-documentation (S system) (FORMAT (eql html)) &key DOCUMENTATION-TITLE LAYOUT SOURCE DESTINATION &allow-other-keys

Builds the documentation for a ASDF system.

Method: build-documentation (P pathname) (FORMAT (eql html)) &key DOCUMENTATION-TITLE LAYOUT SOURCE DESTINATION &allow-other-keys

Builds the documentation given a PATHNAME.

The pathname P can either denote a file or a folder. If i is a folder then it is recursively traversed.

See Also:

collect-documentation.

Generic Function: documentation NAME KIND &key DOC-BITS-DB DB-STORE RELOAD

The DOCUMENTATION Generic Function.

The DOCUMENTATION generic function shadows CL:DOCUMENTATION in order to provide a few hooks for manipulating the underlying DOC-BITS DB.

If no documentation string is found in the doc bits db, then DOCUMENTATION falls back on CL:DOCUMENTATION.

Package

it.unimib.disco.ma.cl.helambdap

Source

helambdap.lisp (file)

Methods

Method: documentation X (DOC-TYPE symbol) &key (DOC-BITS-DB DBDB) DB-STORE RELOAD before

Method: documentation X (DOC-TYPE symbol) &key (DOC-BITS-DB DBDB) DB-STORE RELOAD

Generic Function: extract-documentation WHERE-FROM

Extracts the documentation from a source WHERE-FROM.

Package

it.unimib.disco.ma.cl.helambdap

Source

extract-doc.lisp (file)

Methods

Method: extract-documentation (FORMS-STREAM stream) around

Method: extract-documentation (FILENAME string)

Method: extract-documentation (FILE pathname)

Method: extract-documentation (FORMS-STREAM stream)

Generic Function: extract-form-documentation FORM-KIND FORM

Extracts the documentation from a form tagged with a specific kind.

Package

it.unimib.disco.ma.cl.helambdap

Source

extract-doc.lisp (file)

Methods

Method: extract-form-documentation (FK symbol) FORM around

Method: extract-form-documentation (_%FK%_ (eql defsystem)) (_%FORM%_ cons)

Method: extract-form-documentation (_%FK%_ (eql define-method-combination)) (_%FORM%_ cons)

Method: extract-form-documentation (_%FK%_ (eql define-modify-macro)) (_%FORM%_ cons)

Method: extract-form-documentation (_%FK%_ (eql defsetf)) (_%FORM%_ cons)

Method: extract-form-documentation (_%FK%_ (eql let*)) (_%FORM%_ cons)

Method: extract-form-documentation (_%FK%_ (eql let)) (_%FORM%_ cons)

Method: extract-form-documentation (_%FK%_ (eql proclaim)) (_%FORM%_ cons)

Method: extract-form-documentation (_%FK%_ (eql declaim)) (_%FORM%_ cons)

Method: extract-form-documentation (FK (eql defconstant)) (FORM cons)

Method: extract-form-documentation (FK (eql defvar)) (FORM cons)

Method: extract-form-documentation (FK (eql defparameter)) (FORM cons)

Method: extract-form-documentation (FK (eql progn)) (FORM cons)

Method: extract-form-documentation (FK (eql eval-when)) (FORM cons)

Method: extract-form-documentation (FK (eql defstruct)) (FORM cons)

Method: extract-form-documentation (FK (eql defmethod)) (FORM cons)

Method: extract-form-documentation (FK (eql in-package)) (FORM cons) after

Method: extract-form-documentation (FK (eql in-package)) (FORM cons)

Method: extract-form-documentation (FK (eql in-package)) (FORM cons) before

Method: extract-form-documentation (FK (eql defpackage)) (FORM cons) before

This :before method takes care of ensuring that the defpackage is actually evaluated while avoing problems with package synonyms. This method may signal a continuable error, that a user may decide s/he has to handle in a particular way; the continuable error is generated when there exist a package named by one of the defpackage form nicknames.

Method: extract-form-documentation (FK (eql defpackage)) (FORM cons)

Method: extract-form-documentation (FK (eql defgeneric)) (FORM cons)

Method: extract-form-documentation (FK (eql define-condition)) (FORM cons)

Method: extract-form-documentation (FK (eql defclass)) (FORM cons)

Method: extract-form-documentation (FK (eql define-setf-expander)) (FORM cons)

Method: extract-form-documentation (FK (eql define-compiler-macro)) (FORM cons)

Method: extract-form-documentation (FK (eql defmacro)) (FORM cons)

Method: extract-form-documentation (FK (eql defun)) (FORM cons)

Method: extract-form-documentation (FK (eql deftype)) (FORM cons)

Method: extract-form-documentation (FK symbol) (FORM cons)

Generic Function: extract-named-form-documentation FORM-KIND NAME FORM

Extracts the documentation from a ’named’ form.

A ’named’ form has the following structure: (<name> . <forms>). This generic function is useful to add functionality in the presence of symbols for which the package may not be present at runtime.

This function is called by the more general EXTRACT-FORM-DOCUMENTATION method on (FORM-KIND SYMBOL). The call has the form:

(extract-named-form-documentation s (intern s "HELAMBDAP") form)

In this way it is possible to write special methods to handle "unpackaged" symbols.

Package

it.unimib.disco.ma.cl.helambdap

Source

extract-doc.lisp (file)

Methods

Method: extract-named-form-documentation (FORM-KIND symbol) NAME FORM

Generic Function: produce-documentation FORMAT ELEMENT OUT DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Produces documentation for ELEMENT according to FORMAT.

Package

it.unimib.disco.ma.cl.helambdap

Source

documentation-production.lisp (file)

Methods

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT generic-function-doc-bit) (OUT file-stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

This specialized method produces the documentation for a generic function.

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) STRUCTURE (OUT stream) DOC-BIT &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT class-doc-bit) (OUT file-stream) DOC-BITS &key &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT struct-doc-bit) (OUT file-stream) DOC-BITS &key &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT constant-doc-bit) (OUT file-stream) DOC-BITS &key &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT macro-doc-bit) (OUT file-stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT function-doc-bit) (OUT file-stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT parameterized-doc-bit) (OUT file-stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT system-doc-bit) (OUT file-stream) DOC-BITS &key &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT package-doc-bit) (OUT file-stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

This specialized method produces the documentation for a package.

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (DOC-BIT doc-bit) (OUT file-stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (STRUCTURE file-set) (WHERE file-stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (STRUCTURE file-set) (WHERE pathname) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (ELEMENT frame) (WHERE stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (STRUCTURE frameset) (WHERE pathname) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (FSS framesets) (WHERE pathname) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (STRUCTURE doc-file) (WHERE file-stream) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (STRUCTURE doc-file) (WHERE pathname) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (STRUCTURE style-file) (WHERE pathname) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)

Method: produce-documentation (FORMAT (eql html)) (STRUCTURE documentation-structure) (WHERE pathname) DOC-BITS &key DOCUMENTATION-TITLE &allow-other-keys

Source

xhtml-lambda-producer.lisp (file)