Module
PuduLangDocgen.Build.Overwrite
Sections that amend documented identities from separate files
Types
| Name | Description |
|---|---|
Section |
One amendment: target identity, metadata, and Markdown content |
Functions
| Name | Description |
|---|---|
parse |
The sections of an overwrite file. A header is a `---` block whose YAML is a mapping with a `uid`; a later block whose YAML is not a mapping stays Markdown. A key whose value is `*content` receives the section's Markdown instead of the body. |
metaFor |
Metadata the sections give an identity, later sections winning. |
units |
Modules with their declarations' documentation amended: content aimed at `summary` or `remarks` replaces that part, content aimed at `example` adds an example section, and content aimed at nothing is added after the existing documentation. |
parse
fn parse(path: Str, text: Str) -> (Array[Section], Array[Docgen.Diagnostic])The sections of an overwrite file. A header is a --- block whose YAML is a mapping with a
uid; a later block whose YAML is not a mapping stays Markdown. A key whose value is
*content receives the section's Markdown instead of the body.
Parameters
pathStrtextStr
Returns
(Array[Section], Array[Docgen.Diagnostic])
metaFor
fn metaFor(sections: &Array[Section], uid: Str) -> Array[(Str, Docgen.Meta)]Metadata the sections give an identity, later sections winning.
Parameters
sections&Array[Section]uidStr
Returns
Array[(Str, Docgen.Meta)]
units
fn units(all: &Array[Model.Unit], sections: &Array[Section]) -> Array[Model.Unit]Modules with their declarations' documentation amended: content aimed at summary or
remarks replaces that part, content aimed at example adds an example section, and
content aimed at nothing is added after the existing documentation.
Parameters
all&Array[Model.Unit]sections&Array[Section]
Returns
Array[Model.Unit]