documentable

API Reference

Structs

struct Builtin

A compiler-provided type with documentation but no Talk declaration.

struct Function

The documented shape of a function declaration.

struct Global

The documented shape of a global binding.

struct Method

A documented function attached to a nominal type.

struct Property

The documented shape of a stored property.

struct Variant

The documented shape of an enum variant.

struct Type

The source spelling of a type annotation or generic parameter.

struct Parameter

The documented name and type of a function parameter.

struct Effect

An effect named in a function signature.

Enums

enum Nominal

The nominal declarations currently represented by the documentation model.

enum Documentable

A declaration or signature component stored in the flat documentation graph.