Module

PuduLangDocgen.Api.Model

View source

Declarations of Pudu modules as documented reference items

Types

Name Description
Parameter One named parameter and its written type
Member A declaration: function, type, trait, constant, field, variant, or method
Implementation A trait implemented for a type, with documented methods
Unit One module: its documentation, imports, declarations, and implementations

Functions

Name Description
isType Whether a member kind names a type-like declaration with a page of its own.
summary The first paragraph of documentation text.
remarks Documentation after its first paragraph.

isType

fn isType(kind: Str) -> Bool

Whether a member kind names a type-like declaration with a page of its own.

Parameters

kind
Str

Returns

Bool

View source

summary

fn summary(doc: Str) -> Str

The first paragraph of documentation text.

Parameters

doc
Str

Returns

Str

View source

remarks

fn remarks(doc: Str) -> Str

Documentation after its first paragraph.

Parameters

doc
Str

Returns

Str

View source