Support for <doc text="..."> annotations:
type foo = Bar of int
<doc text="This type represents foo values.">
This allows code generators to inject the documentation into the generated code.
<doc> nodes that appear in the following positions should be taken into account by code generators that care about documentation:
Formats:
Currently only one format called "text" is supported:
{{ }}
can be used to enclose inline verbatim text.{{{ }}}
can be used to enclose verbatim text where whitespace
is preserved.\
, {{
and {{{
.
In inline verbatim text, special sequences are \
and }}
.
In verbatim text, special sequences are \
and }}}
.Character encoding: UTF-8 is strongly recommended, if not plain ASCII.
`Text
is regular text. `Code
is text that was enclosed
within {{ }}
and should be rendered using the
same fixed-width font used in all verbatim text.