/usr/lib/ocaml/atd/atd_doc.mli is in libatd-ocaml-dev 1.1.2-1build4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | (**
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:
- after the type name on the left-hand side of a type definition
- after the type expression on the right-hand side of a type definition
(but not after any type expression)
- after record field names
- after variant names
Formats:
Currently only one format called "text" is supported:
- Blank lines separate paragraphs.
- [\{\{ \}\}] can be used to enclose inline verbatim text.
- [\{\{\{ \}\}\}] can be used to enclose verbatim text where whitespace
is preserved.
- The backslash character is used to escape special character sequences.
In regular paragraph mode the special sequences are [\ ], [\{\{]
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 inline =
[ `Text of string
| `Code of string ]
(** [`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. *)
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 = [ `Text of block list ]
(** A document is a list of paragraph-like blocks. *)
val parse_text : Atd_ast.loc -> string -> doc
(** Parse the contents of a doc.text annotation. *)
val get_doc : Atd_ast.loc -> Atd_ast.annot -> doc option
(** Get and parse doc data from annotations. *)
val html_of_doc : doc -> string
(** Convert parsed doc into HTML. *)
|