Module

PuduLangDocgen.Api.Signature

Declarations shown with keywords marked and types linked

Functions

Name	Description
`resolve`	The identity a written type name refers to inside a module, or the empty text. `Alias.Name` resolves through the module's imports; a bare name resolves inside the module first and then as a full identity.
`html`	Declaration HTML for a page: keywords marked, resolvable names linked, the rest escaped. Line breaks and leading indentation of the declaration are kept.

resolve

fn resolve(unit: &Model.Unit, written: Str, references: &Map[Str, Docgen.Reference]) -> Str

The identity a written type name refers to inside a module, or the empty text. Alias.Name resolves through the module's imports; a bare name resolves inside the module first and then as a full identity.

Parameters

unit: &Model.Unit
written: Str
references: &Map[Str, Docgen.Reference]

Returns

Str

View source

html

fn html(unit: &Model.Unit, signature: Str, references: &Map[Str, Docgen.Reference], page: Str) -> Str

Declaration HTML for a page: keywords marked, resolvable names linked, the rest escaped. Line breaks and leading indentation of the declaration are kept.

Parameters

unit: &Model.Unit
signature: Str
references: &Map[Str, Docgen.Reference]
page: Str

Returns

Str

View source