Skip to content

[V] $doc

const $doc: DocDecorator;

@doc attaches a documentation string. Works great with multi-line string literals.

The first argument to @doc is a string, which may contain template parameters, enclosed in braces, which are replaced with an attribute for the type (commonly “name”) passed as the second (optional) argument.

@doc can be specified on any language element — a model, an operation, a namespace, etc.