jon.recoil.org
this repo has no description
1open Odoc_model.Lang
2open Odoc_model.Paths
3
4type type_decl_entry = {
5 canonical : Path.Type.t option;
6 equation : TypeDecl.Equation.t;
7 representation : TypeDecl.Representation.t option;
8}
9
10type class_type_entry = { virtual_ : bool; params : TypeDecl.param list }
11
12type method_entry = { private_ : bool; virtual_ : bool; type_ : TypeExpr.t }
13
14type class_entry = { virtual_ : bool; params : TypeDecl.param list }
15
16type type_extension_entry = {
17 type_path : Path.Type.t;
18 type_params : TypeDecl.param list;
19 private_ : bool;
20}
21
22type constructor_entry = {
23 args : TypeDecl.Constructor.argument;
24 res : TypeExpr.t;
25}
26
27type field_entry = {
28 mutable_ : bool;
29 type_ : TypeExpr.t;
30 parent_type : TypeExpr.t;
31}
32
33type instance_variable_entry = {
34 mutable_ : bool;
35 virtual_ : bool;
36 type_ : TypeExpr.t;
37}
38
39type value_entry = { value : Value.value; type_ : TypeExpr.t }
40
41type module_entry = { has_expansion : bool }
42
43type kind =
44 | TypeDecl of type_decl_entry
45 | Module of module_entry
46 | Value of value_entry
47 | Doc
48 | Exception of constructor_entry
49 | Class_type of class_type_entry
50 | Method of method_entry
51 | Class of class_entry
52 | TypeExtension of type_extension_entry
53 | ExtensionConstructor of constructor_entry
54 | ModuleType of module_entry
55 | Constructor of constructor_entry
56 | Field of field_entry
57 | UnboxedField of field_entry
58 | Page of Odoc_model.Frontmatter.t
59 | Impl
60 | Dir
61
62type t = {
63 id : Odoc_model.Paths.Identifier.Any.t;
64 doc : Odoc_model.Comment.elements;
65 kind : kind;
66 source_loc : Odoc_model.Lang.Source_loc_jane.t option;
67}
68
69val entry :
70 id:[< Odoc_model.Paths.Identifier.Any.t_pv ] Odoc_model.Paths.Identifier.id ->
71 doc:Odoc_model.Comment.elements ->
72 kind:kind ->
73 source_loc:Odoc_model.Lang.Source_loc_jane.t option ->
74 t