Module

PuduLangDocgen.Api.Sheet

View source

Structured API pages written by any language's converter

Types

Name Description
Rendered The rendered title, body, outline, and findings of a page

Functions

Name Description
render A page from an API page document: `title`, optional `languageId`, and a `body` of blocks named `h1`–`h6`, `api1`–`api4`, `markdown`, `code`, `facts`, `parameters`, `list`, and `inheritance`. Unknown blocks are reported and skipped.

render

fn render(value: &Docgen.Meta, context: &Phrase.Scope) -> Result[Rendered, Str]

A page from an API page document: title, optional languageId, and a body of blocks named h1–h6, api1–api4, markdown, code, facts, parameters, list, and inheritance. Unknown blocks are reported and skipped.

Parameters

value
&Docgen.Meta
context
&Phrase.Scope

Returns

Result[Rendered, Str]

View source