Common Lisp Package: COM.DVLSOFT.DECLT

The Documentation Extractor from Common Lisp to Texinfo package.

README:

FUNCTION

Public

DECLT (SYSTEM-NAME &KEY (LIBRARY-NAME (STRING-DOWNCASE (SYMBOL-NAME SYSTEM-NAME))) (TEXI-FILE (FORMAT NIL ~A.texi LIBRARY-NAME)) (INFO-FILE (PATHNAME-NAME TEXI-FILE)) INTRODUCTION (SUBTITLE NIL SUBTITLEP) (VERSION NIL VERSIONP) AUTHOR (EMAIL NIL EMAILP) LICENSE (DECLT-NOTICE LONG) COPYRIGHT-DATE CONCLUSION HYPERLINKS &AUX (SYSTEM (FIND-SYSTEM SYSTEM-NAME)) (TEXI-NAME (ESCAPE (FILE-NAMESTRING TEXI-FILE))) (CURRENT-TIME-STRING (ESCAPE (CURRENT-TIME-STRING))))

Generate a reference manual in Texinfo format for ASDF SYSTEM-NAME. - LIBRARY-NAME defaults to SYSTEM-NAME. - TEXI-FILE is the full path to the Texinfo file. Defaults to LIBRARY-NAME.texi. - INFO-FILE is the info file basename sans extension. Defaults is built from TEXI-FILE. - INTRODUCTION is a potential contents for an introduction chapter. - SUBTITLE defaults to the system description. - VERSION defaults to the system version. - AUTHOR and EMAIL defaults are extracted from the system author. - LICENSE defaults to nil (possible values are: :mit, :bsd, :gpl and :lgpl). - DECLT-NOTICE is a small paragraph about automatic manual generatiopn by Declt. Possible values are nil, :short and :long (the default). - COPYRIGHT-DATE defaults to the current year. - CONCLUSION is a potential contents for a conclusion chapter. - HYPERLINKS is whether to create hyperlinks to files or directories in the reference manual. Note that those links being specific to the machine on which the manual was generated, it is preferable to keep it to NIL for creating reference manuals meant to be put online.

NICKNAME-PACKAGE (&OPTIONAL (NICKNAME DECLT))

Add NICKNAME (:DECLT by default) to the :COM.DVLSOFT.DECLT package.

VERSION (&OPTIONAL (TYPE NUMBER))

Return the current version of Declt. TYPE can be one of :number, :short or :long. A version number is computed as major*10000 + minor*100 + patchlevel, leaving two digits for each level. Alpha, beta and rc status are ignored in version numbers. A short version is something like 1.3{a,b,rc}4, or 1.3.4 for patchlevel. Alpha, beta or rc levels start at 1. Patchlevels start at 0 but are ignored in the output, so that 1.3.0 appears as just 1.3. A long version is something like 1.3 {alpha,beta,release candidate,patchlevel} 4 "Release Name". As for the short version, a patchlevel of 0 is ignored in the output.

Private

@ANCHOR (ANCHOR)

Render ANCHOR as an @anchor. ANCHOR is escaped for Texinfo prior to rendering. Rendering is done on *standard-output*.

@DEFGENERICX (NAME LAMBDA-LIST)

Render @deffnx {Generic Function} NAME LAMBDA-LIST on *standard-output*

@DEFMETHODX (NAME LAMBDA-LIST SPECIALIZERS QUALIFIERS)

Render @deffnx {Method} NAME LAMBDA-LIST on *standard-output*. NAME, LAMBDA-LIST, SPECIALIZERS and QUALIFIERS are escaped for Texinfo prior to rendering.

@DEFUNX (NAME LAMBDA-LIST)

Render @defunx NAME LAMBDA-LIST on *standard-output*.

@ITEMIZE-LIST (LIST &KEY RENDERER (KIND @BULLET) (FORMAT ~A) (KEY #'IDENTITY))

Render a LIST of items within an @itemize KIND environment. If RENDERER is non-nil, it must be a function of one argument (every LIST element) that performs the rendering on *standard-output* directly. Otherwise, the rendering is done by calling format, as explained below. - FORMAT is the format string to use for every LIST element. - KEY is a function of one argument (every LIST element) used to provide the necessary arguments to the FORMAT string. If multiple arguments are needed, they should be returned by KEY as multiple values.

ACCESSOR-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

ACCESSOR-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

ACCESSOR-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

ACCESSOR-DEFINITION-WRITER (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

ACCESSOR-METHOD-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

ACCESSOR-METHOD-DEFINITION-METHOD (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

ACCESSOR-METHOD-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

ACCESSOR-METHOD-DEFINITION-WRITER (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

ADD-CATEGORIES-NODE (PARENT CONTEXT STATUS DEFINITIONS)

Add the STATUS DEFINITIONS categories nodes to PARENT in CONTEXT.

ADD-CATEGORY-NODE (PARENT CONTEXT STATUS CATEGORY DEFINITIONS)

Add the STATUS CATEGORY node to PARENT for DEFINITIONS in CONTEXT.

ADD-CHILD (PARENT CHILD &AUX (PREVIOUS (CAR (LAST (NODE-CHILDREN PARENT)))))

Add CHILD node to PARENT node and return CHILD.

ADD-DEFINITION (SYMBOL CATEGORY DEFINITION POOL)

Add CATEGORY kind of DEFINITION for SYMBOL to POOL.

ADD-DEFINITIONS (CONTEXT)

Add all definitions to CONTEXT.

ADD-DEFINITIONS-NODE (PARENT CONTEXT &AUX (DEFINITIONS-NODE (ADD-CHILD PARENT (MAKE-NODE NAME Definitions SYNOPSIS The symbols documentation BEFORE-MENU-CONTENTS (FORMAT NIL ~ Definitions are sorted by export status, category, package, and then by lexicographic order.)))))

Add the definitions node to PARENT in CONTEXT.

ADD-EXTERNAL-DEFINITIONS (CONTEXT)

Add all external definitions to CONTEXT.

ADD-FILES-NODE (PARENT CONTEXT &AUX (SYSTEM (CONTEXT-SYSTEM CONTEXT)) (LISP-FILES (LISP-COMPONENTS SYSTEM)) (OTHER-FILES (MAPCAR (LAMBDA (TYPE) (COMPONENTS SYSTEM TYPE)) '(C-SOURCE-FILE JAVA-SOURCE-FILE DOC-FILE HTML-FILE STATIC-FILE))) (FILES-NODE (ADD-CHILD PARENT (MAKE-NODE NAME Files SYNOPSIS The files documentation BEFORE-MENU-CONTENTS (FORMAT NIL ~ Files are sorted by type and then listed depth-first from the system components tree.)))) (LISP-FILES-NODE (ADD-CHILD FILES-NODE (MAKE-NODE NAME Lisp files SECTION-NAME Lisp))))

Add the files node to PARENT in CONTEXT.

ADD-INTERNAL-DEFINITIONS (CONTEXT)

Add all internal definitions to CONTEXT.

ADD-MODULES-NODE (PARENT CONTEXT &AUX (MODULES (MODULE-COMPONENTS (CONTEXT-SYSTEM CONTEXT))))

Add the modules node to PARENT in CONTEXT.

ADD-PACKAGES-NODE (PARENT CONTEXT &AUX (PACKAGES-NODE (ADD-CHILD PARENT (MAKE-NODE NAME Packages SYNOPSIS The packages documentation BEFORE-MENU-CONTENTS (FORMAT NIL ~ Packages are listed by definition order.)))))

Add the packages node to PARENT in CONTEXT.

ADD-SYMBOL-DEFINITION (SYMBOL CATEGORY POOL)

Add and return the CATEGORY kind of definition for SYMBOL to pool, if any.

ADD-SYMBOL-DEFINITIONS (SYMBOL POOL)

Add all categorized definitions for SYMBOL to POOL.

ADD-SYSTEM-NODE (PARENT CONTEXT)

Add the system node to PARENT in CONTEXT.

ANCHOR (ITEM &OPTIONAL RELATIVE-TO)

Render ITEM's anchor.

ANCHOR-AND-INDEX (ITEM &OPTIONAL RELATIVE-TO)

Anchor and index ITEM.

ANCHOR-NAME (ITEM &OPTIONAL RELATIVE-TO)

Return ITEM's anchor name.

CATEGORY-DEFINITIONS (CATEGORY POOL)

Return all CATEGORY definitions from POOL.

CLASS-DEFINITION-CHILDREN (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASS-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASS-DEFINITION-METHODS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASS-DEFINITION-PARENTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASS-DEFINITION-SLOTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASS-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSOID-DEFINITION-CHILDREN (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSOID-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSOID-DEFINITION-METHODS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSOID-DEFINITION-PARENTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSOID-DEFINITION-SLOTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSOID-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLINDENT (SYMBOL INDENT)

Set SYMBOL's indentation to INDENT in (X)Emacs. This function sets SYMBOL's common-lisp-indent-function property. If INDENT is a symbol, use its indentation definition. Otherwise, INDENT is considered as an indentation definition.

COMPILER-MACRO-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

COMPILER-MACRO-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

COMPONENT-DESCRIPTION (COMPONENT)

Return ASDF COMPONENT's description or nil.

COMPONENT-LONG-DESCRIPTION (COMPONENT)

Return ASDF COMPONENT's long description or nil.

COMPONENT-VERSION (COMPONENT)

Return ASDF COMPONENT's version or nil.

COMPONENTS (MODULE TYPE)

Return the list of all components of (sub)TYPE from ASDF MODULE.

CONDITION-DEFINITION-CHILDREN (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONDITION-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONDITION-DEFINITION-METHODS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONDITION-DEFINITION-PARENTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONDITION-DEFINITION-SLOTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONDITION-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONFIGURATION (KEY)

Return KEY's value in the current Declt configuration.

CONSTANT-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONTEXT-DIRECTORY (CONTEXT)

Return CONTEXT's system directory.

CONTEXT-EXTERNAL-DEFINITIONS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONTEXT-HYPERLINKSP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONTEXT-INTERNAL-DEFINITIONS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONTEXT-PACKAGES (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CONTEXT-SYSTEM (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CURRENT-TIME-STRING

Return the current time as a string.

DEFINITION-SOURCE (OBJECT &AUX (DEFSRC (FIND-DEFINITION-SOURCE OBJECT)))

Return OBJECT's definition source.

DEFINITION-SOURCE-BY-NAME (DEFINITION TYPE &KEY (NAME (DEFINITION-SYMBOL DEFINITION)) &AUX (DEFSRC (CAR (FIND-DEFINITION-SOURCES-BY-NAME NAME TYPE))))

Return DEFINITION's source for TYPE.

DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

DEFINITIONS-POOL-SIZE (POOL)

Return the number of elements in definitions POOL.

ESCAPE (OBJECT &OPTIONAL OTHER-CHARS)

When OBJECT, escape its name for Texinfo. The escaped characters are @, {, } and optionally a list of OTHER-CHARS.

FILE-DEFINITIONS (FILE DEFINITIONS)

Return the subset of DEFINITIONS that belong to FILE.

FILE-NODE (FILE CONTEXT &AUX (RELATIVE-TO (CONTEXT-DIRECTORY CONTEXT)))

Create and return a FILE node in CONTEXT.

FILE-PACKAGES (FILE)

Return the list of all packages defined in FILE.

FINALIZE-DEFINITIONS (POOL1 POOL2)

Finalize the definitions in POOL1 and POOL2. Currently, this means: - resolving classes subclasses, - resolving classes superclasses, - resolving classes direct methods, - resolving slots readers, - resolving slots writers.

FIND-DEFINITION (SYMBOL CATEGORY POOL &OPTIONAL ERRORP)

Find a CATEGORY definition for SYMBOL in POOL. If ERRORP, throw an error if not found. Otherwise, just return NIL.

FIND-GENERIC-WRITER-DEFINITION (NAME POOL)

Find a generic writer definition by NAME in POOL, or return nil. Name must be that of the reader (not the SETF form).

FIND-METHOD-DEFINITION (METHOD POOL)

Find a method definition for METHOD in POOL. Return NIL if not found.

FIND-WRITER-DEFINITION (NAME POOL)

Find a writer definition by NAME in POOL, or return nil. Name must be that of the reader (not the SETF form).

FIRST-WORD-LENGTH (STRING)

Return the length of the first word in STRING. Initial whitespace characters are skipped.

FUNCOID-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

FUNCOID-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

FUNCTION-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

FUNCTION-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

FUNCTION-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-ACCESSOR-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-ACCESSOR-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-ACCESSOR-DEFINITION-METHODS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-ACCESSOR-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-ACCESSOR-DEFINITION-WRITER (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-DEFINITION-METHODS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-WRITER-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-WRITER-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-WRITER-DEFINITION-METHODS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERIC-WRITER-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

I-READER (STREAM SUBCHAR ARG)

Read an argument list for the DEFINDENT macro.

LISP-COMPONENTS (MODULE)

Return the list of all Lisp source file components from ASDF MODULE.

LISP-PATHNAMES (SYSTEM)

Return the list of all ASDF SYSTEM's Lisp source file pathnames. The list includes the system definition file.

MACRO-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

MACRO-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

MAKE-DEFINITIONS-POOL

Create and return a new definitions pool. A definitions pool is a hash table of categorized definitions. Keys must be of the form (NAME :CATEGORY). - NAME is the symbol naming the definition, - :CATEGORY is one listed in +CATEGORIES+.

MAKE-SLOT-DEFINITIONS (CLASS)

Return a list of direct slot definitions for CLASS.

MAPCAN-DEFINITIONS-POOL (FUNCTION POOL)

Like MAPCAN, but work on a definitions POOL.

METHOD-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

METHOD-DEFINITION-METHOD (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

METHOD-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

METHOD-NAME (METHOD &AUX (NAME (GENERIC-FUNCTION-NAME (METHOD-GENERIC-FUNCTION METHOD))))

Return METHOD's name. Return a second value of T if METHOD is a writer method.

MODULE-COMPONENTS (MODULE)

Return the list of all module components from ASDF MODULE.

MODULE-NODE (MODULE CONTEXT &AUX (RELATIVE-TO (CONTEXT-DIRECTORY CONTEXT)))

Create and return a MODULE node in CONTEXT.

NODE-AFTER-MENU-CONTENTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-BEFORE-MENU-CONTENTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-CHILDREN (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-NAME (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-NEXT (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-PREVIOUS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-SECTION-NAME (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-SECTION-TYPE (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-SYNOPSIS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

NODE-UP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

PACKAGE-DEFINITIONS (PACKAGE DEFINITIONS)

Return the subset of DEFINITIONS that belong to PACKAGE.

PACKAGE-EXTERNAL-SYMBOLS (PACKAGE &AUX EXTERNAL-SYMBOLS)

Return the list of external symbols from PACKAGE.

PACKAGE-INTERNAL-SYMBOLS (PACKAGE &AUX (EXTERNAL-SYMBOLS (PACKAGE-EXTERNAL-SYMBOLS PACKAGE)) INTERNAL-SYMBOLS)

Return the list of internal definitions from PACKAGE.

PARSE-AUTHOR-STRING (STRING &AUX (POS-< (POSITION < STRING TEST #'CHAR-EQUAL)) (POS-> (POSITION > STRING TEST #'CHAR-EQUAL)))

Parse STRING as "NAME <EMAIL>". Return NAME and EMAIL as two values.

QUALIFIERS (METHOD)

Return METHOD's qualifiers.

RELATIVE-LOCATION (COMPONENT RELATIVE-TO)

Return COMPONENT's location RELATIVE-TO.

RENDER-@DEFCLASS (CLASS CONTEXT)

Render CLASS's definition in CONTEXT.

RENDER-@DEFCOMPILERMACRO (COMPILER-MACRO CONTEXT)

Render COMPILER-MACRO's definition in CONTEXT.

RENDER-@DEFCOND (CONDITION CONTEXT)

Render CONDITION's definition in CONTEXT.

RENDER-@DEFCONSTANT (CONSTANT CONTEXT)

Render CONSTANT's documentation in CONTEXT.

RENDER-@DEFMAC (MACRO CONTEXT)

Render MACRO's definition in CONTEXT.

RENDER-@DEFMETHOD (METHOD CONTEXT)

Render METHOD's definition in CONTEXT.

RENDER-@DEFMETHODX (READER WRITER CONTEXT)

Render READER and WRITER methods'definitions jointly in CONTEXT.

RENDER-@DEFSLOT (SLOT)

Render SLOT's documentation.

RENDER-@DEFSPECIAL (SPECIAL CONTEXT)

Render SPECIAL variable's documentation in CONTEXT.

RENDER-@DEFSTRUCT (STRUCTURE CONTEXT)

Render STRUCTURE's definition in CONTEXT.

RENDER-@DEFUN (FUNCTION CONTEXT)

Render FUNCTION's definition in CONTEXT.

RENDER-@DEFUNX (READER WRITER CONTEXT)

Render READER and WRITER's definitions jointly in CONTEXT.

RENDER-DEFINITION-CORE (DEFINITION CONTEXT)

Render DEFINITION's documentation core in CONTEXT. The documentation core includes all common definition attributes: - docstring, - package, - source location. Each element is rendered as a table item.

RENDER-DOCSTRING (ITEM)

Render an itemized documentation line for ITEM. Rendering is done on *standard-output*.

RENDER-EXTERNAL-DEFINITIONS-REFERENCES (DEFINITIONS)

Render references to a list of external DEFINITIONS.

RENDER-HEADER (LIBRARY-NAME TEXI-NAME INFO-FILE SUBTITLE VERSION AUTHOR EMAIL LICENSE DECLT-NOTICE COPYRIGHT-DATE CURRENT-TIME-STRING)

Render the header of the Texinfo file.

RENDER-INITARGS (CLASSOID &AUX (INITARGS (CLASS-DIRECT-DEFAULT-INITARGS (FIND-CLASS (CLASSOID-DEFINITION-SYMBOL CLASSOID)))))

Render CLASSOID's direct default initargs.

RENDER-INTERNAL-DEFINITIONS-REFERENCES (DEFINITIONS)

Render references to a list of internal DEFINITIONS.

RENDER-LAMBDA-LIST (LAMBDA-LIST &OPTIONAL SPECIALIZERS &AUX (FIRSTP T) AFTER-REQUIRED-ARGS-P)

Render LAMBDA-LIST with potential SPECIALIZERS. LAMBDA-LIST and SPECIALIZERS are escaped for Texinfo prior to rendering. Rendering is done on *standard-output*.

RENDER-LOCATION (PATHNAME CONTEXT &OPTIONAL (TITLE Location) &AUX (PROBED-PATHNAME (PROBE-FILE PATHNAME)) (RELATIVE-TO (CONTEXT-DIRECTORY CONTEXT)) (HYPERLINKP (AND (CONTEXT-HYPERLINKSP CONTEXT) PROBED-PATHNAME)))

Render an itemized location line for PATHNAME in CONTEXT. Rendering is done on *standard-output*.

RENDER-NODE (NODE LEVEL)

Render NODE at LEVEL and all its children at LEVEL+1.

RENDER-PACKAGES-REFERENCES (PACKAGES)

Render a list of PACKAGES references.

RENDER-REFERENCES (LIST TITLE &AUX (LENGTH (LENGTH LIST)))

Render references to a LIST of items. References are rendered in a table item named TITLE as a list, unless there is only one item in LIST. Rendering is done on *standard-output*.

RENDER-SLOT-PROPERTY (SLOT PROPERTY &KEY (RENDERER (LAMBDA (VALUE) (FORMAT T @t{~A}~% (ESCAPE (FORMAT NIL ~(~S~) VALUE))))) &AUX (VALUE (SLOT-PROPERTY (SLOT-DEFINITION-SLOT SLOT) PROPERTY)))

Render SLOT definition's PROPERTY value as a table item.

RENDER-SLOTS (CLASSOID &AUX (SLOTS (CLASSOID-DEFINITION-SLOTS CLASSOID)))

Render CLASSOID's direct slots documentation.

RENDER-SOURCE (ITEM CONTEXT &AUX (SOURCE (SOURCE ITEM)) (SYSTEM (CONTEXT-SYSTEM CONTEXT)) (RELATIVE-TO (CONTEXT-DIRECTORY CONTEXT)))

Render an itemized source line for ITEM in CONTEXT. Rendering is done on *standard-output*.

RENDER-TEXT (TEXT)

Render TEXT for Texinfo. Rendering is done on *standard-output*. TEXT is assumed to be plain 80 columns. The rendering takes care of escaping the text for Texinfo, and attempts to embellish the output by detecting potential paragraphs from standalone lines.

RENDER-TOP-NODE (NODE)

Render the whole nodes hierarchy starting at toplevel NODE.

RENDER-USE-LIST (LIST TITLE CONTEXT)

Render a package use/used-by LIST with TITLE in CONTEXT.

SAFE-READ (STREAM)

Read once from STREAM protecting against errors.

SLOT-DEFINITION-READERS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

SLOT-DEFINITION-SLOT (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

SLOT-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

SLOT-DEFINITION-WRITERS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

SLOT-PROPERTY (SLOT PROPERTY)

Return SLOT definition's PROPERTY value.

SPECIAL-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

SPECIALIZERS (METHOD)

Return METHOD's specializers.

STRUCTURE-DEFINITION-CHILDREN (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

STRUCTURE-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

STRUCTURE-DEFINITION-METHODS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

STRUCTURE-DEFINITION-PARENTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

STRUCTURE-DEFINITION-SLOTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

STRUCTURE-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

SYMBOL-MACRO-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

SYSTEM-AUTHOR (SYSTEM)

Return ASDF SYSTEM's author or nil.

SYSTEM-BASE-NAME (SYSTEM)

Return the basename part of ASDF SYSTEM's definition file.

SYSTEM-DEFINITION-PATHNAME (X)

Function ASDF:SYSTEM-DEFINITION-PATHNAME is obsolete. It used to expose ASDF internals with subtle differences with respect to user expectations, that have been refactored away since. We recommend you use ASDF:SYSTEM-SOURCE-FILE instead for a mostly compatible replacement that we're supporting, or even ASDF:SYSTEM-SOURCE-DIRECTORY or ASDF:SYSTEM-RELATIVE-PATHNAME if that's whay you mean.

SYSTEM-DIRECTORY (SYSTEM)

Return ASDF SYSTEM's directory.

SYSTEM-EXTERNAL-SYMBOLS (SYSTEM)

Return the list of ASDF SYSTEM's external symbols.

SYSTEM-FILE-NAME (SYSTEM)

Return the name part of ASDF SYSTEM's definition file.

SYSTEM-FILE-TYPE (SYSTEM)

Return the type part of ASDF SYSTEM's definition file.

SYSTEM-INTERNAL-SYMBOLS (SYSTEM)

Return the list of ASDF SYSTEM's internal symbols.

SYSTEM-LICENSE (SYSTEM)

Return ASDF SYSTEM's license or nil.

SYSTEM-MAINTAINER (SYSTEM)

Return ASDF SYSTEM's maintainer or nil.

SYSTEM-NODE (CONTEXT)

Create and return the system node in CONTEXT.

SYSTEM-PACKAGES (SYSTEM)

Return the list of packages defined in ASDF SYSTEM.

SYSTEM-SOURCE-DIRECTORY (SYSTEM-DESIGNATOR)

Return a pathname object corresponding to the directory in which the system specification (.asd file) is located.

TILDE-READER (STREAM CHAR)

Read a series of ~"string" to be concatenated together.

WRITER-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

WRITER-DEFINITION-FUNCTION (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

WRITER-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

WRITER-METHOD-DEFINITION-FOREIGNP (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

WRITER-METHOD-DEFINITION-METHOD (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

WRITER-METHOD-DEFINITION-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

Undocumented

SETFACCESSOR-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFACCESSOR-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

ACCESSOR-DEFINITION-P (OBJECT)

SETFACCESSOR-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFACCESSOR-DEFINITION-WRITER (NEW-VALUE INSTANCE)

SETFACCESSOR-METHOD-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFACCESSOR-METHOD-DEFINITION-METHOD (NEW-VALUE INSTANCE)

ACCESSOR-METHOD-DEFINITION-P (OBJECT)

SETFACCESSOR-METHOD-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFACCESSOR-METHOD-DEFINITION-WRITER (NEW-VALUE INSTANCE)

SETFCLASS-DEFINITION-CHILDREN (NEW-VALUE INSTANCE)

SETFCLASS-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFCLASS-DEFINITION-METHODS (NEW-VALUE INSTANCE)

CLASS-DEFINITION-P (OBJECT)

SETFCLASS-DEFINITION-PARENTS (NEW-VALUE INSTANCE)

SETFCLASS-DEFINITION-SLOTS (NEW-VALUE INSTANCE)

SETFCLASS-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFCLASSOID-DEFINITION-CHILDREN (NEW-VALUE INSTANCE)

SETFCLASSOID-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFCLASSOID-DEFINITION-METHODS (NEW-VALUE INSTANCE)

CLASSOID-DEFINITION-P (OBJECT)

SETFCLASSOID-DEFINITION-PARENTS (NEW-VALUE INSTANCE)

SETFCLASSOID-DEFINITION-SLOTS (NEW-VALUE INSTANCE)

SETFCLASSOID-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFCOMPILER-MACRO-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

COMPILER-MACRO-DEFINITION-P (OBJECT)

SETFCOMPILER-MACRO-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFCONDITION-DEFINITION-CHILDREN (NEW-VALUE INSTANCE)

SETFCONDITION-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFCONDITION-DEFINITION-METHODS (NEW-VALUE INSTANCE)

CONDITION-DEFINITION-P (OBJECT)

SETFCONDITION-DEFINITION-PARENTS (NEW-VALUE INSTANCE)

SETFCONDITION-DEFINITION-SLOTS (NEW-VALUE INSTANCE)

SETFCONDITION-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

CONSTANT-DEFINITION-P (OBJECT)

SETFCONSTANT-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFCONTEXT-EXTERNAL-DEFINITIONS (NEW-VALUE INSTANCE)

SETFCONTEXT-HYPERLINKSP (NEW-VALUE INSTANCE)

SETFCONTEXT-INTERNAL-DEFINITIONS (NEW-VALUE INSTANCE)

CONTEXT-P (OBJECT)

SETFCONTEXT-PACKAGES (NEW-VALUE INSTANCE)

SETFCONTEXT-SYSTEM (NEW-VALUE INSTANCE)

COPY-ACCESSOR-DEFINITION (INSTANCE)

COPY-ACCESSOR-METHOD-DEFINITION (INSTANCE)

COPY-CLASS-DEFINITION (INSTANCE)

COPY-CLASSOID-DEFINITION (INSTANCE)

COPY-COMPILER-MACRO-DEFINITION (INSTANCE)

COPY-CONDITION-DEFINITION (INSTANCE)

COPY-CONSTANT-DEFINITION (INSTANCE)

COPY-CONTEXT (INSTANCE)

COPY-DEFINITION (INSTANCE)

COPY-FUNCOID-DEFINITION (INSTANCE)

COPY-FUNCTION-DEFINITION (INSTANCE)

COPY-GENERIC-ACCESSOR-DEFINITION (INSTANCE)

COPY-GENERIC-DEFINITION (INSTANCE)

COPY-GENERIC-WRITER-DEFINITION (INSTANCE)

COPY-MACRO-DEFINITION (INSTANCE)

COPY-METHOD-DEFINITION (INSTANCE)

COPY-NODE (INSTANCE)

COPY-SLOT-DEFINITION (INSTANCE)

COPY-SPECIAL-DEFINITION (INSTANCE)

COPY-STRUCTURE-DEFINITION (INSTANCE)

COPY-SYMBOL-MACRO-DEFINITION (INSTANCE)

COPY-WRITER-DEFINITION (INSTANCE)

COPY-WRITER-METHOD-DEFINITION (INSTANCE)

DEFINITION-P (OBJECT)

SETFDEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFFUNCOID-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

FUNCOID-DEFINITION-P (OBJECT)

SETFFUNCOID-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFFUNCTION-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFFUNCTION-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

FUNCTION-DEFINITION-P (OBJECT)

SETFFUNCTION-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFGENERIC-ACCESSOR-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFGENERIC-ACCESSOR-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

SETFGENERIC-ACCESSOR-DEFINITION-METHODS (NEW-VALUE INSTANCE)

GENERIC-ACCESSOR-DEFINITION-P (OBJECT)

SETFGENERIC-ACCESSOR-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFGENERIC-ACCESSOR-DEFINITION-WRITER (NEW-VALUE INSTANCE)

SETFGENERIC-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFGENERIC-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

SETFGENERIC-DEFINITION-METHODS (NEW-VALUE INSTANCE)

GENERIC-DEFINITION-P (OBJECT)

SETFGENERIC-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFGENERIC-WRITER-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFGENERIC-WRITER-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

SETFGENERIC-WRITER-DEFINITION-METHODS (NEW-VALUE INSTANCE)

GENERIC-WRITER-DEFINITION-P (OBJECT)

SETFGENERIC-WRITER-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFMACRO-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

MACRO-DEFINITION-P (OBJECT)

SETFMACRO-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

MAKE-ACCESSOR-DEFINITION (&KEY ((SYMBOL DUM338) NIL) ((FUNCTION DUM339) NIL) ((FOREIGNP DUM340) NIL) ((WRITER DUM341) NIL))

MAKE-ACCESSOR-METHOD-DEFINITION (&KEY ((SYMBOL DUM460) NIL) ((FOREIGNP DUM461) NIL) ((METHOD DUM462) NIL) ((WRITER DUM463) NIL))

MAKE-CLASS-DEFINITION (&KEY ((SYMBOL DUM810) NIL) ((FOREIGNP DUM811) NIL) ((PARENTS DUM812) NIL) ((CHILDREN DUM813) NIL) ((METHODS DUM814) NIL) ((SLOTS DUM815) NIL))

MAKE-CLASSOID-DEFINITION (&KEY ((SYMBOL DUM672) NIL) ((FOREIGNP DUM673) NIL) ((PARENTS DUM674) NIL) ((CHILDREN DUM675) NIL) ((METHODS DUM676) NIL) ((SLOTS DUM677) NIL))

MAKE-COMPILER-MACRO-DEFINITION (&KEY ((SYMBOL DUM220) NIL) ((FUNCTION DUM221) NIL))

MAKE-CONDITION-DEFINITION (&KEY ((SYMBOL DUM718) NIL) ((FOREIGNP DUM719) NIL) ((PARENTS DUM720) NIL) ((CHILDREN DUM721) NIL) ((METHODS DUM722) NIL) ((SLOTS DUM723) NIL))

MAKE-CONSTANT-DEFINITION (&KEY ((SYMBOL DUM36) NIL))

MAKE-CONTEXT (&KEY ((SYSTEM DUM0) NIL) ((PACKAGES DUM1) NIL) ((EXTERNAL-DEFINITIONS DUM2) NIL) ((INTERNAL-DEFINITIONS DUM3) NIL) ((HYPERLINKSP DUM4) NIL))

MAKE-DEFINITION (&KEY ((SYMBOL DUM0) NIL))

MAKE-FUNCOID-DEFINITION (&KEY ((SYMBOL DUM144) NIL) ((FUNCTION DUM145) NIL))

MAKE-FUNCTION-DEFINITION (&KEY ((SYMBOL DUM258) NIL) ((FUNCTION DUM259) NIL) ((FOREIGNP DUM260) NIL))

MAKE-GENERIC-ACCESSOR-DEFINITION (&KEY ((SYMBOL DUM586) NIL) ((FUNCTION DUM587) NIL) ((FOREIGNP DUM588) NIL) ((METHODS DUM589) NIL) ((WRITER DUM590) NIL))

MAKE-GENERIC-DEFINITION (&KEY ((SYMBOL DUM502) NIL) ((FUNCTION DUM503) NIL) ((FOREIGNP DUM504) NIL) ((METHODS DUM505) NIL))

MAKE-GENERIC-WRITER-DEFINITION (&KEY ((SYMBOL DUM544) NIL) ((FUNCTION DUM545) NIL) ((FOREIGNP DUM546) NIL) ((METHODS DUM547) NIL))

MAKE-MACRO-DEFINITION (&KEY ((SYMBOL DUM182) NIL) ((FUNCTION DUM183) NIL))

MAKE-METHOD-DEFINITION (&KEY ((SYMBOL DUM380) NIL) ((FOREIGNP DUM381) NIL) ((METHOD DUM382) NIL))

MAKE-NODE (&KEY ((NAME DUM737) NIL) ((SYNOPSIS DUM738) NIL) ((SECTION-TYPE DUM739) NUMBERED) ((SECTION-NAME DUM740) NIL) ((NEXT DUM741) NIL) ((PREVIOUS DUM742) NIL) ((UP DUM743) NIL) ((CHILDREN DUM744) NIL) ((BEFORE-MENU-CONTENTS DUM745) NIL) ((AFTER-MENU-CONTENTS DUM746) NIL))

MAKE-SLOT-DEFINITION (&KEY ((SYMBOL DUM630) NIL) ((SLOT DUM631) NIL) ((READERS DUM632) NIL) ((WRITERS DUM633) NIL))

MAKE-SPECIAL-DEFINITION (&KEY ((SYMBOL DUM72) NIL))

MAKE-STRUCTURE-DEFINITION (&KEY ((SYMBOL DUM764) NIL) ((FOREIGNP DUM765) NIL) ((PARENTS DUM766) NIL) ((CHILDREN DUM767) NIL) ((METHODS DUM768) NIL) ((SLOTS DUM769) NIL))

MAKE-SYMBOL-MACRO-DEFINITION (&KEY ((SYMBOL DUM108) NIL))

MAKE-WRITER-DEFINITION (&KEY ((SYMBOL DUM298) NIL) ((FUNCTION DUM299) NIL) ((FOREIGNP DUM300) NIL))

MAKE-WRITER-METHOD-DEFINITION (&KEY ((SYMBOL DUM420) NIL) ((FOREIGNP DUM421) NIL) ((METHOD DUM422) NIL))

SETFMETHOD-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFMETHOD-DEFINITION-METHOD (NEW-VALUE INSTANCE)

METHOD-DEFINITION-P (OBJECT)

SETFMETHOD-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFNODE-AFTER-MENU-CONTENTS (NEW-VALUE INSTANCE)

SETFNODE-BEFORE-MENU-CONTENTS (NEW-VALUE INSTANCE)

SETFNODE-CHILDREN (NEW-VALUE INSTANCE)

SETFNODE-NAME (NEW-VALUE INSTANCE)

SETFNODE-NEXT (NEW-VALUE INSTANCE)

NODE-P (OBJECT)

SETFNODE-PREVIOUS (NEW-VALUE INSTANCE)

SETFNODE-SECTION-NAME (NEW-VALUE INSTANCE)

SETFNODE-SECTION-TYPE (NEW-VALUE INSTANCE)

SETFNODE-SYNOPSIS (NEW-VALUE INSTANCE)

SETFNODE-UP (NEW-VALUE INSTANCE)

SLOT-DEFINITION-P (OBJECT)

SETFSLOT-DEFINITION-READERS (NEW-VALUE INSTANCE)

SETFSLOT-DEFINITION-SLOT (NEW-VALUE INSTANCE)

SETFSLOT-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFSLOT-DEFINITION-WRITERS (NEW-VALUE INSTANCE)

SPECIAL-DEFINITION-P (OBJECT)

SETFSPECIAL-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFSTRUCTURE-DEFINITION-CHILDREN (NEW-VALUE INSTANCE)

SETFSTRUCTURE-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFSTRUCTURE-DEFINITION-METHODS (NEW-VALUE INSTANCE)

STRUCTURE-DEFINITION-P (OBJECT)

SETFSTRUCTURE-DEFINITION-PARENTS (NEW-VALUE INSTANCE)

SETFSTRUCTURE-DEFINITION-SLOTS (NEW-VALUE INSTANCE)

SETFSTRUCTURE-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SYMBOL-MACRO-DEFINITION-P (OBJECT)

SETFSYMBOL-MACRO-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFWRITER-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFWRITER-DEFINITION-FUNCTION (NEW-VALUE INSTANCE)

WRITER-DEFINITION-P (OBJECT)

SETFWRITER-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

SETFWRITER-METHOD-DEFINITION-FOREIGNP (NEW-VALUE INSTANCE)

SETFWRITER-METHOD-DEFINITION-METHOD (NEW-VALUE INSTANCE)

WRITER-METHOD-DEFINITION-P (OBJECT)

SETFWRITER-METHOD-DEFINITION-SYMBOL (NEW-VALUE INSTANCE)

MACRO

Private

%RENDER-@DEFMETHOD ((METHOD &REST METHODS) CONTEXT)

Render METHOD's definition in CONTEXT. When METHODS, render their definitions jointly.

@DEFCLASS (NAME &BODY BODY)

Execute BODY within a @deftp {Class} NAME environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFCOMPILERMACRO (NAME LAMBDA-LIST &BODY BODY)

Execute BODY within a @deffn {Compiler Macro} NAME LAMBDA-LIST environment. NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFCOND (NAME &BODY BODY)

Execute BODY within a @deftp {Condition} NAME environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFCONSTANT (NAME &BODY BODY)

Execute BODY within a @defvr {Constant} NAME environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFFN ((CATEGORY NAME LAMBDA-LIST &OPTIONAL SPECIALIZERS QUALIFIERS) &BODY BODY)

Execute BODY within a @deffn CATEGORY NAME LAMBDA-LIST environment. CATEGORY, NAME, LAMBDA-LIST, SPECIALIZERS and QUALIFIERS are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFGENERIC (NAME LAMBDA-LIST &BODY BODY)

Execute BODY within a @deffn {Generic Function} NAME LAMBDA-LIST environment. NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFMAC (NAME LAMBDA-LIST &BODY BODY)

Execute BODY within a @defmac NAME LAMBDA-LIST environment. NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFMETHOD (NAME LAMBDA-LIST SPECIALIZERS QUALIFIERS &BODY BODY)

Execute BODY within a @deffn {Method} NAME LAMBDA-LIST environment. NAME, LAMBDA-LIST, SPECIALIZERS and QUALIFIERS are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFSLOT (NAME &BODY BODY)

Execute BODY within a @defvr {Slot} Name environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFSPECIAL (NAME &BODY BODY)

Execute BODY within a @defvr {Special Variable} NAME environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFSTRUCT (NAME &BODY BODY)

Execute BODY within a @deftp {Structure} NAME environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFSYMBOLMACRO (NAME &BODY BODY)

Execute BODY within a @defvr {Symbol Macro} NAME environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFTP (CATEGORY NAME &BODY BODY)

Execute BODY within a @deftp {CATEGORY} NAME environment. CATEGORY and NAME are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFUN (NAME LAMBDA-LIST &BODY BODY)

Execute BODY within a @defun NAME LAMBDA-LIST environment. NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@DEFVR (CATEGORY NAME &BODY BODY)

Execute BODY within a @defvr {CATEGORY} NAME environment. CATEGORY and NAME are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.

@ITEM (&BODY BODY)

Execute BODY within an itemize @item. BODY should render on *standard-output*.

@ITEMIZE ((&OPTIONAL (KIND @BULLET)) &BODY BODY)

Execute BODY within an @itemize KIND environment. BODY should render on *standard-output*.

@MULTITABLE ((&REST FRACTIONS) &BODY BODY)

Execute BODY within a @multitable environment. FRACTIONS is the list of column fractions to use. BODY should render on *standard-output*.

@TABLE ((&OPTIONAL (KIND @STRONG)) &BODY BODY)

Execute BODY within a @table KIND environment. BODY should render on *standard-output*.

@TABLEITEM (TITLE &BODY BODY)

Execute BODY within a table @item TITLE. BODY should render on *standard-output*.

DEFINDENT (SYMBOL INDENT)

Set SYMBOL's indentation to INDENT in (X)Emacs. SYMBOL and INDENT need not be quoted. See CLINDENT for more information.

ENDPUSH (OBJECT PLACE)

Push OBJECT at the end of PLACE.

IN-READTABLE (NAME)

Set the current readtable to the value of NAME::*READTABLE*.

RENDER-@DEFCLASSOID (KIND CLASSOID CONTEXT &BODY BODY)

Render CLASSOID's definition of KIND in CONTEXT.

RENDER-@DEFGENERIC (GENERIC CONTEXT &BODY BODY)

Render GENERIC's definition in CONTEXT.

RENDER-@DEFGENERICX (READER WRITER CONTEXT &BODY BODY)

Render generic READER and WRITER's definitions jointly in CONTEXT.

RENDER-@DEFSYMBOLMACRO (SYMBOL-MACRO CONTEXT &BODY BODY)

Render SYMBOL-MACRO's documentation in CONTEXT.

RENDER-@DEFUNOID (KIND (FUNCOID &REST FUNCOIDS) CONTEXT &BODY BODY)

Render FUNCOID's definition of KIND in CONTEXT. When FUNCOIDS, render their definitions jointly.

RENDER-@DEFVAROID (KIND VAROID CONTEXT &BODY BODY)

Render VAROID's definition of KIND in CONTEXT.

RENDER-TO-STRING (&BODY BODY)

Execute BODY with *standard-output* redirected to a string. Return that string.

Undocumented

DEFINE-CONSTANT (NAME VALUE &OPTIONAL DOC)

GENERIC-FUNCTION

Private

COMPONENT-PATHNAME (COMPONENT)

Extracts the pathname applicable for a particular component.

COMPONENT-RELATIVE-PATHNAME (COMPONENT)

Returns a pathname for the component argument intended to be interpreted relative to the pathname of that component's parent. Despite the function's name, the return value may be an absolute pathname, because an absolute pathname may be interpreted relative to another pathname in a degenerate way.

DEFINITION-FILE-DEFINITIONS (DEFINITION FILE)

Return the list of definitions from DEFINITION that belong to FILE.

DEFINITION-PACKAGE-DEFINITIONS (DEFINITION PACKAGE)

Return the list of definitions from DEFINITION that belong to PACKAGE.

DOCSTRING (ITEM)

Return ITEM's docstring (Lisp documentation).

DOCUMENT (ITEM CONTEXT)

Render ITEM's documentation in CONTEXT.

INDEX (ITEM &OPTIONAL RELATIVE-TO)

Render ITEM's indexing command.

LAMBDA-LIST (DEFINITION)

Return DEFINITION's lambda-list.

NAME (OBJECT)

Return OBJECT's name as a string.

PRETTY-SPECIALIZER (SPECIALIZER)

Return a printable form of SPECIALIZER.

READER-DEFINITIONS (SLOT POOL1 POOL2)

Return a list of reader definitions for SLOT.

REFERENCE (ITEM &OPTIONAL RELATIVE-TO)

Render ITEM's reference.

SOURCE (ITEM)

Return ITEM's definition source pathname.

TITLE (ITEM &OPTIONAL RELATIVE-TO)

Return ITEM's title.

TYPE-NAME (ITEM)

Return ITEM's type name.

WRITER-DEFINITIONS (SLOT POOL1 POOL2)

Return a list of writer definitions for SLOT.

Undocumented

FIND-SYSTEM (SYSTEM &OPTIONAL ERROR-P)

SLOT-ACCESSOR

Private

COMPONENT-NAME (OBJECT)

Component name: designator for a string composed of portable pathname characters

SETFCOMPONENT-NAME (NEW-VALUE OBJECT)

Component name: designator for a string composed of portable pathname characters

Undocumented

COMPONENT-PARENT (OBJECT)

VARIABLE

Private

*READTABLE*

The Declt readtable.

CLASS

Private

ACCESSOR-DEFINITION

Structure for accessor function definitions. This structure holds the writer function definition.

ACCESSOR-METHOD-DEFINITION

Structure for accessor method definitions. This structure holds the writer method definition.

CLASS-DEFINITION

Structure for class definitions. This structure holds the direct superclasses and direct subclasses definitions.

CLASSOID-DEFINITION

Base structure for class-like (supporting inheritance) values. This structure holds links to the direct ancestors and descendants definitions, direct methods definitions, direct slots, and also a slot for marking foreign definitions, i.e. those which do pertain to the system being documented. Foreign definitions may appear as part of an inheritance documentation.

COMPILER-MACRO-DEFINITION

Structure for compiler macro definitions.

CONDITION-DEFINITION

Structure for condition definitions.

CONSTANT-DEFINITION

Structure for constant definitions.

CONTEXT

The documentation context structure.

DEFINITION

Base structure for definitions named by symbols. This structure holds the symbol naming the definition.

FUNCOID-DEFINITION

Base structure for definitions of functional values. This structure holds the the function, generic function or macro function object.

FUNCTION-DEFINITION

Structure for ordinary function definitions. This structure holds a slot for marking foreign definitions, i.e. those which do pertain to the system being documented.

GENERIC-ACCESSOR-DEFINITION

Structure for generic accessor function definitions. This structure holds the generic writer function definition.

GENERIC-DEFINITION

Structure for generic function definitions. This structure holds the list of method definitions and also a slot for marking foreign definitions, i.e. those which do pertain to the system being documented.

GENERIC-WRITER-DEFINITION

Structure for generic writer function definitions.

MACRO-DEFINITION

Structure for macro definitions.

METHOD-DEFINITION

Base structure for method definitions. This structure holds the method object and also a slot for marking foreign definitions, i.e. those which do pertain to the system being documented.

NODE

The NODE structure. This structure holds Texinfo nodes.

SLOT-DEFINITION

Structure for slot definitions. This structure holds the slot object and the readers and writers definitions.

SPECIAL-DEFINITION

Structure for special variables definitions.

STRUCTURE-DEFINITION

Structure for structure definition.

SYMBOL-MACRO-DEFINITION

Structure for symbol macro definitions.

WRITER-DEFINITION

Structure for ordinary writer function definitions.

WRITER-METHOD-DEFINITION

Structure for writer method definitions.

CONSTANT

Public

+RELEASE-MAJOR-LEVEL+

The major level of this release.

+RELEASE-MINOR-LEVEL+

The minor level of this release.

+RELEASE-NAME+

The name of this release.

+RELEASE-STATUS+

The status of this release.

+RELEASE-STATUS-LEVEL+

The status level of this release.

Private

+CATEGORIES+

The list of definition categories. Each category is of type (:KEYWORD DESCRIPTION-STRING).

+SECTION-NAMES+

The numbered, unumbered and appendix section names sorted by level.

Undocumented

+LICENSES+