docparser

API Reference

docparser

Parse documentation from Common Lisp systems.

DOCPARSER

Parse documentation from ASDF systems.
  • Class NODE
    The base class of all nodes.
    No slots.
  • Class NAME-NODE  (NODE)
    The base class of nodes with symbol names.
    FORM   Accessor: NODE-FORM
    The original form.
    NODE-NAME   Reader: NODE-NAME
    The symbol name of the operator, variable, or class.
  • Class DOCUMENTATION-NODE  (NAME-NODE)
    The base class of all documentable nodes.
    NODE-DOCSTRING   Reader: NODE-DOCSTRING
    The node's documentation.
  • Class OPERATOR-NODE  (DOCUMENTATION-NODE)
    The base class of functions and macros.
    LAMBDA-LIST   Reader: OPERATOR-LAMBDA-LIST
    The operator's lambda list.
    SETFP   Reader: OPERATOR-SETF-P
    Whether the operator is a setf operation.
  • Class FUNCTION-NODE  (OPERATOR-NODE)
    A function.
    No slots.
  • Class MACRO-NODE  (OPERATOR-NODE)
    A macro.
    No slots.
  • Class GENERIC-FUNCTION-NODE  (OPERATOR-NODE)
    A generic function.
    No slots.
  • Class METHOD-NODE  (OPERATOR-NODE)
    A method.
    QUALIFIERS   Reader: METHOD-QUALIFIERS
  • Class VARIABLE-NODE  (DOCUMENTATION-NODE)
    A variable.
    VARIABLE-INITIAL-VALUE   Reader: VARIABLE-INITIAL-VALUE
  • Class STRUCT-SLOT-NODE  (NAME-NODE)
    A structure's slot.
    INITFORM
    The slot's initform.
    TYPE   Reader: STRUCT-SLOT-TYPE
    The slot's type.
    READ-ONLY   Reader: STRUCT-SLOT-READ-ONLY
    Whether the slot is readonly or not.
    ACCESSOR   Reader: STRUCT-SLOT-ACCESSOR
    The slot's accessor.
  • Class CLASS-SLOT-NODE  (DOCUMENTATION-NODE)
    A class or structure slot.
    ACCESSORS   Reader: SLOT-ACCESSORS
    READERS   Reader: SLOT-READERS
    WRITERS   Reader: SLOT-WRITERS
    TYPE   Reader: SLOT-TYPE
    The slot's type.
    INITARG   Reader: SLOT-INITARG
    The slot's initarg.
    INITFORM
    The slot's initform.
    ALLOCATION   Reader: SLOT-ALLOCATION
    The slot's allocation type.
  • 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.
  • Class RECORD-NODE  (DOCUMENTATION-NODE)
    The base class of all nodes representing record-like data type definitions (i.e. structures, classes).
    No slots.
  • Class STRUCT-NODE  (RECORD-NODE)
    A structure.
    SLOTS   Reader: RECORD-SLOTS
    A list of slots.
    CONC-NAME   Reader: STRUCT-NODE-CONC-NAME
    The prefix used for the struct's slot accessors.
    CONSTRUCTOR   Reader: STRUCT-NODE-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.
    COPIER   Reader: STRUCT-NODE-COPIER
    The copier function.
    INCLUDE-NAME   Reader: STRUCT-NODE-INCLUDE-NAME
    Structure that this one inherits from, if any.
    INCLUDE-SLOTS   Reader: STRUCT-NODE-INCLUDE-SLOTS
    Included structure slot descriptions.
    INITIAL-OFFSET   Reader: STRUCT-NODE-INITIAL-OFFSET
    The structure's initial offset (integer), or nil if :type was not given.
    NAMED   Reader: STRUCT-NODE-NAMED
    Whether the structure is named or not.
    PREDICATE   Reader: STRUCT-NODE-PREDICATE
    The predicate function.
    PRINT-FUNCTION   Reader: STRUCT-NODE-PRINT-FUNCTION
    The print-function function, or nil if there is none.
    PRINT-OBJECT   Reader: STRUCT-NODE-PRINT-OBJECT
    The print-object function, or nil if there is none.
    TYPE   Reader: STRUCT-NODE-TYPE
    The structure's representation.
  • Class CLASS-NODE  (RECORD-NODE)
    A class.
    SUPERCLASSES   Reader: CLASS-NODE-SUPERCLASSES
    A list of the class's superclasses (symbols).
    METACLASS   Reader: CLASS-NODE-METACLASS
    The class's metaclass (symbol).
    DEFAULT-INITARGS   Reader: CLASS-NODE-DEFAULT-INITARGS
    The class's metaclass (symbol).
    SLOTS   Reader: RECORD-SLOTS
    A list of slots.
  • Class CONDITION-NODE  (CLASS-NODE)
    A condition.
    No slots.
  • Class TYPE-NODE  (OPERATOR-NODE)
    A type.
    No slots.
  • Class CFFI-NODE
    The base class of all CFFI documentation nodes. Does not inherit from documentation-node as not all sub-nodes have docstrings.
    No slots.
  • Class CFFI-FUNCTION  (CFFI-NODE, FUNCTION-NODE)
    A C function.
    RETURN-TYPE   Reader: CFFI-FUNCTION-RETURN-TYPE
    The function's return type.
  • Class CFFI-TYPE  (CFFI-NODE, DOCUMENTATION-NODE)
    A C type.
    BASE-TYPE   Reader: CFFI-TYPE-BASE-TYPE
    The type's base type.
  • Class CFFI-SLOT  (NAME-NODE)
    A struct or union slot.
    TYPE   Reader: CFFI-SLOT-TYPE
    The slot's type.
  • Class CFFI-STRUCT  (CFFI-NODE, DOCUMENTATION-NODE)
    A C structure.
    SLOTS   Reader: CFFI-STRUCT-SLOTS
    A list of CFFI slots.
  • Class CFFI-UNION  (CFFI-NODE, DOCUMENTATION-NODE)
    A C union.
    VARIANTS   Reader: CFFI-UNION-VARIANTS
    A list of CFFI slots.
  • Class CFFI-ENUM  (CFFI-NODE, DOCUMENTATION-NODE)
    A C enum.
    VARIANTS   Reader: CFFI-ENUM-VARIANTS
    A list of enum values (keywords).
  • Class CFFI-BITFIELD  (CFFI-NODE, DOCUMENTATION-NODE)
    A C bitfield.
    MASKS   Reader: CFFI-BITFIELD-MASKS
    A list of masks (keywords).
  • Function SYMBOL-EXTERNAL-P (symbol)
    Whether or not a symbol is external.
  • Function SYMBOL-PACKAGE-NAME (symbol)
    Return the name of a package's symbol.
  • Function RENDER-HUMANIZE (symbol)
    Render a symbol into a string in a human-friendly way.
  • Generic-Function NODE= (a b)
    Test whether a and b are equal.
  • Method NODE= ((a t) (b t))
    The default method.
  • Method NODE= ((a name-node) (b name-node))
  • Method NODE= ((a documentation-node) (b documentation-node))
  • Method NODE= ((a operator-node) (b operator-node))
  • Method NODE= ((a function-node) (b function-node))
  • Method NODE= ((a generic-function-node) (b generic-function-node))
  • Method NODE= ((a method-node) (b method-node))
  • Method NODE= ((a struct-slot-node) (b struct-slot-node))
  • Method NODE= ((a class-slot-node) (b class-slot-node))
  • Method NODE= ((a struct-node) (b struct-node))
  • Method NODE= ((a class-node) (b class-node))
  • Method NODE= ((a cffi-function) (b cffi-function))
  • Method NODE= ((a cffi-type) (b cffi-type))
  • Method NODE= ((a cffi-slot) (b cffi-slot))
  • Method NODE= ((a cffi-struct) (b cffi-struct))
  • Method NODE= ((a cffi-union) (b cffi-union))
  • Method NODE= ((a cffi-enum) (b cffi-enum))
  • Method NODE= ((a cffi-bitfield) (b cffi-bitfield))
  • Variable *STORE-FORM*
    nil
    Whether or not to store, inside a node, the form it was parsed from.
  • Class PACKAGE-INDEX
    Holds the documented objects in this package.
    NAME   Reader: PACKAGE-INDEX-NAME
    The package's name.
    DOCSTRING   Reader: PACKAGE-INDEX-DOCSTRING
    The package's docstring.
    NODES   Accessor: PACKAGE-INDEX-NODES
    A vector of documentation objects.
  • Class INDEX
    Holds system documentation, and the internal package indices.
    PACKAGES   Accessor: INDEX-PACKAGES
    A vector of package indices.
  • Macro DO-PACKAGES ((package index) &body body)
    Iterate over every package in the index.
  • Macro DO-NODES ((node package-index) &body body)
    Iterate over every node in a package index.
  • Macro DEFINE-PARSER (name (&rest lambda-list) &body body)
    Define a parser.
  • Function PARSE (system-or-list)
    Parse documentation from either a system name or a list of system names.
  • 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.
  • Function EXTRACT-DOCSTRING (body)
    Extract the docstring from the body of a form. Correctly handles bodies where the first form is a declaration.
  • Function DUMP (index)
    Print a tree of the contents of an index to the *standard-output*.

Also exports

  • COMMON-LISP:METHOD-QUALIFIERS