doqumen

Yet another Lisp documentation generator, but it's way more dumber than others.

Generate documentation of your Common Lisp system into single output file.

Write docstrings in any format you want to.
Place text files anywhere in the output.
Can support any docstring, input text, output format. (... all you need to do is hack this!)

Introduction

Are you stupid enough just like me do? Goood. 🫠

Too lame to learn those Lisp libraries and tools? Sad. 😂

Then just use this unobtrusive tool. "Here your". 🔨

Rationale

I needed it, but I don't want to use anything else.

Getting Started

Install it: Symlink doqumen.asd and (PROGN (ASDF:CLEAR-CONFIGURATION) (QL:QUICKLOAD :doqumen))

Write seed-plist variable:

(eval-when (:compile-toplevel :load-toplevel :execute)
  ;; Same keyword with name of ASDF-system:
  (setf (get :doqumen :doqumen)
        `(:sections (
                     ,#p"src/01-title.md"
                     :toc     ; <-- Place of TOC
                     (
                      ;; 1st item in a list is heading.
                      ,#p"src/02-intro.md"
                      ;; ...rests are subheadings:
                      ,#p"src/02-a-rationale.md"
                      ,#p"src/02-b-getting-started.md"
                      )
                     :api-ref ; Place API-Refs Here
                     :footer
                     ))))

Write .md files you've mentioned in seed-plist, and docstrings.
Generate: (DOQUMEN:BUILD-DOC :doqumen)
Enjoy the output: docs/index.md

Syntax

Attached property named :DOQUMEN is called "seed plist".
1. could be specified with another property and at another symbol, with (BUILD-DOC :your-system-name :seed-prop-name :ANOTHER-PROP-NAME :seed-symb :OF-ANOTHER-SYMBOL)
The seed plist has only one property :SECTIONS (currently)
The :SECTIONS has a list as its' value in a sense of Lisp Plist
1. for example: (:sections ( .... ))
In the list of :SECTIONS, you could place one of:
1. A pathname of text file.
  - Will be merged with pathname of .asd definition file,
  - Copied into the output file literally.
2. Keywords: :TOC, :API-REF, :FOOTER
  - Doqumen has builtin supports above 3 keywords.
  - will place "Table of Contents", "API References", and the "Footer" in the output respectively.
  - Any other keywords could be placed, see "HACKS" section below.
3. Nested list represents a section and its subsections.
  - for example, for a list of: (:A (:B :B-1 :B-2) :C)
  - will be rendered like:
```
1. A
2. B
   1. B-1
   2. B-2
3. C
```

Hacking

By default, doqumen is:

Emits a single output file.
Assumes the output and the input text files and docstrings in Lisp code are all Markdown formatted.

But can be customized as you want to:

Change the input, docstring, and the output formats as you want to.
Print the link anchors or not.
and Add custom sections in seed plist.

Other than Markdown?

If you want to use other than Markdown format for your docstrings, input text files, and the output text file, customize below variables:

*anchor-uri-encode-func*
*print-anchor-func*
*api-ref-anchor-prefix*
*code-string-func*
*repr-string-func*
*safe-string-func*
*api-refs-anchor*
*api-refs-heading*
*api-refs-title*
*print-api-refs-func*
*print-footer-func*
*print-toc-func*
*section-file-title-func*

Your Own Custom Sections

Do you Remember that :SECTIONS of seed plist has a few special sections like :TOC, :API-REF, and :FOOTER.

You could add your own custom sections, imagine :MEDITATE or something. By writing and exporting functions: DOQUMEN:PRINT-MEDITATE and DOQUMEN:TOC-MEDITATE.

Each function receives required arguments, for more detailed information, please read the code of DOQUMEN:PRINT-FOOTER and DOQUMEN:TOC-FOOTER and try your own hack. Yes, the :FOOTER is implemented in this way.

Also, you could pass any arbitrary additional arguments by writing this:

|MEDITATE (:TEA "Drank")|

The custom section functions PRINT-MEDITATE and TOC-MEDITATE would get ARGS as a list looks like (LIST ... :TEA "Drank").

Supporting

Enjoying this project? Consider supporting its growth via the Ethereum address in my profile.

License

Licensed under the MIT License

Please read the ./LICENSE

APIs

PACKAGE: `DOQUMEN`

FUNCTION: `->KEYWORD`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::VAL)
SETF? NIL

FUNCTION: `->ONE-LINE-STRING`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::VAL)
SETF? NIL

FUNCTION: `->UPCASE`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::VAL)
SETF? NIL

FUNCTION: `API-REFS->TOC`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::API-REFS)
SETF? NIL

FUNCTION: `API-REFS-SORT-TOC-PACKAGES-TEXT-LEXICO`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::PKGS)
SETF? NIL

FUNCTION: `API-REFS-SORT-TOC-PACKAGES`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::SYMBS)
SETF? NIL

Non-destructively sort a list SYMBS with a function *API-REFS-SORT-TOC-PACKAGES-FUNC*, Sorting when the variable is non-NIL.

FUNCTION: `API-REFS-SORT-TOC-SYMBOLS-TEXT-LEXICO`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::SYMBS)
SETF? NIL

FUNCTION: `API-REFS-SORT-TOC-SYMBOLS`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::SYMBS)
SETF? NIL

Non-destructively sort a list SYMBS with a function of *API-REFS-SORT-TOC-SYMBOLS-FUNC*. Sorting when the function is non-NIL.

FUNCTION: `BUILD-DOC`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::SYSTEM-NAME &KEY DOQUMEN::SEED-SYMBOL (DOQUMEN::SEED-PROP-NAME :DOQUMEN) (DOQUMEN::OUTPUT-FILE #P"docs/index.md"))
SETF? NIL

Build it!

FUNCTION: `BUILD-TOC`

SCOPE: INTERNAL
LAMBDA LIST: (&KEY DOQUMEN::SECTIONS)
SETF? NIL

FUNCTION: `BYTES-TO-HEX`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::BYTES)
SETF? NIL

FUNCTION: `CODE-STRING-IN-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

Quote STRING as a code-string in Markdown format

FUNCTION: `CODE-STRING`

SCOPE: EXTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

Quote STRING as a code-literal in output format

FUNCTION: `COPY-FILE-INTO-STREAM`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::IN-FILE DOQUMEN::OUT-STREAM)
SETF? NIL

Copy contents of pathname IN-FILE into OUT-STREAM

FUNCTION: `DIRECTORY-PN`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::PN)
SETF? NIL

Directory pathname from PN

FUNCTION: `ENCLOSE-AS-CODE-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

FUNCTION: `ESCAPE-CODE-TEXT-FOR-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::STR)
SETF? NIL

FUNCTION: `ESCAPE-TEXT-FOR-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::STR)
SETF? NIL

FUNCTION: `EXPAND-API-REFS-FOR-TOC`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::API-REFS)
SETF? NIL

FUNCTION: `EXTRACT-FILE-TITLE`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::PN)
SETF? NIL

Extract the title of file of PN by using *SECTION-FILE-TITLE-FUNC*, if it's NIL, evaluate to just PN.

FUNCTION: `EXTRACT-FIRST-HEADING-FROM-MARKDOWN-FILE`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::PN)
SETF? NIL

FUNCTION: `FIND+APPLY`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::PREFIX DOQUMEN::SYM &KEY DOQUMEN::ARGS (DOQUMEN::PKG (FIND-PACKAGE :DOQUMEN)))
SETF? NIL

Find a function named SYM via SPLIT-SYMBOL-AND-ARGS

Applies ARGS with extra arguments from SPLIT-SYMBOL-AND-ARGS if any available.

FUNCTION: `GATHER-API-REFS`

SCOPE: INTERNAL
LAMBDA LIST: NIL
SETF? NIL

FUNCTION: `INIT-LOGGER`

SCOPE: INTERNAL
LAMBDA LIST: NIL
SETF? NIL

FUNCTION: `MERGE-PN-WITH-ASDF-SYSTEM-PATH`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::PN DOQUMEN::SYSTEM-NAME)
SETF? NIL

Merged pathname PN (relative) with the system definition directory of SYSTEM-NAME

FUNCTION: `PRINT-ANCHOR`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::TEXT DOQUMEN::ANCHOR-URI)
SETF? NIL

Print anchor to the output, unless *PRINT-ANCHOR-FUNC* is NIL

FUNCTION: `PRINT-API-REF`

SCOPE: EXTERNAL
LAMBDA LIST: NIL
SETF? NIL

Print API references to the output, unless *PRINT-API-REFS-FUNC* is NIL

FUNCTION: `PRINT-API-REFS-AS-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::API-REFS)
SETF? NIL

print api-refs as markdown

FUNCTION: `PRINT-FOOTER-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (&REST DOQUMEN::ARGS)
SETF? NIL

FUNCTION: `PRINT-FOOTER`

SCOPE: INTERNAL
LAMBDA LIST: (&REST DOQUMEN::ARGS)
SETF? NIL

FUNCTION: `PRINT-HTML-ANCHOR`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::TEXT DOQUMEN::ANCHOR-URI)
SETF? NIL

FUNCTION: `PRINT-SECTIONS`

SCOPE: INTERNAL
LAMBDA LIST: (&KEY DOQUMEN::SECTIONS)
SETF? NIL

FUNCTION: `PRINT-TOC-AS-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::TOC &KEY (DOQUMEN::LEVEL 1))
SETF? NIL

FUNCTION: `PRINT-TOC`

SCOPE: EXTERNAL
LAMBDA LIST: NIL
SETF? NIL

Print TOC to the output using *PRINT-TOC-FUNC*, if it isn't NIL.

FUNCTION: `REMOVE-NEWLINES`

SCOPE: INTERNAL
LAMBDA LIST: (DOQUMEN::S)
SETF? NIL

FUNCTION: `REPR-STRING-IN-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

Quote STRING as a value repr-string in Markdown format

FUNCTION: `REPR-STRING`

SCOPE: EXTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

Quote STRING as a value repr-literal in output format

FUNCTION: `ROOT-SECTIONS`

SCOPE: EXTERNAL
LAMBDA LIST: NIL
SETF? NIL

FUNCTION: `SAFE-STRING-IN-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

FUNCTION: `SAFE-STRING`

SCOPE: EXTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

Escap STRING in output format

FUNCTION: `SEED-PLIST`

SCOPE: EXTERNAL
LAMBDA LIST: NIL
SETF? NIL

Get seed plist

FUNCTION: `SLUGIFY+MD5HEX`

SCOPE: EXTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

FUNCTION: `SLUGIFY`

SCOPE: EXTERNAL
LAMBDA LIST: (STRING)
SETF? NIL

FUNCTION: `SPLIT-SYMBOL-AND-ARGS`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::SYMB &KEY (DOQUMEN::PKG *PACKAGE*) (DOQUMEN::PREFIX "") (DOQUMEN::SPACE-CHAR #\ ))
SETF? NIL

Split Symbol/Keyword SYMB by SPACE-CHAR => (VALUES SYMB REST-FORM)

(split-symbol-and-args :foo) ;=> (VALUES 'FOO NIL)

(split-symbol-and-args '|foo (list 'aaa 'bbb)|) ;=> (VALUES 'FOO (LIST 'AAA 'BBB))

The first symbol of result values will be interned in PKG and prefixed with PREFIX-string.

FUNCTION: `SYMBOL-SCOPE`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::NAME DOQUMEN::PKG-NAME)
SETF? NIL

Scope of symbol NAME under PKG-NAME. Evaluates as one of :INTERNAL, :EXTERNAL, or :INHERITED

FUNCTION: `SYSTEM-DEFINITION-DIR`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::SYSTEM-NAME)
SETF? NIL

Directory pathname of ASDF system, SYSTEM-NAME

FUNCTION: `TOC-FOOTER`

SCOPE: INTERNAL
LAMBDA LIST: (&REST DOQUMEN::ARGS)
SETF? NIL

GENERIC-FUNCTION: `PRINT-API-REF-BODY-AS-MARKDOWN`

SCOPE: INTERNAL
LAMBDA LIST: (TYPE DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL

MACRO: `TOC-APPENDF`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::PLACE &KEY DOQUMEN::TEXT DOQUMEN::ANCHOR DOQUMEN::CHILDREN)
SETF? NIL

METHOD: `NODE-INFO-LIST` `((NODE CFFI-BITFIELD))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-BITFIELD))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE CFFI-ENUM))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-ENUM))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE CFFI-FUNCTION))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-FUNCTION))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE CFFI-SLOT))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-SLOT))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE CFFI-STRUCT))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-STRUCT))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE CFFI-TYPE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-TYPE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE CFFI-UNION))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-UNION))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE CLASS-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CLASS-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE CLASS-SLOT-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CLASS-SLOT-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE FUNCTION-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:FUNCTION-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE GENERIC-FUNCTION-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:GENERIC-FUNCTION-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE MACRO-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:MACRO-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE METHOD-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:METHOD-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE OPERATOR-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:OPERATOR-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE STRUCT-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:STRUCT-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE STRUCT-SLOT-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:STRUCT-SLOT-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE TYPE-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:TYPE-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `((NODE VARIABLE-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:VARIABLE-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `NODE-INFO-LIST` `(NODE)`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::NODE)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CFFI-BITFIELD)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CFFI-BITFIELD)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CFFI-ENUM)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CFFI-ENUM)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CFFI-FUNCTION)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CFFI-FUNCTION)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CFFI-SLOT)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CFFI-SLOT)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CFFI-STRUCT)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CFFI-STRUCT)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CFFI-TYPE)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CFFI-TYPE)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CFFI-UNION)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CFFI-UNION)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CLASS)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CLASS)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL CLASS-SLOT)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :CLASS-SLOT)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL FUNCTION)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :FUNCTION)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL GENERIC-FUNCTION)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :GENERIC-FUNCTION)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL MACRO)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :MACRO)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL METHOD)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :METHOD)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL STRUCT)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :STRUCT)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL STRUCT-SLOT)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :STRUCT-SLOT)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL TYPE)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :TYPE)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE (EQL VARIABLE)) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE (EQL :VARIABLE)) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `PRINT-API-REF-BODY-AS-MARKDOWN` `((TYPE T) API-REF OUT-STREAM)`

SCOPE: INTERNAL
LAMBDA LIST: ((TYPE T) DOQUMEN::API-REF DOQUMEN::OUT-STREAM)
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CFFI-BITFIELD))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-BITFIELD))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CFFI-ENUM))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-ENUM))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CFFI-FUNCTION))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-FUNCTION))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CFFI-SLOT))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-SLOT))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CFFI-STRUCT))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-STRUCT))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CFFI-TYPE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-TYPE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CFFI-UNION))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CFFI-UNION))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CLASS-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CLASS-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CLASS-SLOT-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CLASS-SLOT-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE CONDITION-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:CONDITION-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE FUNCTION-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:FUNCTION-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE GENERIC-FUNCTION-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:GENERIC-FUNCTION-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE MACRO-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:MACRO-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE METHOD-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:METHOD-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE STRUCT-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:STRUCT-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE STRUCT-SLOT-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:STRUCT-SLOT-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE TYPE-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:TYPE-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `((NODE VARIABLE-NODE))`

SCOPE: EXTERNAL
LAMBDA LIST: ((DOQUMEN::NODE DOCPARSER:VARIABLE-NODE))
SETF? NIL
QUALIFIERS: NIL

METHOD: `TYPE-KEYWORD` `(NODE)`

SCOPE: EXTERNAL
LAMBDA LIST: (DOQUMEN::NODE)
SETF? NIL
QUALIFIERS: NIL

VARIABLE: `ANCHOR-URI-ENCODE-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN:SLUGIFY+MD5HEX

VARIABLE: `API-REF-ANCHOR-PREFIX`

SCOPE: EXTERNAL
INITIAL-VALUE: "API-"

A prefix to be prepended to anchor URI of API reference entries

VARIABLE: `API-REFS`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

Generated API-references (internal data)

VARIABLE: `API-REFS-ANCHOR`

SCOPE: EXTERNAL
INITIAL-VALUE: "API-REFS"

VARIABLE: `API-REFS-HEADING`

SCOPE: EXTERNAL
INITIAL-VALUE: "# APIs"

VARIABLE: `API-REFS-SORT-TOC-PACKAGES-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::API-REFS-SORT-TOC-PACKAGES-TEXT-LEXICO

VARIABLE: `API-REFS-SORT-TOC-SYMBOLS-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::API-REFS-SORT-TOC-SYMBOLS-TEXT-LEXICO

VARIABLE: `API-REFS-TITLE`

SCOPE: EXTERNAL
INITIAL-VALUE: "APIs"

VARIABLE: `CODE-STRING-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::CODE-STRING-IN-MARKDOWN

A function to be used to quote code-string

VARIABLE: `DOCPARSER-INDEX`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

VARIABLE: `OUT-STREAM`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

The output stream

VARIABLE: `OUTPUT-PN`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

The output, pathname

VARIABLE: `PRINT-ANCHOR-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::PRINT-HTML-ANCHOR

VARIABLE: `PRINT-API-REFS-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::PRINT-API-REFS-AS-MARKDOWN

VARIABLE: `PRINT-FOOTER-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::PRINT-FOOTER-MARKDOWN

VARIABLE: `PRINT-TOC-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::PRINT-TOC-AS-MARKDOWN

VARIABLE: `REPR-STRING-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::REPR-STRING-IN-MARKDOWN

A function to be used to quote value repr-string

VARIABLE: `SAFE-STRING-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::SAFE-STRING-IN-MARKDOWN

A function to be used to escape string for an output format

VARIABLE: `SECTION-FILE-TITLE-FUNC`

SCOPE: EXTERNAL
INITIAL-VALUE: #'DOQUMEN::EXTRACT-FIRST-HEADING-FROM-MARKDOWN-FILE

VARIABLE: `SEED-PLIST`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

The seed plist, an entry-data for doc-generation

VARIABLE: `SEED-PROP-NAME`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

A property name (a keyword) in *seed-symbol* to specify *seed-plist*

VARIABLE: `SEED-SYMBOL`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

A symbol/keyword which has a property named as *SEED-PROP-NAME*

VARIABLE: `SYSTEM-NAME`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

Currently specfied ASDF system name (keyword)

VARIABLE: `TOC`

SCOPE: EXTERNAL
INITIAL-VALUE: NIL

VARIABLE: `TOC-ANCHOR`

SCOPE: EXTERNAL
INITIAL-VALUE: "TOC"

VARIABLE: `TOC-HEADING`

SCOPE: EXTERNAL
INITIAL-VALUE: "# Table of Contents"

VARIABLE: `TOC-TITLE`

SCOPE: EXTERNAL
INITIAL-VALUE: "Table of Contents"

Generated with doqumen at 2026-05-18T23:55:56.446124+09:00 by https://github.com/ageldama

Name		Name	Last commit message	Last commit date
Latest commit History 47 Commits
.github		.github
src		src
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
doqumen.asd		doqumen.asd

Folders and files

Latest commit

History

Repository files navigation

doqumen

Table of Contents

Introduction

Rationale

Getting Started

Syntax

Hacking

Other than Markdown?

Your Own Custom Sections

Supporting

License

APIs

PACKAGE: DOQUMEN

FUNCTION: ->KEYWORD

FUNCTION: ->ONE-LINE-STRING

FUNCTION: ->UPCASE

FUNCTION: API-REFS->TOC

FUNCTION: API-REFS-SORT-TOC-PACKAGES-TEXT-LEXICO

FUNCTION: API-REFS-SORT-TOC-PACKAGES

FUNCTION: API-REFS-SORT-TOC-SYMBOLS-TEXT-LEXICO

FUNCTION: API-REFS-SORT-TOC-SYMBOLS

FUNCTION: BUILD-DOC

FUNCTION: BUILD-TOC

FUNCTION: BYTES-TO-HEX

FUNCTION: CODE-STRING-IN-MARKDOWN

FUNCTION: CODE-STRING

FUNCTION: COPY-FILE-INTO-STREAM

FUNCTION: DIRECTORY-PN

FUNCTION: ENCLOSE-AS-CODE-MARKDOWN

FUNCTION: ESCAPE-CODE-TEXT-FOR-MARKDOWN

FUNCTION: ESCAPE-TEXT-FOR-MARKDOWN

FUNCTION: EXPAND-API-REFS-FOR-TOC

FUNCTION: EXTRACT-FILE-TITLE

FUNCTION: EXTRACT-FIRST-HEADING-FROM-MARKDOWN-FILE

FUNCTION: FIND+APPLY

FUNCTION: GATHER-API-REFS

FUNCTION: INIT-LOGGER

FUNCTION: MERGE-PN-WITH-ASDF-SYSTEM-PATH

FUNCTION: PRINT-ANCHOR

FUNCTION: PRINT-API-REF

FUNCTION: PRINT-API-REFS-AS-MARKDOWN

FUNCTION: PRINT-FOOTER-MARKDOWN

FUNCTION: PRINT-FOOTER

FUNCTION: PRINT-HTML-ANCHOR

FUNCTION: PRINT-SECTIONS

FUNCTION: PRINT-TOC-AS-MARKDOWN

FUNCTION: PRINT-TOC

FUNCTION: REMOVE-NEWLINES

FUNCTION: REPR-STRING-IN-MARKDOWN

FUNCTION: REPR-STRING

FUNCTION: ROOT-SECTIONS

FUNCTION: SAFE-STRING-IN-MARKDOWN

FUNCTION: SAFE-STRING

FUNCTION: SEED-PLIST

FUNCTION: SLUGIFY+MD5HEX

FUNCTION: SLUGIFY

FUNCTION: SPLIT-SYMBOL-AND-ARGS

FUNCTION: SYMBOL-SCOPE

FUNCTION: SYSTEM-DEFINITION-DIR

FUNCTION: TOC-FOOTER

GENERIC-FUNCTION: PRINT-API-REF-BODY-AS-MARKDOWN

MACRO: TOC-APPENDF

METHOD: NODE-INFO-LIST ((NODE CFFI-BITFIELD))

METHOD: NODE-INFO-LIST ((NODE CFFI-ENUM))

METHOD: NODE-INFO-LIST ((NODE CFFI-FUNCTION))

METHOD: NODE-INFO-LIST ((NODE CFFI-SLOT))

METHOD: NODE-INFO-LIST ((NODE CFFI-STRUCT))

METHOD: NODE-INFO-LIST ((NODE CFFI-TYPE))

METHOD: NODE-INFO-LIST ((NODE CFFI-UNION))

METHOD: NODE-INFO-LIST ((NODE CLASS-NODE))

METHOD: NODE-INFO-LIST ((NODE CLASS-SLOT-NODE))

METHOD: NODE-INFO-LIST ((NODE FUNCTION-NODE))

METHOD: NODE-INFO-LIST ((NODE GENERIC-FUNCTION-NODE))

METHOD: NODE-INFO-LIST ((NODE MACRO-NODE))

METHOD: NODE-INFO-LIST ((NODE METHOD-NODE))

METHOD: NODE-INFO-LIST ((NODE OPERATOR-NODE))