Atd.Doc
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.
type block =
| Paragraph of inline list
| Pre of string
Paragraph
is a regular paragraph. Pre
is preformatted text that was enclosed within \{\{\{ \}\}\}
and should be rendered using a fixed-width font preserving all space and newline characters.
type doc = block list
A document is a list of paragraph-like blocks.
val html_of_doc : doc -> string
Convert parsed doc into HTML.