Source file comment.ml

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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
module Path = Paths.Path
module Reference = Paths.Reference
module Identifier = Paths.Identifier

type 'a with_location = 'a Location_.with_location



type style = [
  | `Bold
  | `Italic
  | `Emphasis
  | `Superscript
  | `Subscript
]

type raw_markup_target = [
  | `Html
]

type leaf_inline_element = [
  | `Space
  | `Word of string
  | `Code_span of string
  | `Raw_markup of raw_markup_target * string
]

type non_link_inline_element = [
  | leaf_inline_element
  | `Styled of style * (non_link_inline_element with_location) list
]

(* The cross-referencer stores section heading text, and sometimes pastes it
   into link contents. This type alias is provided for use by the
   cross-referencer. *)
type link_content = (non_link_inline_element with_location) list

type inline_element = [
  | leaf_inline_element
  | `Styled of style * (inline_element with_location) list
  | `Reference of Reference.t * link_content
  | `Link of string * link_content
]

type nestable_block_element = [
  | `Paragraph of (inline_element with_location) list
  | `Code_block of string
  | `Verbatim of string
  | `Modules of Reference.Module.t list
  | `List of
    [ `Unordered | `Ordered ] *
    ((nestable_block_element with_location) list) list
]

type tag = [
  | `Author of string
  | `Deprecated of (nestable_block_element with_location) list
  | `Param of string * (nestable_block_element with_location) list
  | `Raise of string * (nestable_block_element with_location) list
  | `Return of (nestable_block_element with_location) list
  | `See of
      [ `Url | `File | `Document ] *
      string *
      (nestable_block_element with_location) list
  | `Since of string
  | `Before of string * (nestable_block_element with_location) list
  | `Version of string
  | `Canonical of Path.Module.t * Reference.Module.t
  | `Inline
  | `Open
  | `Closed
]

type heading_level = [
  | `Title
  | `Section
  | `Subsection
  | `Subsubsection
  | `Paragraph
  | `Subparagraph
]

type block_element = [
  | nestable_block_element
  | `Heading of heading_level * Identifier.Label.t * link_content
  | `Tag of tag
]

type docs = (block_element with_location) list

type docs_or_stop = [
  | `Docs of docs
  | `Stop
]