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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
(** Here, we test the rendering of comment markup. *)
(** {1 Sections}
Let's get these done first, because sections will be used to break up the
rest of this test.
Besides the section heading above, there are also
{2 Subsection headings}
and
{3 Sub-subsection headings}
but odoc has banned deeper headings. There are also title headings, but they
are only allowed in mld files.
{3:anchors Anchors}
Sections can have attached {!anchors}, and it is possible to {{!anchors}
link} to them. Links to section headers should not be set in source code
style.
{4 Paragraph}
Individual paragraphs can have a heading.
{5 Subparagraph}
Parts of a longer paragraph that can be considered alone can also have
headings.
{1 Styling}
This paragraph has some styled elements: {b bold} and {i italic},
{b {i bold italic}}, {e emphasis}, {e {e emphasis} within emphasis},
{b {i bold italic}}, super{^script}, sub{_script}. The line spacing should
be enough for superscripts and subscripts not to look odd.
Note: {i In italics {e emphasis} is rendered as normal text while {e
emphasis {e in} emphasis} is rendered in italics.} {i It also work the same
in {{:#} links in italics with {e emphasis {e in} emphasis}.}}
[code] is a different kind of markup that doesn't allow nested markup.
It's possible for two markup elements to appear {b next} {i to} each other
and have a space, and appear {b next}{i to} each other with no space. It
doesn't matter {b how} {i much} space it was in the source: in this
sentence, it was two space characters. And in this one, there is {b a}
{i newline}.
This is also true between {e non-}[code] markup {e and} [code].
Code can appear {b inside [other] markup}. Its display shouldn't be
affected.
{1 Links and references}
This is a {{:#} link}. It sends you to the top of this page. Links can have
markup inside them: {{:#} {b bold}}, {{:#} {i italics}},
{{:#} {e emphasis}}, {{:#} super{^script}}, {{:#} sub{_script}}, and
{{:#} [code]}. Links can also be nested {e {{:#} inside}} markup. Links
cannot be nested inside each other. This link has no replacement text:
{{:#}}. The text is filled in by odoc. This is a shorthand link: {:#}. The
text is also filled in by odoc in this case.
This is a reference to {!foo}. References can have replacement text:
{{!foo} the value foo}. Except for the special lookup support, references
are pretty much just like links. The replacement text can have nested
styles: {{!foo} {b bold}}, {{!foo} {i italic}}, {{!foo} {e emphasis}},
{{!foo} super{^script}}, {{!foo} sub{_script}}, and {{!foo} [code]}. It's
also possible to surround a reference in a style: {b {!foo}}. References
can't be nested inside references, and links and references can't be nested
inside each other.
{1 Preformatted text}
This is a code block:
{[
let foo = ()
(** There are some nested comments in here, but an unpaired comment
terminator would terminate the whole doc surrounding comment. It's
best to keep code blocks no wider than 72 characters. *)
let bar =
ignore foo
]}
There are also verbatim blocks:
{v
The main difference is these don't get syntax highlighting.
v}
{1 Lists}
- This is a
- shorthand bulleted list,
- and the paragraphs in each list item support {e styling}.
+ This is a
+ shorthand numbered list.
- Shorthand list items can span multiple lines, however trying to put two
paragraphs into a shorthand list item using a double line break
just creates a paragraph outside the list.
- Similarly, inserting a blank line between two list items
- creates two separate lists.
{ul
{li To get around this limitation, one
can use explicitly-delimited lists.}
{li This one is bulleted,}}
{ol {li but there is also the numbered variant.}}
{ul
{li
{ul
{li lists}
{li can be nested}
{li and can include references}
{li {!foo}}}}}
{1 Unicode}
The parser supports any ASCII-compatible encoding, in particuλar UTF-8.
{1 Raw HTML}
Raw HTML can be {%html:<input type="text" placeholder="inserted">%} as
inline elements into sentences.
{%html:
<blockquote>
If the raw HTML is the only thing in a paragraph, it is treated as a block
element, and won't be wrapped in paragraph tags by the HTML generator.
</blockquote>
%}
{1 Modules}
{!modules: X}
{!modules: X Y}
{1 Tags}
Each comment can end with zero or more tags. Here are some examples:
@author antron
@deprecated a {e long} time ago
@param foo unused
@raise Failure always
@return never
@see <#> this url
@see 'foo.ml' this file
@see "Foo" this document
@since 0
@before 1.0 it was in b{^e}t{_a}
@version -1 *)
val foo : unit
(** Comments in structure items {b support} {e markup}, t{^o}{_o}. *)
(** Some modules to support references. *)
module X : sig end
module Y : sig end
|
