blob: 68b3c4c9ca300c3f0b3b5b62610c21cab5d736da (
plain)
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
|
(***********************************************************************)
(* OCamldoc *)
(* *)
(* Maxence Guesdon, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 2001 Institut National de Recherche en Informatique et *)
(* en Automatique. All rights reserved. This file is distributed *)
(* under the terms of the Q Public License version 1.0. *)
(* *)
(***********************************************************************)
(* $Id$ *)
type ref_kind =
RK_module
| RK_module_type
| RK_class
| RK_class_type
| RK_value
| RK_type
| RK_exception
| RK_attribute
| RK_method
| RK_section of text
and text_element =
| Raw of string
| Code of string
| CodePre of string
| Verbatim of string
| Bold of text
| Italic of text
| Emphasize of text
| Center of text
| Left of text
| Right of text
| List of text list
| Enum of text list
| Newline
| Block of text
| Title of int * string option * text
| Latex of string
| Link of string * text
| Ref of string * ref_kind option
| Superscript of text
| Subscript of text
| Module_list of string list
| Index_list
| Custom of string * text
and text = text_element list
type see_ref =
See_url of string
| See_file of string
| See_doc of string
type see = see_ref * text
type param = (string * text)
type raised_exception = (string * text)
type info = {
i_desc : text option;
i_authors : string list;
i_version : string option;
i_sees : see list;
i_since : string option;
i_deprecated : text option;
i_params : param list;
i_raised_exceptions : raised_exception list;
i_return_value : text option ;
i_custom : (string * text) list ;
}
let dummy_info = {
i_desc = None ;
i_authors = [] ;
i_version = None ;
i_sees = [] ;
i_since = None ;
i_deprecated = None ;
i_params = [] ;
i_raised_exceptions = [] ;
i_return_value = None ;
i_custom = [] ;
}
type location = {
loc_impl : (string * int) option ;
loc_inter : (string * int) option ;
}
let dummy_loc = { loc_impl = None ; loc_inter = None }
type merge_option =
| Merge_description
| Merge_author
| Merge_version
| Merge_see
| Merge_since
| Merge_deprecated
| Merge_param
| Merge_raised_exception
| Merge_return_value
| Merge_custom
let all_merge_options = [
Merge_description ;
Merge_author ;
Merge_version ;
Merge_see ;
Merge_since ;
Merge_deprecated ;
Merge_param ;
Merge_raised_exception ;
Merge_return_value ;
Merge_custom ;
]
type magic = string
let magic = Odoc_messages.magic
type 'a dump = Dump of magic * 'a
let make_dump a = Dump (magic, a)
let open_dump = function
Dump (m, a) ->
if m = magic then a
else raise (Failure Odoc_messages.bad_magic_number)
|
