This is the charje.documentation Reference Manual, version 0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:34:47 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
charje.documentationDocumentation is an opinionated yet customizable docstring parsing library.
Charles Jackson <charles.b.jackson@protonmail.com>
AGPL V3 or any later version
0.0.0
alexandria (system).
src (module).
Modules are listed depth-first from the system components tree.
charje.documentation/srccharje.documentation (system).
package.lisp (file).
main.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
charje.documentation/charje.documentation.asdcharje.documentation/src/package.lispcharje.documentation/src/main.lispcharje.documentation/charje.documentation.asdcharje.documentation (system).
charje.documentation/src/main.lisppackage.lisp (file).
src (module).
defdocstring (macro).
define-docstring-parser (macro).
description (class).
descriptions (reader method).
do-sections (macro).
full (class).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
parameter-description (method).
parameter-descriptions (reader method).
parameter-descriptions (class).
parse (function).
parse-section (function).
remains (reader method).
(setf remains) (writer method).
synopsis (reader method).
synopsis (class).
docstring (class).
parameter-description-parts (function).
parameter-name-p (function).
(setf raw-descriptions) (writer method).
(setf raw-synopsis) (writer method).
skip-whitespace (function).
whitespacep (function).
Packages are listed by definition order.
charje.documentationcommon-lisp.
defdocstring (macro).
define-docstring-parser (macro).
description (class).
descriptions (generic reader).
do-sections (macro).
full (class).
parameter-description (generic function).
parameter-descriptions (generic reader).
parameter-descriptions (class).
parse (function).
parse-section (function).
remains (generic reader).
(setf remains) (generic writer).
synopsis (generic reader).
synopsis (class).
docstring (class).
parameter-description-parts (function).
parameter-name-p (function).
(setf raw-descriptions) (generic writer).
(setf raw-synopsis) (generic writer).
skip-whitespace (function).
whitespacep (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define a docstring parser to be used in ‘parse’ or ‘defdocstring’.
NAME: The name of class resulting class.
PARTS: The docstring parsers in the order they should be
parsed. This should be the same order that the sections appear in
the docstrings.
Define a docstring parser mixin class for use in ‘parse’ and ‘defdocstring’.
NAME: The name of the docstring parser. NAME is also bound in the
BODY as the docstring object.
SLOTS: A list of slots defined exactly as if for ‘defclass’. Any
methods defined by the slots will be available in BODY.
BODY: Code to parse a docstring. The docstring to be
parsed is in (remains NAME). It should be parsed into the SLOTS.
This is just to reduce the boiler plate of ‘defclass’ and
‘defmethod’ for ‘initialize-instance’. If you need something like a
meta class feel free to just define a class and an
‘initialize-instance’ method.
Parse sections in DOCSTRING until there are none left.
SECTION-NAME: The name of the parsed section. It is lexically bound in BODY.
DOCSTRING: The docstring object to operate on.
BODY: Code to do something with SECTION-NAME. Usually process it
and or store it into one of the slots of DOCSTRING.
At the each iteration, the current section (SECTION-NAME) is
considered consumed. If at any point you want to end parsing and
consider the current section not consumed, simply ‘return’.
This macro also updates the ‘remains’ of DOCSTRING to no longer
include the consumed sections.
This macro is for parsing multiple sections at once. For parsing a single section, see the more primitive ‘parse-section’.
Parse DOCSTRING into a docstring object according to the docstring
parser TYPE.
TYPE: The docstring parser as defined by ‘defdocstring’ and
‘define-docstring-parser’.
DOCSTRING: the raw docstring to be parsed.
Parse a section out of DOCSTRING. Return (values section section-end).
DOCSTRING: The raw docstring to be partially parsed.
The first return value, section, is a string of the section. The
second return value, section-end, is the number of characters
parsed; it is effectively the length of the section.
Sections are separated by two consecutive ‘#newline’. A single ‘#newline’ followed by any whitespace will be reduced to a single ‘#space’ in the result.
description)) ¶automatically generated reader method
parameter-descriptions) (name symbol)) ¶Return the description of the symbol NAME according to DOCSTRING.
parameter-descriptions)) ¶automatically generated reader method
synopsis) &rest initargs0 &key &allow-other-keys) ¶description) &rest initargs0 &key &allow-other-keys) ¶parameter-descriptions) &rest initargs0 &key &allow-other-keys) ¶description)) ¶automatically generated writer method
| Jump to: | (
D F G I M P R S W |
|---|
| Jump to: | (
D F G I M P R S W |
|---|
| Jump to: | D P R S |
|---|
| Jump to: | D P R S |
|---|
| Jump to: | C D F M P S |
|---|
| Jump to: | C D F M P S |
|---|