this repo has no description
1(* Lang_of *)
2open Odoc_model.Paths
3
4type maps
5
6val empty : unit -> maps
7
8val with_fragment_root : Cfrag.root -> maps
9
10val with_shadowed : Odoc_model.Lang.Include.shadowed -> maps
11
12module Opt = Component.Opt
13
14module Path : sig
15 val module_ : maps -> Cpath.module_ -> Path.Module.t
16
17 val module_type : maps -> Cpath.module_type -> Path.ModuleType.t
18
19 val type_ : maps -> Cpath.type_ -> Path.Type.t
20
21 val class_type : maps -> Cpath.class_type -> Path.ClassType.t
22
23 val resolved_module : maps -> Cpath.Resolved.module_ -> Path.Resolved.Module.t
24
25 val resolved_parent : maps -> Cpath.Resolved.parent -> Path.Resolved.Module.t
26
27 val resolved_module_type :
28 maps -> Cpath.Resolved.module_type -> Path.Resolved.ModuleType.t
29
30 val resolved_type : maps -> Cpath.Resolved.type_ -> Path.Resolved.Type.t
31
32 val resolved_value : maps -> Cpath.Resolved.value -> Path.Resolved.Value.t
33
34 val resolved_class_type :
35 maps -> Cpath.Resolved.class_type -> Path.Resolved.ClassType.t
36
37 val module_fragment : maps -> Cfrag.module_ -> Fragment.Module.t
38
39 val signature_fragment : maps -> Cfrag.signature -> Fragment.Signature.t
40
41 val type_fragment : maps -> Cfrag.type_ -> Fragment.Type.t
42
43 val resolved_module_fragment :
44 maps -> Cfrag.resolved_module -> Fragment.Resolved.Module.t
45
46 val resolved_module_type_fragment :
47 maps -> Cfrag.resolved_module_type -> Fragment.Resolved.ModuleType.t
48
49 val resolved_signature_fragment :
50 maps -> Cfrag.resolved_signature -> Fragment.Resolved.Signature.t
51
52 val resolved_type_fragment :
53 maps -> Cfrag.resolved_type -> Fragment.Resolved.Type.t
54end
55
56val signature_items :
57 Identifier.Signature.t ->
58 maps ->
59 Component.Signature.item list ->
60 Odoc_model.Lang.Signature.item list
61
62val signature :
63 Identifier.Signature.t ->
64 maps ->
65 Component.Signature.t ->
66 Odoc_model.Lang.Signature.t
67
68val class_ :
69 maps ->
70 Identifier.Signature.t ->
71 Ident.type_ ->
72 Component.Class.t ->
73 Odoc_model.Lang.Class.t
74
75val class_decl :
76 maps ->
77 Identifier.Path.ClassType.t ->
78 Component.Class.decl ->
79 Odoc_model.Lang.Class.decl
80
81val class_type_expr :
82 maps ->
83 Identifier.Path.ClassType.t ->
84 Component.ClassType.expr ->
85 Odoc_model.Lang.ClassType.expr
86
87val class_type :
88 maps ->
89 Identifier.Signature.t ->
90 Ident.type_ ->
91 Component.ClassType.t ->
92 Odoc_model.Lang.ClassType.t
93
94val class_signature :
95 maps ->
96 Identifier.ClassSignature.t ->
97 Component.ClassSignature.t ->
98 Odoc_model.Lang.ClassSignature.t
99
100val method_ :
101 maps ->
102 Identifier.ClassSignature.t ->
103 Ident.method_ ->
104 Component.Method.t ->
105 Odoc_model.Lang.Method.t
106
107val instance_variable :
108 maps ->
109 Identifier.ClassSignature.t ->
110 Ident.instance_variable ->
111 Component.InstanceVariable.t ->
112 Odoc_model.Lang.InstanceVariable.t
113
114val include_ :
115 Identifier.Signature.t ->
116 maps ->
117 Component.Include.t ->
118 Odoc_model.Lang.Include.t
119
120val open_ :
121 Identifier.Signature.t -> maps -> Component.Open.t -> Odoc_model.Lang.Open.t
122
123val value_ :
124 maps ->
125 Identifier.Signature.t ->
126 Ident.value ->
127 Component.Value.t ->
128 Odoc_model.Lang.Value.t
129
130val typ_ext :
131 maps ->
132 Identifier.Signature.t ->
133 Component.Extension.t ->
134 Odoc_model.Lang.Extension.t
135
136val extension_constructor :
137 maps ->
138 Identifier.Signature.t ->
139 Component.Extension.Constructor.t ->
140 Odoc_model.Lang.Extension.Constructor.t
141
142val module_ :
143 maps ->
144 Identifier.Signature.t ->
145 Ident.module_ ->
146 Component.Module.t ->
147 Odoc_model.Lang.Module.t
148
149val module_substitution :
150 maps ->
151 Identifier.Signature.t ->
152 Ident.module_ ->
153 Component.ModuleSubstitution.t ->
154 Odoc_model.Lang.ModuleSubstitution.t
155
156val module_decl :
157 maps ->
158 Identifier.Signature.t ->
159 Component.Module.decl ->
160 Odoc_model.Lang.Module.decl
161
162val module_type_expr :
163 maps ->
164 Identifier.Signature.t ->
165 Component.ModuleType.expr ->
166 Odoc_model.Lang.ModuleType.expr
167
168val module_type :
169 maps ->
170 Identifier.Signature.t ->
171 Ident.module_type ->
172 Component.ModuleType.t Component.Delayed.t ->
173 Odoc_model.Lang.ModuleType.t
174
175val simple_expansion :
176 maps ->
177 Identifier.Signature.t ->
178 Component.ModuleType.simple_expansion ->
179 Odoc_model.Lang.ModuleType.simple_expansion
180
181val type_decl_constructor_argument :
182 maps ->
183 Identifier.FieldParent.t ->
184 Component.TypeDecl.Constructor.argument ->
185 Odoc_model.Lang.TypeDecl.Constructor.argument
186
187val type_decl_field :
188 maps ->
189 Identifier.FieldParent.t ->
190 Component.TypeDecl.Field.t ->
191 Odoc_model.Lang.TypeDecl.Field.t
192
193val type_decl_equation :
194 maps ->
195 Identifier.FieldParent.t ->
196 Component.TypeDecl.Equation.t ->
197 Odoc_model.Lang.TypeDecl.Equation.t
198
199val type_decl :
200 maps ->
201 Identifier.Signature.t ->
202 Ident.type_ ->
203 Component.TypeDecl.t ->
204 Odoc_model.Lang.TypeDecl.t
205
206val type_decl_representation :
207 maps ->
208 Identifier.Type.t ->
209 Component.TypeDecl.Representation.t ->
210 Odoc_model.Lang.TypeDecl.Representation.t
211
212val type_decl_constructor :
213 maps ->
214 Identifier.DataType.t ->
215 Component.TypeDecl.Constructor.t ->
216 Odoc_model.Lang.TypeDecl.Constructor.t
217
218val type_expr_package :
219 maps ->
220 Identifier.LabelParent.t ->
221 Component.TypeExpr.Package.t ->
222 Odoc_model.Lang.TypeExpr.Package.t
223
224val type_expr :
225 maps ->
226 Identifier.LabelParent.t ->
227 Component.TypeExpr.t ->
228 Odoc_model.Lang.TypeExpr.t
229
230val type_expr_polyvar :
231 maps ->
232 Identifier.LabelParent.t ->
233 Component.TypeExpr.Polymorphic_variant.t ->
234 Odoc_model.Lang.TypeExpr.Polymorphic_variant.t
235
236val type_expr_object :
237 maps ->
238 Identifier.LabelParent.t ->
239 Component.TypeExpr.Object.t ->
240 Odoc_model.Lang.TypeExpr.Object.t
241
242val functor_parameter :
243 maps ->
244 Component.FunctorParameter.parameter ->
245 Odoc_model.Lang.FunctorParameter.parameter
246
247val exception_ :
248 maps ->
249 Identifier.Signature.t ->
250 Ident.exception_ ->
251 Component.Exception.t ->
252 Odoc_model.Lang.Exception.t
253
254val block_element :
255 Identifier.LabelParent.t ->
256 Component.CComment.block_element Odoc_model.Location_.with_location ->
257 Odoc_model.Comment.block_element Odoc_model.Location_.with_location
258
259val docs :
260 Identifier.LabelParent.t -> Component.CComment.docs -> Odoc_model.Comment.docs
261
262val docs_or_stop :
263 Identifier.LabelParent.t ->
264 Component.CComment.docs_or_stop ->
265 Odoc_model.Comment.docs_or_stop