documentation-utils-extensions

API Reference

documentation-utils-extensions

Set of extensions for documentation-utils.

DOCUMENTATION-UTILS-EXTENSIONS

  • Class AGGREGATING-FORMATTER  (DOCUMENTATION-FORMATTER)
    No slots.
  • Class RICH-FORMATTER  (DOCUMENTATION-FORMATTER)
    %DOCUMENTATION-SECTIONS   Reader: READ-DOCUMENTATION-SECTIONS
  • Class RICH-AGGREGATING-FORMATTER  (AGGREGATING-FORMATTER, RICH-FORMATTER)
    No slots.
  • Class DOCUMENTATION-COLLECTION
    %CONTENT   Reader: READ-CONTENT
    Stores tree as nested hash-table: type>name>original arguments
  • Function MAKE-DOCUMENTATION-COLLECTION
  • Variable *DOCUMENTATION*
    nil
  • Variable *DOCUMENTATION-SECTIONS*
    '((:syntax . "syntax:") (:arguments . "arguments:") (:examples . "examples:")
      (:description . "description:") (:responsibilities . "responsibilities:")
      (:collaborators . "collaborators:") (:returns . "returns:")
      (:exceptional-situations . "exceptional situations:")
      (:side-effects . "side effects:") (:affected-by . "affected by")
      (:thread-safety . "thread safety:") (:see-also . "see also:")
      (:notes . "notes:"))
  • Function FIND-DOCUMENTATION (type name)
  • Function CLEAR-DOCUMENTATION
  • Function SELECT-DOCUMENTATION (&key package label type)
  • Function EXECUTE-DOCUMENTATION (&key package label type)