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
|
(**************************************************************************)
(* *)
(* 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. *)
(* *)
(**************************************************************************)
(** The man pages generator. *)
val man_suffix : string ref
val man_section : string ref
val man_mini : bool ref
module Generator :
sig
class man :
object
val mutable tag_functions :
(string * (Odoc_info.text -> string)) list
method create_groups :
bool ->
Odoc_info.Module.t_module list ->
Odoc_info.Search.result_element list list
method escape : string -> string
method field_comment : Buffer.t -> Odoc_info.info option -> unit
method file_name : Odoc_info.Name.t -> string
method generate : Odoc_info.Module.t_module list -> unit
method generate_for_class : Odoc_info.Class.t_class -> unit
method generate_for_class_type : Odoc_info.Class.t_class_type -> unit
method generate_for_group :
Odoc_info.Search.result_element list -> unit
method generate_for_module : Odoc_info.Module.t_module -> unit
method generate_for_module_type :
Odoc_info.Module.t_module_type -> unit
method man_of_Target :
Buffer.t -> target:string -> code:string -> unit
method man_of_attribute :
Buffer.t -> Odoc_info.Value.t_attribute -> unit
method man_of_class : Buffer.t -> Odoc_info.Class.t_class -> unit
method man_of_class_comment : Buffer.t -> Odoc_info.text -> unit
method man_of_class_type :
Buffer.t -> Odoc_info.Class.t_class_type -> unit
method man_of_class_type_expr :
Buffer.t -> Odoc_info.Name.t -> Types.class_type -> unit
method man_of_code : Buffer.t -> string -> unit
method man_of_const :
Buffer.t ->
Odoc_info.Name.t -> Odoc_info.Type.variant_constructor -> unit
method man_of_cstr_args :
?par:bool ->
Buffer.t ->
Odoc_info.Name.t ->
string -> Odoc_info.Type.constructor_args -> unit
method man_of_custom_text :
Buffer.t -> string -> Odoc_info.text -> unit
method man_of_exception :
Buffer.t -> Odoc_info.Exception.t_exception -> unit
method man_of_included_module :
Buffer.t ->
Odoc_info.Name.t -> Odoc_info.Module.included_module -> unit
method man_of_info :
?margin:int -> Buffer.t -> Odoc_types.info option -> unit
method man_of_method : Buffer.t -> Odoc_info.Value.t_method -> unit
method man_of_modtype :
Buffer.t -> Odoc_info.Module.t_module_type -> unit
method man_of_module : Buffer.t -> Odoc_info.Module.t_module -> unit
method man_of_module_body :
Buffer.t -> Odoc_info.Module.t_module -> unit
method man_of_module_comment : Buffer.t -> Odoc_info.text -> unit
method man_of_module_parameter_list :
Buffer.t ->
Odoc_info.Name.t ->
(Odoc_info.Module.module_parameter * Odoc_info.text option) list ->
unit
method man_of_module_type :
Buffer.t -> Odoc_info.Name.t -> Types.module_type -> unit
method man_of_module_type_body :
Buffer.t -> Odoc_info.Module.t_module_type -> unit
method man_of_parameter_description :
Buffer.t -> Odoc_info.Parameter.parameter -> unit
method man_of_parameter_list :
Buffer.t ->
Odoc_info.Name.t -> Odoc_info.Parameter.parameter list -> unit
method man_of_recfield :
Buffer.t -> Odoc_info.Name.t -> Odoc_info.Type.record_field -> unit
method man_of_record :
Odoc_info.Name.t ->
Buffer.t -> Odoc_info.Type.record_field list -> unit
method man_of_text : Buffer.t -> Odoc_info.text -> unit
method private man_of_text2 : Buffer.t -> Odoc_info.text -> unit
method man_of_text_element :
Buffer.t -> Odoc_info.text_element -> unit
method man_of_type : Buffer.t -> Odoc_info.Type.t_type -> unit
method man_of_type_expr :
Buffer.t -> Odoc_info.Name.t -> Types.type_expr -> unit
method man_of_type_expr_param_list :
Buffer.t -> Odoc_info.Name.t -> Odoc_info.Type.t_type -> unit
method man_of_type_extension :
Buffer.t ->
Odoc_info.Name.t -> Odoc_info.Extension.t_type_extension -> unit
method man_of_value : Buffer.t -> Odoc_info.Value.t_value -> unit
method open_out : string -> out_channel
method relative_idents :
Odoc_info.Name.t -> Odoc_info.Name.t -> string
method remove_newlines : string -> string
method str_man_of_alerts : Odoc_info.alert list -> string list
method str_man_of_author_list : string list -> string
method str_man_of_before : (string * Odoc_info.text) list -> string
method str_man_of_custom :
(string * Odoc_info.text) list -> string list
method str_man_of_raised_exceptions :
(string * Odoc_info.text) list -> string
method str_man_of_return_opt : Odoc_info.text option -> string
method str_man_of_see : Odoc_info.see_ref * Odoc_info.text -> string
method str_man_of_sees :
(Odoc_info.see_ref * Odoc_info.text) list -> string
method str_man_of_since_opt : string option -> string
method str_man_of_text : Odoc_info.text -> string
method str_man_of_version_opt : string option -> string
end
end
module type Man_generator =
sig
class man :
object
val mutable tag_functions :
(string * (Odoc_info.text -> string)) list
method create_groups :
bool ->
Odoc_info.Module.t_module list ->
Odoc_info.Search.result_element list list
method escape : string -> string
method field_comment : Buffer.t -> Odoc_info.info option -> unit
method file_name : Odoc_info.Name.t -> string
method generate : Odoc_info.Module.t_module list -> unit
method generate_for_class : Odoc_info.Class.t_class -> unit
method generate_for_class_type : Odoc_info.Class.t_class_type -> unit
method generate_for_group :
Odoc_info.Search.result_element list -> unit
method generate_for_module : Odoc_info.Module.t_module -> unit
method generate_for_module_type :
Odoc_info.Module.t_module_type -> unit
method man_of_Target :
Buffer.t -> target:string -> code:string -> unit
method man_of_attribute :
Buffer.t -> Odoc_info.Value.t_attribute -> unit
method man_of_class : Buffer.t -> Odoc_info.Class.t_class -> unit
method man_of_class_comment : Buffer.t -> Odoc_info.text -> unit
method man_of_class_type :
Buffer.t -> Odoc_info.Class.t_class_type -> unit
method man_of_class_type_expr :
Buffer.t -> Odoc_info.Name.t -> Types.class_type -> unit
method man_of_code : Buffer.t -> string -> unit
method man_of_const :
Buffer.t ->
Odoc_info.Name.t -> Odoc_info.Type.variant_constructor -> unit
method man_of_cstr_args :
?par:bool ->
Buffer.t ->
Odoc_info.Name.t ->
string -> Odoc_info.Type.constructor_args -> unit
method man_of_custom_text :
Buffer.t -> string -> Odoc_info.text -> unit
method man_of_exception :
Buffer.t -> Odoc_info.Exception.t_exception -> unit
method man_of_included_module :
Buffer.t ->
Odoc_info.Name.t -> Odoc_info.Module.included_module -> unit
method man_of_info :
?margin:int -> Buffer.t -> Odoc_types.info option -> unit
method man_of_method : Buffer.t -> Odoc_info.Value.t_method -> unit
method man_of_modtype :
Buffer.t -> Odoc_info.Module.t_module_type -> unit
method man_of_module : Buffer.t -> Odoc_info.Module.t_module -> unit
method man_of_module_body :
Buffer.t -> Odoc_info.Module.t_module -> unit
method man_of_module_comment : Buffer.t -> Odoc_info.text -> unit
method man_of_module_parameter_list :
Buffer.t ->
Odoc_info.Name.t ->
(Odoc_info.Module.module_parameter * Odoc_info.text option) list ->
unit
method man_of_module_type :
Buffer.t -> Odoc_info.Name.t -> Types.module_type -> unit
method man_of_module_type_body :
Buffer.t -> Odoc_info.Module.t_module_type -> unit
method man_of_parameter_description :
Buffer.t -> Odoc_info.Parameter.parameter -> unit
method man_of_parameter_list :
Buffer.t ->
Odoc_info.Name.t -> Odoc_info.Parameter.parameter list -> unit
method man_of_recfield :
Buffer.t -> Odoc_info.Name.t -> Odoc_info.Type.record_field -> unit
method man_of_record :
Odoc_info.Name.t ->
Buffer.t -> Odoc_info.Type.record_field list -> unit
method man_of_text : Buffer.t -> Odoc_info.text -> unit
method private man_of_text2 : Buffer.t -> Odoc_info.text -> unit
method man_of_text_element :
Buffer.t -> Odoc_info.text_element -> unit
method man_of_type : Buffer.t -> Odoc_info.Type.t_type -> unit
method man_of_type_expr :
Buffer.t -> Odoc_info.Name.t -> Types.type_expr -> unit
method man_of_type_expr_param_list :
Buffer.t -> Odoc_info.Name.t -> Odoc_info.Type.t_type -> unit
method man_of_type_extension :
Buffer.t ->
Odoc_info.Name.t -> Odoc_info.Extension.t_type_extension -> unit
method man_of_value : Buffer.t -> Odoc_info.Value.t_value -> unit
method open_out : string -> out_channel
method relative_idents :
Odoc_info.Name.t -> Odoc_info.Name.t -> string
method remove_newlines : string -> string
method str_man_of_alerts : Odoc_info.alert list -> string list
method str_man_of_author_list : string list -> string
method str_man_of_before : (string * Odoc_info.text) list -> string
method str_man_of_custom :
(string * Odoc_info.text) list -> string list
method str_man_of_raised_exceptions :
(string * Odoc_info.text) list -> string
method str_man_of_return_opt : Odoc_info.text option -> string
method str_man_of_see : Odoc_info.see_ref * Odoc_info.text -> string
method str_man_of_sees :
(Odoc_info.see_ref * Odoc_info.text) list -> string
method str_man_of_since_opt : string option -> string
method str_man_of_text : Odoc_info.text -> string
method str_man_of_version_opt : string option -> string
end
end
|
