The docparser Reference Manual

This is the docparser Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:18:33 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 docparser

Parse documentation from Common Lisp systems.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page
Source Control

(GIT )

Bug Tracker
License

MIT

Long Description

# docparser

[![Build Status](https://travis-ci.org/eudoxia0/docparser.svg?branch=master)](https://travis-ci.org/eudoxia0/docparser)
[![Coverage Status](https://coveralls.io/repos/eudoxia0/docparser/badge.svg?branch=master)](https://coveralls.io/r/eudoxia0/docparser?branch=master) [![Quicklisp badge](http://quickdocs.org/badge/docparser.svg)](http://quickdocs.org/docparser/)

Extract documentation from Common Lisp systems. Used in the [Codex][codex]
documentation generator and [Quickdocs][qd].

# Overview

Documentation generators generally implement their own (ad hoc,
informally-specified, etc.) version of docstring extraction, and as a result,
every documentation generator extracts a different subset of documentation.

docparser isn’t yet another documentation generator: it is a library for
extracting documentation from Common Lisp systems in a structured manner so you
can build a documentation generator on top of it. It parses systems and returns
a set of objects representing packages, variables, functions, classes, etc. and
their docstrings. It is designed to extract as much information from systems as
possible, and let documentation generators choose what to keep and discard. This
minimizes duplication of effort and separates docstring extraction from
generation.

docparser has classes to represent every documentable Common Lisp construct:

* Functions
* Macros
* Generic functions
* Methods
* Special variables and constants
* Classes and class slots
* Structures
* Conditions
* Type definitions
* Packages

Additionally, docparser has custom subclasses to represent the documentation of
[CFFI][cffi] definitions:

* Foreign functions ([‘defcfun‘][defcfun]).
* Foreign type definitions ([‘defctype‘][defctype]).
* Foreign structure definition ([‘defcstruct‘][defcstruct]).
* Foreign union definitions ([‘defcunion‘][defcunion]).
* Enumerations ([‘defcenum‘][defcenum]).
* Bitfields ([‘defbitfield‘][defbitfield]).

This improves API documentation generation for foreign library wrappers. Note
that, when parsing documentation, docparser catches and ignores foreign library
loading errors, so documentation can be generated even in a machine that can’t
properly load the library. This is useful for documenting libraries with complex
external dependencies.

[codex]: https://github.com/CommonDoc/codex
[qd]: http://quickdocs.org/
[cffi]: https://github.com/cffi/cffi
[defcfun]: https://common-lisp.net/project/cffi/manual/cffi-manual.html#defcfun
[defctype]: https://common-lisp.net/project/cffi/manual/cffi-manual.html#defctype
[defcstruct]: https://common-lisp.net/project/cffi/manual/cffi-manual.html#defcstruct
[defcunion]: https://common-lisp.net/project/cffi/manual/cffi-manual.html#defcunion
[defcenum]: https://common-lisp.net/project/cffi/manual/cffi-manual.html#defcenum
[defbitfield]: https://common-lisp.net/project/cffi/manual/cffi-manual.html#defbitfield

# Usage

To extract documentation from a system (which will be Quickloaded
automatically), do this:

“‘lisp
(docparser:parse :my-system-name)
“‘

This returns an index, which is basically a store of documentation nodes. For a
quick overview of what’s in it, use the ‘dump‘ function:

“‘lisp
CL-USER> (docparser:dump (docparser:parse :cl-yaml))
; some compilation output
Package "YAML.ERROR" with docstring "YAML errors."
#<condition yaml-error>
#<condition parsing-error>
#<condition unsupported-float-value>
Package "YAML.FLOAT" with docstring "Handle IEEE floating point values."
#<variable *float-strategy*>
#<variable *sbcl-nan-value*>
#<function not-a-number NIL>
#<function positive-infinity NIL>
#<function negative-infinity NIL>
Package "YAML.SCALAR" with docstring "Parser for scalar values."
...
“‘

To search for nodes by name or type, you use the ‘query‘ function:

“‘lisp
CL-USER> (defparameter *index* (docparser:parse :cl-yaml))
; some compilation output
*INDEX*

CL-USER> (docparser:query *index* :package-name "CL-YAML")
#(#<generic function parse (INPUT &KEY MULTI-DOCUMENT-P)>
#<method parse ((INPUT STRING) &KEY MULTI-DOCUMENT-P)>
#<method parse ((INPUT PATHNAME) &KEY MULTI-DOCUMENT-P)>
#<function emit (VALUE STREAM)> #<function emit-to-string (VALUE)>)

CL-USER> (docparser:query *index* :package-name "CL-YAML"
:symbol-name "PARSE")
#(#<generic function parse (INPUT &KEY MULTI-DOCUMENT-P)>
#<method parse ((INPUT STRING) &KEY MULTI-DOCUMENT-P)>
#<method parse ((INPUT PATHNAME) &KEY MULTI-DOCUMENT-P)>)

CL-USER> (docparser:query *index* :package-name "CL-YAML"
:symbol-name "PARSE"
:class ’docparser:generic-function-node)
#(#<generic function parse (INPUT &KEY MULTI-DOCUMENT-P)>)
“‘

If you don’t know what the index contains, you can go through it using the
‘do-packages‘ and ‘do-nodes‘ macros:

“‘lisp
CL-USER> (docparser:do-packages (package *index*)
(format t "~&In package: ~A." (docparser:package-index-name package))
(docparser:do-nodes (node package)
(print (class-of node))))
In package: YAML.ERROR.
#<STANDARD-CLASS DOCPARSER:CONDITION-NODE>
#<STANDARD-CLASS DOCPARSER:CONDITION-NODE>
#<STANDARD-CLASS DOCPARSER:CONDITION-NODE>
In package: YAML.FLOAT.
#<STANDARD-CLASS DOCPARSER:VARIABLE-NODE>
#<STANDARD-CLASS DOCPARSER:VARIABLE-NODE>
#<STANDARD-CLASS DOCPARSER:FUNCTION-NODE>
#<STANDARD-CLASS DOCPARSER:FUNCTION-NODE>
#<STANDARD-CLASS DOCPARSER:FUNCTION-NODE>
...
“‘

## Extending

You can extend docparser in two ways: Adding new parsers and new classes. Adding
new classes probably won’t be very useful unless you also modify the client of
your extension to use them. Adding new parsers that instantiate existing
documentation classes, however, can be very useful.

For instance, you could have a parser that extracts information from a custom
‘defwidget‘ macro in a GUI framework, and creates an instance of ‘class-node‘
with a modified docstring.

Alternatively, if you’re writing a documentation generator specific to this
framework, you could create a subclass of ‘class-node‘, ‘widget-node‘, with
extra slots for the added information.

To define a new parser, use the ‘define-parser‘ macro. As an example of use,
this is the definition of the parser for ‘defmacro‘ forms:

“‘lisp
(define-parser cl:defmacro (name (&rest args) &rest body)
(let ((docstring (if (stringp (first body))
(first body)
nil)))
(make-instance ’macro-node
:name name
:docstring docstring
:lambda-list args)))
“‘

# License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies
  • trivial-types (system).
  • alexandria (system).
  • anaphora (system).
  • cffi (system).
Source

docparser.asd.

Child Component

src (module).


3 Modules

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


3.1 docparser/src

Source

docparser.asd.

Parent Component

docparser (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 docparser/docparser.asd

Source

docparser.asd.

Parent Component

docparser (system).

ASDF Systems

docparser.


4.1.2 docparser/src/package.lisp

Source

docparser.asd.

Parent Component

src (module).

Packages

docparser.


4.1.3 docparser/src/nodes.lisp

Dependency

package.lisp (file).

Source

docparser.asd.

Parent Component

src (module).

Public Interface

4.1.4 docparser/src/equal.lisp

Dependency

nodes.lisp (file).

Source

docparser.asd.

Parent Component

src (module).

Public Interface

node= (generic function).

Internals

4.1.5 docparser/src/core.lisp

Dependency

equal.lisp (file).

Source

docparser.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.6 docparser/src/parsers.lisp

Dependency

core.lisp (file).

Source

docparser.asd.

Parent Component

src (module).

Public Interface

extract-docstring (function).

Internals

4.1.7 docparser/src/print.lisp

Dependency

parsers.lisp (file).

Source

docparser.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


5.1 docparser

Parse documentation from ASDF systems.

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *store-form*

Whether or not to store, inside a node, the form it was parsed from.

Package

docparser.

Source

core.lisp.


6.1.2 Macros

Macro: define-parser (name (&rest lambda-list) &body body)

Define a parser.

Package

docparser.

Source

core.lisp.

Macro: do-nodes ((node package-index) &body body)

Iterate over every node in a package index.

Package

docparser.

Source

core.lisp.

Macro: do-packages ((package index) &body body)

Iterate over every package in the index.

Package

docparser.

Source

core.lisp.


6.1.3 Ordinary functions

Function: dump (index)

Print a tree of the contents of an index to the *standard-output*.

Package

docparser.

Source

print.lisp.

Function: extract-docstring (body)

Extract the docstring from the body of a form.
Correctly handles bodies where the first form is a declaration.

Package

docparser.

Source

parsers.lisp.

Function: parse (system-or-list)

Parse documentation from either a system name or a list of system names.

Package

docparser.

Source

core.lisp.

Function: query (index &key package-name symbol-name class)

Find all documentation nodes in the index matching the constraints and returns them as a vector. package-name and symbol-name are strings, class is the symbol of a class name. If none are found, return NIL.

Package

docparser.

Source

core.lisp.

Function: render-humanize (symbol)

Render a symbol into a string in a human-friendly way.

Package

docparser.

Source

nodes.lisp.

Function: slot-initform (class-or-struct-slot-node)

Return the initform for the slot.
Also returns a second boolean value indicating whether the slot has an initform, so an initform of NIL can be distinguished from not having an initform at all.

Package

docparser.

Source

nodes.lisp.

Function: symbol-external-p (symbol)

Whether or not a symbol is external.

Package

docparser.

Source

nodes.lisp.

Function: symbol-package-name (symbol)

Return the name of a package’s symbol.

Package

docparser.

Source

nodes.lisp.


6.1.4 Generic functions

Generic Reader: cffi-bitfield-masks (object)
Package

docparser.

Methods
Reader Method: cffi-bitfield-masks ((cffi-bitfield cffi-bitfield))

A list of masks (keywords).

Source

nodes.lisp.

Target Slot

masks.

Generic Reader: cffi-enum-variants (object)
Package

docparser.

Methods
Reader Method: cffi-enum-variants ((cffi-enum cffi-enum))

A list of enum values (keywords).

Source

nodes.lisp.

Target Slot

variants.

Generic Reader: cffi-function-foreign-name (object)
Package

docparser.

Methods
Reader Method: cffi-function-foreign-name ((cffi-function cffi-function))

The function’s foreign name.

Source

nodes.lisp.

Target Slot

foreign-name.

Generic Reader: cffi-function-return-type (object)
Package

docparser.

Methods
Reader Method: cffi-function-return-type ((cffi-function cffi-function))

The function’s return type.

Source

nodes.lisp.

Target Slot

return-type.

Generic Reader: cffi-slot-type (object)
Package

docparser.

Methods
Reader Method: cffi-slot-type ((cffi-slot cffi-slot))

The slot’s type.

Source

nodes.lisp.

Target Slot

type.

Generic Reader: cffi-struct-slots (object)
Package

docparser.

Methods
Reader Method: cffi-struct-slots ((cffi-struct cffi-struct))

A list of CFFI slots.

Source

nodes.lisp.

Target Slot

slots.

Generic Reader: cffi-type-base-type (object)
Package

docparser.

Methods
Reader Method: cffi-type-base-type ((cffi-type cffi-type))

The type’s base type.

Source

nodes.lisp.

Target Slot

base-type.

Generic Reader: cffi-union-variants (object)
Package

docparser.

Methods
Reader Method: cffi-union-variants ((cffi-union cffi-union))

A list of CFFI slots.

Source

nodes.lisp.

Target Slot

variants.

Generic Reader: class-node-default-initargs (object)
Package

docparser.

Methods
Reader Method: class-node-default-initargs ((class-node class-node))

The class’s metaclass (symbol).

Source

nodes.lisp.

Target Slot

default-initargs.

Generic Reader: class-node-metaclass (object)
Package

docparser.

Methods
Reader Method: class-node-metaclass ((class-node class-node))

The class’s metaclass (symbol).

Source

nodes.lisp.

Target Slot

metaclass.

Generic Reader: class-node-superclasses (object)
Package

docparser.

Methods
Reader Method: class-node-superclasses ((class-node class-node))

A list of the class’s superclasses (symbols).

Source

nodes.lisp.

Target Slot

superclasses.

Generic Reader: node-docstring (object)
Package

docparser.

Methods
Reader Method: node-docstring ((documentation-node documentation-node))

The node’s documentation.

Source

nodes.lisp.

Target Slot

node-docstring.

Generic Reader: node-form (object)
Generic Writer: (setf node-form) (object)
Package

docparser.

Methods
Reader Method: node-form ((name-node name-node))
Writer Method: (setf node-form) ((name-node name-node))

The original form.

Source

nodes.lisp.

Target Slot

form.

Generic Reader: node-name (object)
Package

docparser.

Methods
Reader Method: node-name ((name-node name-node))

The symbol name of the operator, variable, or class.

Source

nodes.lisp.

Target Slot

node-name.

Generic Function: node= (a b)

Test whether a and b are equal.

Package

docparser.

Source

equal.lisp.

Methods
Method: node= ((a cffi-bitfield) (b cffi-bitfield))
Method: node= ((a cffi-enum) (b cffi-enum))
Method: node= ((a cffi-union) (b cffi-union))
Method: node= ((a cffi-struct) (b cffi-struct))
Method: node= ((a cffi-slot) (b cffi-slot))
Method: node= ((a cffi-type) (b cffi-type))
Method: node= ((a cffi-function) (b cffi-function))
Method: node= ((a class-node) (b class-node))
Method: node= ((a struct-node) (b struct-node))
Method: node= ((a class-slot-node) (b class-slot-node))
Method: node= ((a struct-slot-node) (b struct-slot-node))
Method: node= ((a method-node) (b method-node))
Method: node= ((a generic-function-node) (b generic-function-node))
Method: node= ((a function-node) (b function-node))
Method: node= ((a operator-node) (b operator-node))
Method: node= ((a documentation-node) (b documentation-node))
Method: node= ((a name-node) (b name-node))
Method: node= (a b)

The default method.

Generic Reader: operator-lambda-list (object)
Package

docparser.

Methods
Reader Method: operator-lambda-list ((operator-node operator-node))

The operator’s lambda list.

Source

nodes.lisp.

Target Slot

lambda-list.

Generic Reader: operator-setf-p (object)
Package

docparser.

Methods
Reader Method: operator-setf-p ((operator-node operator-node))

Whether the operator is a setf operation.

Source

nodes.lisp.

Target Slot

setfp.

Generic Reader: package-index-docstring (object)
Package

docparser.

Methods
Reader Method: package-index-docstring ((package-index package-index))

The package’s docstring.

Source

core.lisp.

Target Slot

docstring.

Generic Reader: package-index-name (object)
Package

docparser.

Methods
Reader Method: package-index-name ((package-index package-index))

The package’s name.

Source

core.lisp.

Target Slot

name.

Generic Reader: record-slots (object)
Package

docparser.

Methods
Reader Method: record-slots ((class-node class-node))

A list of slots.

Source

nodes.lisp.

Target Slot

slots.

Reader Method: record-slots ((struct-node struct-node))

A list of slots.

Source

nodes.lisp.

Target Slot

slots.

Generic Reader: slot-accessors (object)
Package

docparser.

Methods
Reader Method: slot-accessors ((class-slot-node class-slot-node))

automatically generated reader method

Source

nodes.lisp.

Target Slot

accessors.

Generic Reader: slot-allocation (object)
Package

docparser.

Methods
Reader Method: slot-allocation ((class-slot-node class-slot-node))

The slot’s allocation type.

Source

nodes.lisp.

Target Slot

allocation.

Generic Reader: slot-initarg (object)
Package

docparser.

Methods
Reader Method: slot-initarg ((class-slot-node class-slot-node))

The slot’s initarg.

Source

nodes.lisp.

Target Slot

initarg.

Generic Reader: slot-readers (object)
Package

docparser.

Methods
Reader Method: slot-readers ((class-slot-node class-slot-node))

automatically generated reader method

Source

nodes.lisp.

Target Slot

readers.

Generic Reader: slot-type (object)
Package

docparser.

Methods
Reader Method: slot-type ((class-slot-node class-slot-node))

The slot’s type.

Source

nodes.lisp.

Target Slot

type.

Generic Reader: slot-writers (object)
Package

docparser.

Methods
Reader Method: slot-writers ((class-slot-node class-slot-node))

automatically generated reader method

Source

nodes.lisp.

Target Slot

writers.

Generic Reader: struct-node-conc-name (object)
Package

docparser.

Methods
Reader Method: struct-node-conc-name ((struct-node struct-node))

The prefix used for the struct’s slot accessors.

Source

nodes.lisp.

Target Slot

conc-name.

Generic Reader: struct-node-constructor (object)
Package

docparser.

Methods
Reader Method: struct-node-constructor ((struct-node struct-node))

The constructor; which is nil if there is none, the
constructor’s symbol, or a list of the boa-constructor’s symbol and arguments.

Source

nodes.lisp.

Target Slot

constructor.

Generic Reader: struct-node-copier (object)
Package

docparser.

Methods
Reader Method: struct-node-copier ((struct-node struct-node))

The copier function.

Source

nodes.lisp.

Target Slot

copier.

Generic Reader: struct-node-include-name (object)
Package

docparser.

Methods
Reader Method: struct-node-include-name ((struct-node struct-node))

Structure that this one inherits from, if any.

Source

nodes.lisp.

Target Slot

include-name.

Generic Reader: struct-node-include-slots (object)
Package

docparser.

Methods
Reader Method: struct-node-include-slots ((struct-node struct-node))

Included structure slot descriptions.

Source

nodes.lisp.

Target Slot

include-slots.

Generic Reader: struct-node-initial-offset (object)
Package

docparser.

Methods
Reader Method: struct-node-initial-offset ((struct-node struct-node))

The structure’s initial offset (integer), or nil if :type was not given.

Source

nodes.lisp.

Target Slot

initial-offset.

Generic Reader: struct-node-named (object)
Package

docparser.

Methods
Reader Method: struct-node-named ((struct-node struct-node))

Whether the structure is named or not.

Source

nodes.lisp.

Target Slot

named.

Generic Reader: struct-node-predicate (object)
Package

docparser.

Methods
Reader Method: struct-node-predicate ((struct-node struct-node))

The predicate function.

Source

nodes.lisp.

Target Slot

predicate.

Generic Reader: struct-node-print-function (object)
Package

docparser.

Methods
Reader Method: struct-node-print-function ((struct-node struct-node))

The print-function function, or nil if there is none.

Source

nodes.lisp.

Target Slot

print-function.

Generic Reader: struct-node-print-object (object)
Package

docparser.

Methods
Reader Method: struct-node-print-object ((struct-node struct-node))

The print-object function, or nil if there is none.

Source

nodes.lisp.

Target Slot

print-object.

Generic Reader: struct-node-type (object)
Package

docparser.

Methods
Reader Method: struct-node-type ((struct-node struct-node))

The structure’s representation.

Source

nodes.lisp.

Target Slot

type.

Generic Reader: struct-slot-accessor (object)
Package

docparser.

Methods
Reader Method: struct-slot-accessor ((struct-slot-node struct-slot-node))

The slot’s accessor.

Source

nodes.lisp.

Target Slot

accessor.

Generic Reader: struct-slot-read-only (object)
Package

docparser.

Methods
Reader Method: struct-slot-read-only ((struct-slot-node struct-slot-node))

Whether the slot is readonly or not.

Source

nodes.lisp.

Target Slot

read-only.

Generic Reader: struct-slot-type (object)
Package

docparser.

Methods
Reader Method: struct-slot-type ((struct-slot-node struct-slot-node))

The slot’s type.

Source

nodes.lisp.

Target Slot

type.

Generic Reader: variable-initial-value (object)
Package

docparser.

Methods
Reader Method: variable-initial-value ((variable-node variable-node))

automatically generated reader method

Source

nodes.lisp.

Target Slot

variable-initial-value.


6.1.5 Standalone methods

Reader Method: method-qualifiers ((method-node method-node))

automatically generated reader method

Source

nodes.lisp.

Target Slot

qualifiers.

Method: print-object ((condition condition-node) stream)

Print a condition definition node.

Source

print.lisp.

Method: print-object ((type cffi-type) stream)

Print a CFFI type definition node.

Source

print.lisp.

Method: print-object ((function cffi-function) stream)
Source

print.lisp.

Method: print-object ((enum cffi-enum) stream)

Print a CFFI enum definition node.

Source

print.lisp.

Method: print-object ((struct struct-node) stream)

Print a struct definition node.

Source

print.lisp.

Method: print-object ((class class-node) stream)

Print a class definition node.

Source

print.lisp.

Method: print-object ((union cffi-union) stream)
Source

print.lisp.

Method: print-object ((operator operator-node) stream)

Print an operator node.

Source

print.lisp.

Method: print-object ((type type-node) stream)

Print a type definition node.

Source

print.lisp.

Method: print-object ((struct cffi-struct) stream)
Source

print.lisp.

Method: print-object ((var variable-node) stream)

Print a variable node.

Source

print.lisp.


6.1.6 Classes

Class: cffi-bitfield

A C bitfield.

Package

docparser.

Source

nodes.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: masks

A list of masks (keywords).

Type

(trivial-types:proper-list keyword)

Initargs

:masks

Readers

cffi-bitfield-masks.

Writers

This slot is read-only.

Class: cffi-enum

A C enum.

Package

docparser.

Source

nodes.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: variants

A list of enum values (keywords).

Type

(trivial-types:proper-list keyword)

Initargs

:variants

Readers

cffi-enum-variants.

Writers

This slot is read-only.

Class: cffi-function

A C function.

Package

docparser.

Source

nodes.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: foreign-name

The function’s foreign name.

Type

string

Initargs

:foreign-name

Readers

cffi-function-foreign-name.

Writers

This slot is read-only.

Slot: return-type

The function’s return type.

Initargs

:return-type

Readers

cffi-function-return-type.

Writers

This slot is read-only.

Class: cffi-node

The base class of all CFFI documentation nodes. Does not
inherit from documentation-node as not all sub-nodes have docstrings.

Package

docparser.

Source

nodes.lisp.

Direct subclasses
Class: cffi-slot

A struct or union slot.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

name-node.

Direct methods
Direct slots
Slot: type

The slot’s type.

Package

common-lisp.

Initargs

:type

Readers

cffi-slot-type.

Writers

This slot is read-only.

Class: cffi-struct

A C structure.

Package

docparser.

Source

nodes.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: slots

A list of CFFI slots.

Type

(trivial-types:proper-list docparser:cffi-slot)

Initargs

:slots

Readers

cffi-struct-slots.

Writers

This slot is read-only.

Class: cffi-type

A C type.

Package

docparser.

Source

nodes.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: base-type

The type’s base type.

Initargs

:base-type

Readers

cffi-type-base-type.

Writers

This slot is read-only.

Class: cffi-union

A C union.

Package

docparser.

Source

nodes.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: variants

A list of CFFI slots.

Type

(trivial-types:proper-list docparser:cffi-slot)

Initargs

:variants

Readers

cffi-union-variants.

Writers

This slot is read-only.

Class: class-node

A class.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

record-node.

Direct subclasses

condition-node.

Direct methods
Direct slots
Slot: superclasses

A list of the class’s superclasses (symbols).

Type

(trivial-types:proper-list symbol)

Initargs

:superclasses

Readers

class-node-superclasses.

Writers

This slot is read-only.

Slot: metaclass

The class’s metaclass (symbol).

Type

symbol

Initargs

:metaclass

Readers

class-node-metaclass.

Writers

This slot is read-only.

Slot: default-initargs

The class’s metaclass (symbol).

Type

(trivial-types:proper-list)

Initargs

:default-initargs

Readers

class-node-default-initargs.

Writers

This slot is read-only.

Slot: slots

A list of slots.

Type

(trivial-types:proper-list docparser:class-slot-node)

Initargs

:slots

Readers

record-slots.

Writers

This slot is read-only.

Class: class-slot-node

A class or structure slot.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

documentation-node.

Direct methods
Direct slots
Slot: accessors
Type

(trivial-types:proper-list symbol)

Initargs

:accessors

Readers

slot-accessors.

Writers

This slot is read-only.

Slot: readers
Type

(trivial-types:proper-list symbol)

Initargs

:readers

Readers

slot-readers.

Writers

This slot is read-only.

Slot: writers
Type

(trivial-types:proper-list symbol)

Initargs

:writers

Readers

slot-writers.

Writers

This slot is read-only.

Slot: type

The slot’s type.

Package

common-lisp.

Initargs

:type

Readers

slot-type.

Writers

This slot is read-only.

Slot: initarg

The slot’s initarg.

Initargs

:initarg

Readers

slot-initarg.

Writers

This slot is read-only.

Slot: initform

The slot’s initform.

Initargs

:initform

Slot: allocation

The slot’s allocation type.

Type

keyword

Initform

:instance

Initargs

:allocation

Readers

slot-allocation.

Writers

This slot is read-only.

Class: condition-node

A condition.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

class-node.

Direct methods

print-object.

Class: documentation-node

The base class of all documentable nodes.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

name-node.

Direct subclasses
Direct methods
Direct slots
Slot: node-docstring

The node’s documentation.

Type

(or null string)

Initargs

:docstring

Readers

node-docstring.

Writers

This slot is read-only.

Class: function-node

A function.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

operator-node.

Direct subclasses

cffi-function.

Direct methods

node=.

Class: generic-function-node

A generic function.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

operator-node.

Direct methods

node=.

Class: index

Holds system documentation, and the internal package indices.

Package

docparser.

Source

core.lisp.

Direct methods
Direct slots
Slot: packages

A vector of package indices.

Type

(vector docparser:package-index)

Initform

(make-array 0 :adjustable t :element-type (quote docparser:package-index) :fill-pointer 0)

Readers

index-packages.

Writers

(setf index-packages).

Class: macro-node

A macro.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

operator-node.

Class: method-node

A method.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

operator-node.

Direct methods
Direct slots
Slot: qualifiers
Initargs

:qualifiers

Readers

method-qualifiers.

Writers

This slot is read-only.

Class: name-node

The base class of nodes with symbol names.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

node.

Direct subclasses
Direct methods
Direct slots
Slot: form

The original form.

Initargs

:form

Readers

node-form.

Writers

(setf node-form).

Slot: node-name

The symbol name of the operator, variable, or class.

Type

symbol

Initargs

:name

Readers

node-name.

Writers

This slot is read-only.

Class: node

The base class of all nodes.

Package

docparser.

Source

nodes.lisp.

Direct subclasses

name-node.

Class: operator-node

The base class of functions and macros.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

documentation-node.

Direct subclasses
Direct methods
Direct slots
Slot: lambda-list

The operator’s lambda list.

Initargs

:lambda-list

Readers

operator-lambda-list.

Writers

This slot is read-only.

Slot: setfp

Whether the operator is a setf operation.

Type

boolean

Initargs

:setfp

Readers

operator-setf-p.

Writers

This slot is read-only.

Class: package-index

Holds the documented objects in this package.

Package

docparser.

Source

core.lisp.

Direct methods
Direct slots
Slot: name

The package’s name.

Type

string

Initargs

:name

Readers

package-index-name.

Writers

This slot is read-only.

Slot: docstring

The package’s docstring.

Type

(or null string)

Initargs

:docstring

Readers

package-index-docstring.

Writers

This slot is read-only.

Slot: nodes

A vector of documentation objects.

Type

(vector docparser:documentation-node)

Initform

(make-array 0 :adjustable t :element-type (quote docparser:documentation-node) :fill-pointer 0)

Readers

package-index-nodes.

Writers

(setf package-index-nodes).

Class: record-node

The base class of all nodes representing record-like data type definitions (i.e. structures, classes).

Package

docparser.

Source

nodes.lisp.

Direct superclasses

documentation-node.

Direct subclasses
Class: struct-node

A structure.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

record-node.

Direct methods
Direct slots
Slot: slots

A list of slots.

Type

(trivial-types:proper-list docparser:struct-slot-node)

Initargs

:slots

Readers

record-slots.

Writers

This slot is read-only.

Slot: conc-name

The prefix used for the struct’s slot accessors.

Type

string

Initargs

:conc-name

Readers

struct-node-conc-name.

Writers

This slot is read-only.

Slot: constructor

The constructor; which is nil if there is none, the
constructor’s symbol, or a list of the boa-constructor’s symbol and arguments.

Type

(or symbol trivial-types:proper-list)

Initargs

:constructor

Readers

struct-node-constructor.

Writers

This slot is read-only.

Slot: copier

The copier function.

Type

symbol

Initargs

:copier

Readers

struct-node-copier.

Writers

This slot is read-only.

Slot: include-name

Structure that this one inherits from, if any.

Type

symbol

Initargs

:include-name

Readers

struct-node-include-name.

Writers

This slot is read-only.

Slot: include-slots

Included structure slot descriptions.

Type

(trivial-types:proper-list docparser:struct-slot-node)

Initargs

:include-slots

Readers

struct-node-include-slots.

Writers

This slot is read-only.

Slot: initial-offset

The structure’s initial offset (integer), or nil if :type was not given.

Type

(or null (integer 0))

Initargs

:initial-offset

Readers

struct-node-initial-offset.

Writers

This slot is read-only.

Slot: named

Whether the structure is named or not.

Type

boolean

Initargs

:named

Readers

struct-node-named.

Writers

This slot is read-only.

Slot: predicate

The predicate function.

Type

symbol

Initargs

:predicate

Readers

struct-node-predicate.

Writers

This slot is read-only.

Slot: print-function

The print-function function, or nil if there is none.

Type

symbol

Initargs

:print-function

Readers

struct-node-print-function.

Writers

This slot is read-only.

Slot: print-object

The print-object function, or nil if there is none.

Package

common-lisp.

Type

symbol

Initargs

:print-object

Readers

struct-node-print-object.

Writers

This slot is read-only.

Slot: type

The structure’s representation.

Package

common-lisp.

Type

(or null symbol (cons symbol (cons (or symbol list) null)))

Initargs

:type

Readers

struct-node-type.

Writers

This slot is read-only.

Class: struct-slot-node

A structure’s slot.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

name-node.

Direct methods
Direct slots
Slot: initform

The slot’s initform.

Initargs

:initform

Slot: type

The slot’s type.

Package

common-lisp.

Initform

t

Initargs

:type

Readers

struct-slot-type.

Writers

This slot is read-only.

Slot: read-only

Whether the slot is readonly or not.

Type

boolean

Initargs

:read-only

Readers

struct-slot-read-only.

Writers

This slot is read-only.

Slot: accessor

The slot’s accessor.

Type

symbol

Initargs

:accessor

Readers

struct-slot-accessor.

Writers

This slot is read-only.

Class: type-node

A type.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

operator-node.

Direct methods

print-object.

Class: variable-node

A variable.

Package

docparser.

Source

nodes.lisp.

Direct superclasses

documentation-node.

Direct methods
Direct slots
Slot: variable-initial-value
Initargs

:initial-value

Readers

variable-initial-value.

Writers

This slot is read-only.


6.2 Internals


6.2.1 Special variables

Special Variable: *parsers*

A list of symbols to the functions used to parse their corresponding forms.

Package

docparser.

Source

core.lisp.


6.2.2 Macros

Macro: define-equality ((a b class) &body body)
Package

docparser.

Source

equal.lisp.

Macro: with-ignored-errors (() &body body)

Catch and ignore certain errors.

Package

docparser.

Source

core.lisp.


6.2.3 Ordinary functions

Function: add-node (index node)

Add a node to an index, finding the proper package index.

Package

docparser.

Source

core.lisp.

Function: add-package-index (index package-index)
Package

docparser.

Source

core.lisp.

Function: ensure-preload (system-name)
Package

docparser.

Source

core.lisp.

Function: find-nodes (index package-predicate node-predicate)

Return a vector of nodes satisfying node-predicate, in packages satisfying package-predicate.

Package

docparser.

Source

core.lisp.

Function: find-package-index (index package-name)

Return the package-index with that name, or NIL.

Package

docparser.

Source

core.lisp.

Function: load-system (system-name)

Load an ASDF system by name.

Package

docparser.

Source

core.lisp.

Function: node-exists-p (index node)

Does the node exist in the package index.

Package

docparser.

Source

core.lisp.

Function: parse-cffi-slot (form)
Package

docparser.

Source

parsers.lisp.

Function: parse-form (form)

Parse a form into a node.

Package

docparser.

Source

core.lisp.

Function: parse-package-definition (form)
Package

docparser.

Source

core.lisp.

Function: parse-slot (slot)
Package

docparser.

Source

parsers.lisp.

Function: parse-struct-slot (slot &optional conc-name package)
Package

docparser.

Source

parsers.lisp.

Function: parse-system (index system-name)

Parse a system.

Package

docparser.

Source

core.lisp.

Function: parse-var (form)
Package

docparser.

Source

parsers.lisp.

Function: slot-or-nil (object slot)
Package

docparser.

Source

equal.lisp.


6.2.4 Generic functions

Generic Reader: index-packages (object)
Generic Writer: (setf index-packages) (object)
Package

docparser.

Methods
Reader Method: index-packages ((index index))
Writer Method: (setf index-packages) ((index index))

A vector of package indices.

Source

core.lisp.

Target Slot

packages.

Generic Reader: package-index-nodes (object)
Generic Writer: (setf package-index-nodes) (object)
Package

docparser.

Methods
Reader Method: package-index-nodes ((package-index package-index))
Writer Method: (setf package-index-nodes) ((package-index package-index))

A vector of documentation objects.

Source

core.lisp.

Target Slot

nodes.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   I   L   M   N   O   P   Q   R   S   V   W  
Index Entry  Section

(
(setf index-packages): Private generic functions
(setf index-packages): Private generic functions
(setf node-form): Public generic functions
(setf node-form): Public generic functions
(setf package-index-nodes): Private generic functions
(setf package-index-nodes): Private generic functions

A
add-node: Private ordinary functions
add-package-index: Private ordinary functions

C
cffi-bitfield-masks: Public generic functions
cffi-bitfield-masks: Public generic functions
cffi-enum-variants: Public generic functions
cffi-enum-variants: Public generic functions
cffi-function-foreign-name: Public generic functions
cffi-function-foreign-name: Public generic functions
cffi-function-return-type: Public generic functions
cffi-function-return-type: Public generic functions
cffi-slot-type: Public generic functions
cffi-slot-type: Public generic functions
cffi-struct-slots: Public generic functions
cffi-struct-slots: Public generic functions
cffi-type-base-type: Public generic functions
cffi-type-base-type: Public generic functions
cffi-union-variants: Public generic functions
cffi-union-variants: Public generic functions
class-node-default-initargs: Public generic functions
class-node-default-initargs: Public generic functions
class-node-metaclass: Public generic functions
class-node-metaclass: Public generic functions
class-node-superclasses: Public generic functions
class-node-superclasses: Public generic functions

D
define-equality: Private macros
define-parser: Public macros
do-nodes: Public macros
do-packages: Public macros
dump: Public ordinary functions

E
ensure-preload: Private ordinary functions
extract-docstring: Public ordinary functions

F
find-nodes: Private ordinary functions
find-package-index: Private ordinary functions
Function, add-node: Private ordinary functions
Function, add-package-index: Private ordinary functions
Function, dump: Public ordinary functions
Function, ensure-preload: Private ordinary functions
Function, extract-docstring: Public ordinary functions
Function, find-nodes: Private ordinary functions
Function, find-package-index: Private ordinary functions
Function, load-system: Private ordinary functions
Function, node-exists-p: Private ordinary functions
Function, parse: Public ordinary functions
Function, parse-cffi-slot: Private ordinary functions
Function, parse-form: Private ordinary functions
Function, parse-package-definition: Private ordinary functions
Function, parse-slot: Private ordinary functions
Function, parse-struct-slot: Private ordinary functions
Function, parse-system: Private ordinary functions
Function, parse-var: Private ordinary functions
Function, query: Public ordinary functions
Function, render-humanize: Public ordinary functions
Function, slot-initform: Public ordinary functions
Function, slot-or-nil: Private ordinary functions
Function, symbol-external-p: Public ordinary functions
Function, symbol-package-name: Public ordinary functions

G
Generic Function, (setf index-packages): Private generic functions
Generic Function, (setf node-form): Public generic functions
Generic Function, (setf package-index-nodes): Private generic functions
Generic Function, cffi-bitfield-masks: Public generic functions
Generic Function, cffi-enum-variants: Public generic functions
Generic Function, cffi-function-foreign-name: Public generic functions
Generic Function, cffi-function-return-type: Public generic functions
Generic Function, cffi-slot-type: Public generic functions
Generic Function, cffi-struct-slots: Public generic functions
Generic Function, cffi-type-base-type: Public generic functions
Generic Function, cffi-union-variants: Public generic functions
Generic Function, class-node-default-initargs: Public generic functions
Generic Function, class-node-metaclass: Public generic functions
Generic Function, class-node-superclasses: Public generic functions
Generic Function, index-packages: Private generic functions
Generic Function, node-docstring: Public generic functions
Generic Function, node-form: Public generic functions
Generic Function, node-name: Public generic functions
Generic Function, node=: Public generic functions
Generic Function, operator-lambda-list: Public generic functions
Generic Function, operator-setf-p: Public generic functions
Generic Function, package-index-docstring: Public generic functions
Generic Function, package-index-name: Public generic functions
Generic Function, package-index-nodes: Private generic functions
Generic Function, record-slots: Public generic functions
Generic Function, slot-accessors: Public generic functions
Generic Function, slot-allocation: Public generic functions
Generic Function, slot-initarg: Public generic functions
Generic Function, slot-readers: Public generic functions
Generic Function, slot-type: Public generic functions
Generic Function, slot-writers: Public generic functions
Generic Function, struct-node-conc-name: Public generic functions
Generic Function, struct-node-constructor: Public generic functions
Generic Function, struct-node-copier: Public generic functions
Generic Function, struct-node-include-name: Public generic functions
Generic Function, struct-node-include-slots: Public generic functions
Generic Function, struct-node-initial-offset: Public generic functions
Generic Function, struct-node-named: Public generic functions
Generic Function, struct-node-predicate: Public generic functions
Generic Function, struct-node-print-function: Public generic functions
Generic Function, struct-node-print-object: Public generic functions
Generic Function, struct-node-type: Public generic functions
Generic Function, struct-slot-accessor: Public generic functions
Generic Function, struct-slot-read-only: Public generic functions
Generic Function, struct-slot-type: Public generic functions
Generic Function, variable-initial-value: Public generic functions

I
index-packages: Private generic functions
index-packages: Private generic functions

L
load-system: Private ordinary functions

M
Macro, define-equality: Private macros
Macro, define-parser: Public macros
Macro, do-nodes: Public macros
Macro, do-packages: Public macros
Macro, with-ignored-errors: Private macros
Method, (setf index-packages): Private generic functions
Method, (setf node-form): Public generic functions
Method, (setf package-index-nodes): Private generic functions
Method, cffi-bitfield-masks: Public generic functions
Method, cffi-enum-variants: Public generic functions
Method, cffi-function-foreign-name: Public generic functions
Method, cffi-function-return-type: Public generic functions
Method, cffi-slot-type: Public generic functions
Method, cffi-struct-slots: Public generic functions
Method, cffi-type-base-type: Public generic functions
Method, cffi-union-variants: Public generic functions
Method, class-node-default-initargs: Public generic functions
Method, class-node-metaclass: Public generic functions
Method, class-node-superclasses: Public generic functions
Method, index-packages: Private generic functions
Method, method-qualifiers: Public standalone methods
Method, node-docstring: Public generic functions
Method, node-form: Public generic functions
Method, node-name: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, node=: Public generic functions
Method, operator-lambda-list: Public generic functions
Method, operator-setf-p: Public generic functions
Method, package-index-docstring: Public generic functions
Method, package-index-name: Public generic functions
Method, package-index-nodes: Private generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, record-slots: Public generic functions
Method, record-slots: Public generic functions
Method, slot-accessors: Public generic functions
Method, slot-allocation: Public generic functions
Method, slot-initarg: Public generic functions
Method, slot-readers: Public generic functions
Method, slot-type: Public generic functions
Method, slot-writers: Public generic functions
Method, struct-node-conc-name: Public generic functions
Method, struct-node-constructor: Public generic functions
Method, struct-node-copier: Public generic functions
Method, struct-node-include-name: Public generic functions
Method, struct-node-include-slots: Public generic functions
Method, struct-node-initial-offset: Public generic functions
Method, struct-node-named: Public generic functions
Method, struct-node-predicate: Public generic functions
Method, struct-node-print-function: Public generic functions
Method, struct-node-print-object: Public generic functions
Method, struct-node-type: Public generic functions
Method, struct-slot-accessor: Public generic functions
Method, struct-slot-read-only: Public generic functions
Method, struct-slot-type: Public generic functions
Method, variable-initial-value: Public generic functions
method-qualifiers: Public standalone methods

N
node-docstring: Public generic functions
node-docstring: Public generic functions
node-exists-p: Private ordinary functions
node-form: Public generic functions
node-form: Public generic functions
node-name: Public generic functions
node-name: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions
node=: Public generic functions

O
operator-lambda-list: Public generic functions
operator-lambda-list: Public generic functions
operator-setf-p: Public generic functions
operator-setf-p: Public generic functions

P
package-index-docstring: Public generic functions
package-index-docstring: Public generic functions
package-index-name: Public generic functions
package-index-name: Public generic functions
package-index-nodes: Private generic functions
package-index-nodes: Private generic functions
parse: Public ordinary functions
parse-cffi-slot: Private ordinary functions
parse-form: Private ordinary functions
parse-package-definition: Private ordinary functions
parse-slot: Private ordinary functions
parse-struct-slot: Private ordinary functions
parse-system: Private ordinary functions
parse-var: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods

Q
query: Public ordinary functions

R
record-slots: Public generic functions
record-slots: Public generic functions
record-slots: Public generic functions
render-humanize: Public ordinary functions

S
slot-accessors: Public generic functions
slot-accessors: Public generic functions
slot-allocation: Public generic functions
slot-allocation: Public generic functions
slot-initarg: Public generic functions
slot-initarg: Public generic functions
slot-initform: Public ordinary functions
slot-or-nil: Private ordinary functions
slot-readers: Public generic functions
slot-readers: Public generic functions
slot-type: Public generic functions
slot-type: Public generic functions
slot-writers: Public generic functions
slot-writers: Public generic functions
struct-node-conc-name: Public generic functions
struct-node-conc-name: Public generic functions
struct-node-constructor: Public generic functions
struct-node-constructor: Public generic functions
struct-node-copier: Public generic functions
struct-node-copier: Public generic functions
struct-node-include-name: Public generic functions
struct-node-include-name: Public generic functions
struct-node-include-slots: Public generic functions
struct-node-include-slots: Public generic functions
struct-node-initial-offset: Public generic functions
struct-node-initial-offset: Public generic functions
struct-node-named: Public generic functions
struct-node-named: Public generic functions
struct-node-predicate: Public generic functions
struct-node-predicate: Public generic functions
struct-node-print-function: Public generic functions
struct-node-print-function: Public generic functions
struct-node-print-object: Public generic functions
struct-node-print-object: Public generic functions
struct-node-type: Public generic functions
struct-node-type: Public generic functions
struct-slot-accessor: Public generic functions
struct-slot-accessor: Public generic functions
struct-slot-read-only: Public generic functions
struct-slot-read-only: Public generic functions
struct-slot-type: Public generic functions
struct-slot-type: Public generic functions
symbol-external-p: Public ordinary functions
symbol-package-name: Public ordinary functions

V
variable-initial-value: Public generic functions
variable-initial-value: Public generic functions

W
with-ignored-errors: Private macros


A.3 Variables

Jump to:   *  
A   B   C   D   F   I   L   M   N   P   Q   R   S   T   V   W  
Index Entry  Section

*
*parsers*: Private special variables
*store-form*: Public special variables

A
accessor: Public classes
accessors: Public classes
allocation: Public classes

B
base-type: Public classes

C
conc-name: Public classes
constructor: Public classes
copier: Public classes

D
default-initargs: Public classes
docstring: Public classes

F
foreign-name: Public classes
form: Public classes

I
include-name: Public classes
include-slots: Public classes
initarg: Public classes
initform: Public classes
initform: Public classes
initial-offset: Public classes

L
lambda-list: Public classes

M
masks: Public classes
metaclass: Public classes

N
name: Public classes
named: Public classes
node-docstring: Public classes
node-name: Public classes
nodes: Public classes

P
packages: Public classes
predicate: Public classes
print-function: Public classes
print-object: Public classes

Q
qualifiers: Public classes

R
read-only: Public classes
readers: Public classes
return-type: Public classes

S
setfp: Public classes
Slot, accessor: Public classes
Slot, accessors: Public classes
Slot, allocation: Public classes
Slot, base-type: Public classes
Slot, conc-name: Public classes
Slot, constructor: Public classes
Slot, copier: Public classes
Slot, default-initargs: Public classes
Slot, docstring: Public classes
Slot, foreign-name: Public classes
Slot, form: Public classes
Slot, include-name: Public classes
Slot, include-slots: Public classes
Slot, initarg: Public classes
Slot, initform: Public classes
Slot, initform: Public classes
Slot, initial-offset: Public classes
Slot, lambda-list: Public classes
Slot, masks: Public classes
Slot, metaclass: Public classes
Slot, name: Public classes
Slot, named: Public classes
Slot, node-docstring: Public classes
Slot, node-name: Public classes
Slot, nodes: Public classes
Slot, packages: Public classes
Slot, predicate: Public classes
Slot, print-function: Public classes
Slot, print-object: Public classes
Slot, qualifiers: Public classes
Slot, read-only: Public classes
Slot, readers: Public classes
Slot, return-type: Public classes
Slot, setfp: Public classes
Slot, slots: Public classes
Slot, slots: Public classes
Slot, slots: Public classes
Slot, superclasses: Public classes
Slot, type: Public classes
Slot, type: Public classes
Slot, type: Public classes
Slot, type: Public classes
Slot, variable-initial-value: Public classes
Slot, variants: Public classes
Slot, variants: Public classes
Slot, writers: Public classes
slots: Public classes
slots: Public classes
slots: Public classes
Special Variable, *parsers*: Private special variables
Special Variable, *store-form*: Public special variables
superclasses: Public classes

T
type: Public classes
type: Public classes
type: Public classes
type: Public classes

V
variable-initial-value: Public classes
variants: Public classes
variants: Public classes

W
writers: Public classes


A.4 Data types

Jump to:   C   D   E   F   G   I   M   N   O   P   R   S   T   V  
Index Entry  Section

C
cffi-bitfield: Public classes
cffi-enum: Public classes
cffi-function: Public classes
cffi-node: Public classes
cffi-slot: Public classes
cffi-struct: Public classes
cffi-type: Public classes
cffi-union: Public classes
Class, cffi-bitfield: Public classes
Class, cffi-enum: Public classes
Class, cffi-function: Public classes
Class, cffi-node: Public classes
Class, cffi-slot: Public classes
Class, cffi-struct: Public classes
Class, cffi-type: Public classes
Class, cffi-union: Public classes
Class, class-node: Public classes
Class, class-slot-node: Public classes
Class, condition-node: Public classes
Class, documentation-node: Public classes
Class, function-node: Public classes
Class, generic-function-node: Public classes
Class, index: Public classes
Class, macro-node: Public classes
Class, method-node: Public classes
Class, name-node: Public classes
Class, node: Public classes
Class, operator-node: Public classes
Class, package-index: Public classes
Class, record-node: Public classes
Class, struct-node: Public classes
Class, struct-slot-node: Public classes
Class, type-node: Public classes
Class, variable-node: Public classes
class-node: Public classes
class-slot-node: Public classes
condition-node: Public classes
core.lisp: The docparser/src/core․lisp file

D
docparser: The docparser system
docparser: The docparser package
docparser.asd: The docparser/docparser․asd file
documentation-node: Public classes

E
equal.lisp: The docparser/src/equal․lisp file

F
File, core.lisp: The docparser/src/core․lisp file
File, docparser.asd: The docparser/docparser․asd file
File, equal.lisp: The docparser/src/equal․lisp file
File, nodes.lisp: The docparser/src/nodes․lisp file
File, package.lisp: The docparser/src/package․lisp file
File, parsers.lisp: The docparser/src/parsers․lisp file
File, print.lisp: The docparser/src/print․lisp file
function-node: Public classes

G
generic-function-node: Public classes

I
index: Public classes

M
macro-node: Public classes
method-node: Public classes
Module, src: The docparser/src module

N
name-node: Public classes
node: Public classes
nodes.lisp: The docparser/src/nodes․lisp file

O
operator-node: Public classes

P
Package, docparser: The docparser package
package-index: Public classes
package.lisp: The docparser/src/package․lisp file
parsers.lisp: The docparser/src/parsers․lisp file
print.lisp: The docparser/src/print․lisp file

R
record-node: Public classes

S
src: The docparser/src module
struct-node: Public classes
struct-slot-node: Public classes
System, docparser: The docparser system

T
type-node: Public classes

V
variable-node: Public classes