jon.recoil.org
this repo has no description
1(*
2 * Copyright (c) 2014 Leo White <lpw25@cl.cam.ac.uk>
3 *
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 *)
16
17module Paths = Odoc_model.Paths
18
19val cmti_builddir : string ref
20val read_module_expr :
21 (Cmi.env ->
22 Paths.Identifier.Signature.t ->
23 Paths.Identifier.LabelParent.t ->
24 Typedtree.module_expr ->
25 Odoc_model.Lang.ModuleType.expr)
26 ref
27
28val read_interface :
29 Odoc_model.Paths.Identifier.ContainerPage.t option ->
30 string ->
31 warnings_tag:string option ->
32 Typedtree.signature ->
33 Paths.Identifier.RootModule.t
34 * Odoc_model.Lang.Signature.t
35 * Paths.Path.Module.t option
36(** Returns [id, sg, canonical_path]. [canonical_path] is the path set from the
37 [@canonical] tag. *)
38
39val read_module_type :
40 Cmi.env ->
41 Paths.Identifier.Signature.t ->
42 Paths.Identifier.LabelParent.t ->
43 Typedtree.module_type ->
44 Odoc_model.Lang.ModuleType.expr
45
46val read_value_description :
47 Cmi.env ->
48 Paths.Identifier.Signature.t ->
49 Typedtree.value_description ->
50 Odoc_model.Lang.Signature.item
51
52val read_type_declarations :
53 Cmi.env ->
54 Paths.Identifier.Signature.t ->
55 Odoc_model.Lang.Signature.recursive ->
56 Typedtree.type_declaration list ->
57 Odoc_model.Lang.Signature.item list
58
59val read_module_type_declaration :
60 Cmi.env ->
61 Paths.Identifier.Signature.t ->
62 Typedtree.module_type_declaration ->
63 Odoc_model.Lang.ModuleType.t
64
65val read_class_type_declarations :
66 Cmi.env ->
67 Paths.Identifier.Signature.t ->
68 Typedtree.class_type Typedtree.class_infos list ->
69 Odoc_model.Lang.Signature.item list