Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
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 Aug 15 04:27:36 2022 GMT+0.
Next: Systems, Previous: The documentation-utils-extensions Reference Manual, Up: The documentation-utils-extensions Reference Manual [Contents][Index]
Set of extensions for documentation-utils.
Use rich-formatter to format documentation with sections :syntax, :arguments, :examples, :description, :returns, :side-effects, :thread-safety, :affected-by, :see-also and :notes. Gather unformatted input by using rich-aggregating-formatter and *DOCUMENTATION* variable. Find gathered documentation with find-documentation function. Execute code stored in documentation with execute-documentation. See examples in the src/documentation.lisp file. See documentation-utils system for more info.
Tested under SBCL and CCL. Should work on other implementations as well.
Next: Files, Previous: Introduction, Up: The documentation-utils-extensions Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Set of extensions for documentation-utils.
Marek Kochanowicz
Marek Kochanowicz
MIT
0.0.0
documentation-utils (system).
Next: Packages, Previous: Systems, Up: The documentation-utils-extensions Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: documentation-utils-extensions/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
documentation-utils-extensions (system).
Next: documentation-utils-extensions/variables.lisp, Previous: documentation-utils-extensions/documentation-utils-extensions.asd, Up: Lisp [Contents][Index]
documentation-utils-extensions (system).
Next: documentation-utils-extensions/classes.lisp, Previous: documentation-utils-extensions/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
documentation-utils-extensions (system).
Next: documentation-utils-extensions/methods.lisp, Previous: documentation-utils-extensions/variables.lisp, Up: Lisp [Contents][Index]
variables.lisp (file).
documentation-utils-extensions (system).
read-content (reader method).
Next: documentation-utils-extensions/functions.lisp, Previous: documentation-utils-extensions/classes.lisp, Up: Lisp [Contents][Index]
classes.lisp (file).
documentation-utils-extensions (system).
Next: documentation-utils-extensions/documentation.lisp, Previous: documentation-utils-extensions/methods.lisp, Up: Lisp [Contents][Index]
methods.lisp (file).
documentation-utils-extensions (system).
Previous: documentation-utils-extensions/functions.lisp, Up: Lisp [Contents][Index]
functions.lisp (file).
documentation-utils-extensions (system).
Next: Definitions, Previous: Files, Up: The documentation-utils-extensions Reference Manual [Contents][Index]
Packages are listed by definition order.
docs.ext
common-lisp.
Next: Indexes, Previous: Packages, Up: The documentation-utils-extensions Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
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.
Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]
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).
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
automatically generated reader method
Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]
documentation-utils.
documentation-utils.
Previous: Standalone methods, Up: Public Interface [Contents][Index]
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.
Previous: Public Interface, Up: Definitions [Contents][Index]
Stores tree as nested hash-table: type>name>original arguments
Previous: Definitions, Up: The documentation-utils-extensions Reference Manual [Contents][Index]
Jump to: | %
C E F G I M R S |
---|
Jump to: | %
C E F G I M R S |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
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 |
---|