#docblock API reference

A Jennifer doc-comment parser. Read Jennifer source and return the documentation embedded in it as structured, typed values. It produces data; it does not render (turning docs into HTML is a separate consumer). A doc comment opens with a doc-block marker, and its body is a summary line, an optional description, and tag lines; it immediately precedes the construct it documents (func, def struct, def enum, def const) or, when it carries a module tag, is the file preamble. export is read from the construct keyword, not a tag. Types are written verbatim in Jennifer syntax inside braces. The module reports, never enforces: signature mismatches (a documented name that names no real parameter, a parameter with no doc) and orphaned comments surface as Diagnostic values, and the caller decides what is fatal.

Import with import "docblock.j" as docblock;. See the docblock guide for prose and examples.

#Functions

#docblock.parse(source as string)

Read Jennifer source and return a FileDoc: the module preamble, one doc per func / struct / const, and any diagnostics (mismatched or orphaned doc comments). It reports; it does not fail on a documentation error.

Parameters

• source {string} - the Jennifer source text to parse

Returns {FileDoc} - the extracted documentation tree

#Structs

#docblock.ConstDoc

The documentation of one constant.

#docblock.Diagnostic

A reported documentation problem (a mismatch or an orphaned comment).

#docblock.EnumDoc

The documentation of one enum (sum type). Enum variants are described in the summary / description prose rather than with per-variant tags, so an EnumDoc carries no field list.

#docblock.FileDoc

The full documentation extracted from one source file.

#docblock.FuncDoc

The documentation of one method.

#docblock.ModuleDoc

The module preamble documentation (the doc comment carrying a module tag).

#docblock.ParamDoc

One documented parameter or struct field.

#docblock.ReturnDoc

A documented return value.

#docblock.StructDoc

The documentation of one struct.

#docblock.ThrowDoc

A documented thrown error.