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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
|
(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* Sebastien Hinderer, projet Cambium, INRIA Paris *)
(* *)
(* Copyright 2022 Institut National de Recherche en Informatique et *)
(* en Automatique. *)
(* *)
(* All rights reserved. This file is distributed under the terms of *)
(* the GNU Lesser General Public License version 2.1, with the *)
(* special exception on linking described in the file LICENSE. *)
(* *)
(**************************************************************************)
(** Generation of Texinfo documentation. *)
val esc_8bits : bool ref
val info_section : string ref
val info_entry : string list ref
val titles_and_headings : (int * (string * string)) list ref
type subparts =
[ `Class of Odoc_info.Class.t_class
| `Class_type of Odoc_info.Class.t_class_type
| `Module of Odoc_info.Module.t_module
| `Module_type of Odoc_info.Module.t_module_type ]
type indices =
[ `Class
| `Class_att
| `Class_type
| `Exception
| `Extension
| `Method
| `Module
| `Module_type
| `Type
| `Value ]
module Generator :
sig
class texi :
object
val bullet : Odoc_info.text_element
val mutable indices_to_build :
[ `Class
| `Class_att
| `Class_type
| `Exception
| `Extension
| `Method
| `Module
| `Module_type
| `Type
| `Value ] list
val linebreak : Odoc_info.text_element
val maxdepth : int
val minus : Odoc_info.text_element
val node_tbl : (Odoc_info.Name.t, unit) Hashtbl.t
val mutable tag_functions :
(string * (Odoc_info.text -> Odoc_info.text)) list
method do_index :
[ `Class
| `Class_att
| `Class_type
| `Exception
| `Extension
| `Method
| `Module
| `Module_type
| `Type
| `Value ] -> unit
method escape : Odoc_info.Name.t -> Odoc_info.Name.t
method private fix_linebreaks : Odoc_info.text -> Odoc_info.text
method fixedblock :
Odoc_info.text_element list -> Odoc_info.text_element
method generate : Odoc_info.Module.t_module list -> unit
method generate_class_inheritance_info :
out_channel -> Odoc_info.Class.t_class -> unit
method generate_class_type_inheritance_info :
out_channel -> Odoc_info.Class.t_class_type -> unit
method generate_for_class :
out_channel -> Odoc_info.Class.t_class -> unit
method generate_for_class_type :
out_channel -> Odoc_info.Class.t_class_type -> unit
method generate_for_module :
out_channel -> Odoc_info.Module.t_module -> unit
method generate_for_module_type :
out_channel -> Odoc_info.Module.t_module_type -> unit
method generate_inheritance_info :
out_channel -> Odoc_info.Class.inherited_class list -> unit
method generate_texi_header :
out_channel -> string -> Odoc_info.Module.t_module list -> unit
method generate_texi_trailer : out_channel -> unit
method heading : int -> Odoc_info.text -> string
method index : indices -> Odoc_info.Name.t -> Odoc_info.text_element
method label : ?no_:bool -> string -> string
method node : int -> Odoc_info.Name.t -> Odoc_info.text_element
method normal_class_params :
Odoc_info.Name.t -> Odoc_info.Class.t_class -> string
method normal_class_type :
Odoc_info.Name.t -> Types.class_type -> string
method normal_class_type_param_list :
Odoc_info.Name.t -> Types.type_expr list -> string
method normal_cstr_args :
?par:bool ->
Odoc_info.Name.t -> Odoc_info.Type.constructor_args -> string
method normal_module_type :
?code:string -> Odoc_info.Name.t -> Types.module_type -> string
method normal_type : Odoc_info.Name.t -> Types.type_expr -> string
method normal_type_list :
?par:bool ->
Odoc_info.Name.t -> string -> Types.type_expr list -> string
method relative_idents : Odoc_info.Name.t -> string -> string
method relative_module_idents : Odoc_info.Name.t -> string -> string
method scan_for_index : subparts -> unit
method scan_for_index_in_class :
Odoc_info.Class.class_element -> unit
method scan_for_index_in_mod :
Odoc_info.Module.module_element -> unit
method private soft_fix_linebreaks :
int -> Odoc_info.text_element list -> Odoc_info.text_element list
method string_of_type_args :
Odoc_info.Type.constructor_args -> Types.type_expr option -> string
method string_of_type_parameters : Odoc_info.Type.t_type -> string
method texi_of_Block : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Bold : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Center : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Code : Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_CodePre : Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_Emphasize : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Enum : Odoc_info.text list -> Odoc_info.Name.t
method texi_of_Italic : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Left : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Link : string -> Odoc_info.text -> Odoc_info.Name.t
method texi_of_List : Odoc_info.text list -> Odoc_info.Name.t
method texi_of_Newline : Odoc_info.Name.t
method texi_of_Raw : Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_Ref :
Odoc_info.Name.t -> Odoc_info.ref_kind option -> Odoc_info.Name.t
method texi_of_Right : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Subscript : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Superscript : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Target :
target:string -> code:Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_Title : int -> Odoc_info.text -> Odoc_info.Name.t
method texi_of_Verbatim : Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_attribute : Odoc_info.Value.t_attribute -> string
method texi_of_class : Odoc_info.Class.t_class -> string
method texi_of_class_element :
Odoc_info.Name.t -> Odoc_info.Class.class_element -> string
method texi_of_class_type : Odoc_info.Class.t_class_type -> string
method texi_of_custom_text :
string -> Odoc_info.text -> Odoc_info.Name.t
method texi_of_exception : Odoc_info.Exception.t_exception -> string
method texi_of_included_module :
Odoc_info.Module.included_module -> string
method texi_of_info : Odoc_info.info option -> string
method texi_of_method : Odoc_info.Value.t_method -> string
method texi_of_module : Odoc_info.Module.t_module -> string
method texi_of_module_element :
Odoc_info.Name.t -> Odoc_info.Module.module_element -> string
method texi_of_module_type : Odoc_info.Module.t_module_type -> string
method texi_of_text : Odoc_info.text -> string
method texi_of_text_element :
Odoc_info.text_element -> Odoc_info.Name.t
method texi_of_type : Odoc_info.Type.t_type -> string
method texi_of_type_extension :
Odoc_info.Name.t -> Odoc_info.Extension.t_type_extension -> string
method texi_of_value : Odoc_info.Value.t_value -> string
method text_el_of_type_expr :
Odoc_info.Name.t -> Types.type_expr -> Odoc_info.text_element
method text_of_alerts :
Odoc_info.alert list -> Odoc_info.text_element list
method text_of_attribute :
Odoc_info.Value.t_attribute -> Odoc_info.text_element list
method text_of_author_list :
string list -> Odoc_info.text_element list
method text_of_before :
(string * Odoc_info.text) list -> Odoc_info.text_element list
method text_of_class_kind :
Odoc_info.Name.t ->
Odoc_info.Class.class_kind -> Odoc_info.text_element list
method text_of_class_params :
Odoc_info.Name.t -> Odoc_info.Class.t_class -> Odoc_types.text
method text_of_class_type_kind :
Odoc_info.Name.t ->
Odoc_info.Class.class_type_kind -> Odoc_info.text_element list
method text_of_class_type_param_expr_list :
Odoc_info.Name.t ->
Types.type_expr list -> Odoc_info.text_element list
method text_of_custom :
(string * Odoc_info.text) list -> Odoc_info.text
method text_of_desc :
Odoc_info.text option -> Odoc_info.text_element list
method text_of_exception :
Odoc_info.Exception.t_exception -> Odoc_info.text_element list
method text_of_info :
?block:bool -> Odoc_info.info option -> Odoc_info.text_element list
method text_of_method :
Odoc_info.Value.t_method -> Odoc_info.text_element list
method text_of_module_kind :
?with_def_syntax:bool ->
Odoc_info.Module.module_kind -> Odoc_info.text_element list
method text_of_module_parameter_list :
(Odoc_info.Module.module_parameter *
Odoc_info.text_element list option)
list -> Odoc_info.text_element list
method text_of_module_type :
Types.module_type -> Odoc_info.text_element list
method text_of_module_type_kind :
?with_def_syntax:bool ->
Odoc_info.Module.module_type_kind -> Odoc_info.text_element list
method text_of_parameter_description :
Odoc_info.Parameter.parameter -> Odoc_info.text
method text_of_parameter_list :
Odoc_info.Name.t ->
Odoc_info.Parameter.parameter list -> Odoc_info.text_element list
method text_of_params :
Odoc_info.param list -> Odoc_info.text_element list
method text_of_raised_exceptions :
Odoc_info.raised_exception list -> Odoc_info.text_element list
method text_of_return_opt :
Odoc_info.text option -> Odoc_info.text_element list
method text_of_see : Odoc_info.see -> Odoc_info.text
method text_of_sees :
Odoc_info.see list -> Odoc_info.text_element list
method text_of_sees_opt :
Odoc_info.see list -> Odoc_info.text_element list
method text_of_short_type_expr :
Odoc_info.Name.t -> Types.type_expr -> Odoc_info.text_element list
method text_of_since_opt :
string option -> Odoc_info.text_element list
method text_of_type_expr :
Odoc_info.Name.t -> Types.type_expr -> Odoc_info.text_element list
method text_of_type_expr_list :
Odoc_info.Name.t ->
string -> Types.type_expr list -> Odoc_info.text_element list
method text_of_value :
Odoc_info.Value.t_value -> Odoc_info.text_element list
method text_of_version_opt :
string option -> Odoc_info.text_element list
end
end
module type Texi_generator =
sig
class texi :
object
val bullet : Odoc_info.text_element
val mutable indices_to_build :
[ `Class
| `Class_att
| `Class_type
| `Exception
| `Extension
| `Method
| `Module
| `Module_type
| `Type
| `Value ] list
val linebreak : Odoc_info.text_element
val maxdepth : int
val minus : Odoc_info.text_element
val node_tbl : (Odoc_info.Name.t, unit) Hashtbl.t
val mutable tag_functions :
(string * (Odoc_info.text -> Odoc_info.text)) list
method do_index :
[ `Class
| `Class_att
| `Class_type
| `Exception
| `Extension
| `Method
| `Module
| `Module_type
| `Type
| `Value ] -> unit
method escape : Odoc_info.Name.t -> Odoc_info.Name.t
method private fix_linebreaks : Odoc_info.text -> Odoc_info.text
method fixedblock :
Odoc_info.text_element list -> Odoc_info.text_element
method generate : Odoc_info.Module.t_module list -> unit
method generate_class_inheritance_info :
out_channel -> Odoc_info.Class.t_class -> unit
method generate_class_type_inheritance_info :
out_channel -> Odoc_info.Class.t_class_type -> unit
method generate_for_class :
out_channel -> Odoc_info.Class.t_class -> unit
method generate_for_class_type :
out_channel -> Odoc_info.Class.t_class_type -> unit
method generate_for_module :
out_channel -> Odoc_info.Module.t_module -> unit
method generate_for_module_type :
out_channel -> Odoc_info.Module.t_module_type -> unit
method generate_inheritance_info :
out_channel -> Odoc_info.Class.inherited_class list -> unit
method generate_texi_header :
out_channel -> string -> Odoc_info.Module.t_module list -> unit
method generate_texi_trailer : out_channel -> unit
method heading : int -> Odoc_info.text -> string
method index : indices -> Odoc_info.Name.t -> Odoc_info.text_element
method label : ?no_:bool -> string -> string
method node : int -> Odoc_info.Name.t -> Odoc_info.text_element
method normal_class_params :
Odoc_info.Name.t -> Odoc_info.Class.t_class -> string
method normal_class_type :
Odoc_info.Name.t -> Types.class_type -> string
method normal_class_type_param_list :
Odoc_info.Name.t -> Types.type_expr list -> string
method normal_cstr_args :
?par:bool ->
Odoc_info.Name.t -> Odoc_info.Type.constructor_args -> string
method normal_module_type :
?code:string -> Odoc_info.Name.t -> Types.module_type -> string
method normal_type : Odoc_info.Name.t -> Types.type_expr -> string
method normal_type_list :
?par:bool ->
Odoc_info.Name.t -> string -> Types.type_expr list -> string
method relative_idents : Odoc_info.Name.t -> string -> string
method relative_module_idents : Odoc_info.Name.t -> string -> string
method scan_for_index : subparts -> unit
method scan_for_index_in_class :
Odoc_info.Class.class_element -> unit
method scan_for_index_in_mod :
Odoc_info.Module.module_element -> unit
method private soft_fix_linebreaks :
int -> Odoc_info.text_element list -> Odoc_info.text_element list
method string_of_type_args :
Odoc_info.Type.constructor_args -> Types.type_expr option -> string
method string_of_type_parameters : Odoc_info.Type.t_type -> string
method texi_of_Block : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Bold : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Center : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Code : Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_CodePre : Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_Emphasize : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Enum : Odoc_info.text list -> Odoc_info.Name.t
method texi_of_Italic : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Left : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Link : string -> Odoc_info.text -> Odoc_info.Name.t
method texi_of_List : Odoc_info.text list -> Odoc_info.Name.t
method texi_of_Newline : Odoc_info.Name.t
method texi_of_Raw : Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_Ref :
Odoc_info.Name.t -> Odoc_info.ref_kind option -> Odoc_info.Name.t
method texi_of_Right : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Subscript : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Superscript : Odoc_info.text -> Odoc_info.Name.t
method texi_of_Target :
target:string -> code:Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_Title : int -> Odoc_info.text -> Odoc_info.Name.t
method texi_of_Verbatim : Odoc_info.Name.t -> Odoc_info.Name.t
method texi_of_attribute : Odoc_info.Value.t_attribute -> string
method texi_of_class : Odoc_info.Class.t_class -> string
method texi_of_class_element :
Odoc_info.Name.t -> Odoc_info.Class.class_element -> string
method texi_of_class_type : Odoc_info.Class.t_class_type -> string
method texi_of_custom_text :
string -> Odoc_info.text -> Odoc_info.Name.t
method texi_of_exception : Odoc_info.Exception.t_exception -> string
method texi_of_included_module :
Odoc_info.Module.included_module -> string
method texi_of_info : Odoc_info.info option -> string
method texi_of_method : Odoc_info.Value.t_method -> string
method texi_of_module : Odoc_info.Module.t_module -> string
method texi_of_module_element :
Odoc_info.Name.t -> Odoc_info.Module.module_element -> string
method texi_of_module_type : Odoc_info.Module.t_module_type -> string
method texi_of_text : Odoc_info.text -> string
method texi_of_text_element :
Odoc_info.text_element -> Odoc_info.Name.t
method texi_of_type : Odoc_info.Type.t_type -> string
method texi_of_type_extension :
Odoc_info.Name.t -> Odoc_info.Extension.t_type_extension -> string
method texi_of_value : Odoc_info.Value.t_value -> string
method text_el_of_type_expr :
Odoc_info.Name.t -> Types.type_expr -> Odoc_info.text_element
method text_of_alerts :
Odoc_info.alert list -> Odoc_info.text_element list
method text_of_attribute :
Odoc_info.Value.t_attribute -> Odoc_info.text_element list
method text_of_author_list :
string list -> Odoc_info.text_element list
method text_of_before :
(string * Odoc_info.text) list -> Odoc_info.text_element list
method text_of_class_kind :
Odoc_info.Name.t ->
Odoc_info.Class.class_kind -> Odoc_info.text_element list
method text_of_class_params :
Odoc_info.Name.t -> Odoc_info.Class.t_class -> Odoc_types.text
method text_of_class_type_kind :
Odoc_info.Name.t ->
Odoc_info.Class.class_type_kind -> Odoc_info.text_element list
method text_of_class_type_param_expr_list :
Odoc_info.Name.t ->
Types.type_expr list -> Odoc_info.text_element list
method text_of_custom :
(string * Odoc_info.text) list -> Odoc_info.text
method text_of_desc :
Odoc_info.text option -> Odoc_info.text_element list
method text_of_exception :
Odoc_info.Exception.t_exception -> Odoc_info.text_element list
method text_of_info :
?block:bool -> Odoc_info.info option -> Odoc_info.text_element list
method text_of_method :
Odoc_info.Value.t_method -> Odoc_info.text_element list
method text_of_module_kind :
?with_def_syntax:bool ->
Odoc_info.Module.module_kind -> Odoc_info.text_element list
method text_of_module_parameter_list :
(Odoc_info.Module.module_parameter *
Odoc_info.text_element list option)
list -> Odoc_info.text_element list
method text_of_module_type :
Types.module_type -> Odoc_info.text_element list
method text_of_module_type_kind :
?with_def_syntax:bool ->
Odoc_info.Module.module_type_kind -> Odoc_info.text_element list
method text_of_parameter_description :
Odoc_info.Parameter.parameter -> Odoc_info.text
method text_of_parameter_list :
Odoc_info.Name.t ->
Odoc_info.Parameter.parameter list -> Odoc_info.text_element list
method text_of_params :
Odoc_info.param list -> Odoc_info.text_element list
method text_of_raised_exceptions :
Odoc_info.raised_exception list -> Odoc_info.text_element list
method text_of_return_opt :
Odoc_info.text option -> Odoc_info.text_element list
method text_of_see : Odoc_info.see -> Odoc_info.text
method text_of_sees :
Odoc_info.see list -> Odoc_info.text_element list
method text_of_sees_opt :
Odoc_info.see list -> Odoc_info.text_element list
method text_of_short_type_expr :
Odoc_info.Name.t -> Types.type_expr -> Odoc_info.text_element list
method text_of_since_opt :
string option -> Odoc_info.text_element list
method text_of_type_expr :
Odoc_info.Name.t -> Types.type_expr -> Odoc_info.text_element list
method text_of_type_expr_list :
Odoc_info.Name.t ->
string -> Types.type_expr list -> Odoc_info.text_element list
method text_of_value :
Odoc_info.Value.t_value -> Odoc_info.text_element list
method text_of_version_opt :
string option -> Odoc_info.text_element list
end
end
|
