This is the documentation-utils-extensions Reference Manual, version 0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:18:44 2024 GMT+0.
documentation-utils-extensions/documentation-utils-extensions.asddocumentation-utils-extensions/package.lispdocumentation-utils-extensions/variables.lispdocumentation-utils-extensions/classes.lispdocumentation-utils-extensions/methods.lispdocumentation-utils-extensions/functions.lispdocumentation-utils-extensions/documentation.lispThe main system appears first, followed by any subsystem dependency.
documentation-utils-extensionsSet of extensions for documentation-utils.
Marek Kochanowicz
Marek Kochanowicz
MIT
0.0.0
documentation-utils (system).
package.lisp (file).
variables.lisp (file).
classes.lisp (file).
methods.lisp (file).
functions.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
documentation-utils-extensions/documentation-utils-extensions.asddocumentation-utils-extensions/package.lispdocumentation-utils-extensions/variables.lispdocumentation-utils-extensions/classes.lispdocumentation-utils-extensions/methods.lispdocumentation-utils-extensions/functions.lispdocumentation-utils-extensions/documentation.lispdocumentation-utils-extensions/documentation-utils-extensions.asddocumentation-utils-extensions (system).
documentation-utils-extensions/package.lispdocumentation-utils-extensions (system).
documentation-utils-extensions/variables.lisppackage.lisp (file).
documentation-utils-extensions (system).
*documentation* (special variable).
*documentation-sections* (special variable).
documentation-utils-extensions/classes.lispvariables.lisp (file).
documentation-utils-extensions (system).
aggregating-formatter (class).
documentation-collection (class).
make-documentation-collection (function).
read-documentation-sections (reader method).
rich-aggregating-formatter (class).
rich-formatter (class).
read-content (reader method).
documentation-utils-extensions/methods.lispclasses.lisp (file).
documentation-utils-extensions (system).
format-documentation (method).
format-documentation (method).
reinitialize-instance (method).
%clear-documentation (generic function).
%find-documentation (generic function).
%select-documentation (generic function).
format-to-stream (generic function).
insert-documentation (generic function).
documentation-utils-extensions/functions.lispmethods.lisp (file).
documentation-utils-extensions (system).
clear-documentation (function).
execute-documentation (function).
find-documentation (function).
select-documentation (function).
documentation-utils-extensions/documentation.lispfunctions.lisp (file).
documentation-utils-extensions (system).
Packages are listed by definition order.
documentation-utils-extensionsdocs.ext
common-lisp.
*documentation* (special variable).
*documentation-sections* (special variable).
aggregating-formatter (class).
clear-documentation (function).
documentation-collection (class).
execute-documentation (function).
find-documentation (function).
make-documentation-collection (function).
read-documentation-sections (generic reader).
rich-aggregating-formatter (class).
rich-formatter (class).
select-documentation (function).
%clear-documentation (generic function).
%find-documentation (generic function).
%select-documentation (generic function).
format-to-stream (generic function).
insert-documentation (generic function).
read-content (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Examples:
–Disable gathering, (defparameter docs.ext:*documentation* nil)
–Enable gathering, (defparameter docs.ext:*documentation* (docs.ext:make-documentation-collection))
Description:
Alist used by RICH-FORMATTER to determine sections of documentation. Maps symbols to section names.. RICH-FORMATTER will always use order of formatting identical to that provided by this list.
Description:
Removes everything from *DOCUMENTATION*. Does nothing if *DOCUMENTATION* is bound to nil.
Description:
Calls SELECT-DOCUMENTATION first, then attempts to read-from-string, compile and execute each result. Works with sections containing pure strings as well as lists of strings. In the second case, whole paragraph is executed in one go.
Returns:
Always nil
Exceptional situations:
Does not attempt to handle errors signaled by either read or compile. Simply assumes that paragraph should contain valid Lisp code.
Notes:
This function is used most often with respect to :EXAMPLES section.
Arguments:
–TYPE, Type, as specified by documentation-utils.
–NAME, Name, as specified by documentation-utils.
Description:
Attempts to find aggregated documentation. Will fail if *DOCUMENTATION* is bound to nil, or there is no object of type and name in it.
Returns:
–FIRST, Arguments, as passed to the formatter. NIL if not found.
–SECOND, Boolean. T if documentation was found, NIL otherwise.
Description:
Selects all sections with LABEL from *documentation* documenting object named by symbols from PACKAGE and TYPE. LABEL, PACKAGE and TYPE may be: just a symbol, list of symbols (will return union) or nil (will disable filtering).
rich-formatter)) ¶automatically generated reader method
aggregating-formatter) type name arguments) ¶documentation-utils.
rich-formatter) type name (arguments list)) ¶documentation-utils.
documentation-collection) &rest initargs) ¶Description:
Use subclass of this formatter to enable documentation gathering into *DOCUMENTATION*
Notes:
Existing format-documentation specialization uses :after specializer. This approach is condition safe.
documentation-formatter.
Description:
Class used to map type and name to arguments of define-docs.
Notes:
See MAKE-DOCUMENTATION-COLLECTION, *DOCUMENTATION* and FIND-DOCUMENTATION for more information.
Stores tree as nested hash-table: type>name>original arguments
hash-table
(make-hash-table)
This slot is read-only.
Description:
Combines rich-formatter and aggregating formatter into one class.
Description:
Subclass of documentation-formatter, with rich formatting arguments. Those include: :arguments, :examples, :description, :returns, :side-effects and :notes.
Notes:
–Will simply ignore unknown arguments.
–Values passed may be in the form of strings, or lists.
–Nested lists (just first level) are printed using (format stream " –~{~a~^, ~}~%" x).
–Above is handy when specifing (for instance) :arguments. First element of list may designate argument name, second can contain description of the argument.
documentation-formatter.
documentation-utils-extensions:*documentation-sections*
:documentation-sections
This slot is read-only.
(eql nil))) ¶documentation-collection)) ¶(eql nil)) type name) ¶documentation-collection) type name) ¶documentation-collection) package label type) ¶(eql nil)) package label type) ¶list) first-item) ¶rich-formatter) stream (section-name string) arguments first-item) ¶string) first-item) ¶(eql nil)) type name arguments) ¶documentation-collection) type name arguments) ¶documentation-collection)) ¶Stores tree as nested hash-table: type>name>original arguments
| Jump to: | %
C E F G I M R S |
|---|
| Jump to: | %
C E F G I M R S |
|---|
| Jump to: | %
*
S |
|---|
| Jump to: | %
*
S |
|---|
| Jump to: | A C D F M P R S V |
|---|
| Jump to: | A C D F M P R S V |
|---|