forked from avsm/bin-doc
/
info.mli
102 lines (90 loc) · 3.71 KB
/
info.mli
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
(***********************************************************************)
(* *)
(* 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. *)
(* *)
(***********************************************************************)
(** Types for the information collected in comments. *)
(** The differents kinds of style. *)
type style_kind =
| SK_bold
| SK_italic
| SK_emphasize
| SK_center
| SK_left
| SK_right
| SK_superscript
| SK_subscript
| SK_custom of string
(** The differents kinds of element references. *)
type ref_kind =
RK_element
| RK_module
| RK_module_type
| RK_class
| RK_class_type
| RK_value
| RK_type
| RK_exception
| RK_attribute
| RK_method
| RK_section
| RK_recfield
| RK_const
| RK_link
| RK_custom of string
(* The different kinds of special reference *)
type special_ref_kind =
SRK_module_list of string list
| SRK_index_list
and text_element =
| Raw of string (** Raw text. *)
| Code of string (** The string is source code. *)
| PreCode of string (** The string is pre-formatted source code. *)
| Verbatim of string (** String 'as is'. *)
| Style of style_kind * text (** Text tagged with a style. *)
| List of text list (** A list. *)
| Enum of text list (** An enumerated list. *)
| Newline (** To force a line break. *)
| Block of text (** Like html's block quote. *)
| Title of int * string option * text
(** Style number, optional label, and text. *)
| Ref of ref_kind * string * text option
(** A reference to an element. Complete name and kind. An optional
text can be given to display this text instead of the element name.*)
| Special_ref of special_ref_kind (** Special kinds of reference *)
| Target of string option * string (** (target, code) : to specify code for a specific target format *)
(** [text] is a list of text_elements. The order matters. *)
and text = text_element list
(** The different forms of references in \@see tags. *)
type see_ref =
See_url of string
| See_file of string
| See_doc of string
(** The information in a \@see tag. *)
type see = see_ref * text
(** Parameter name and description. *)
type param = (string * text)
(** Raised exception name and description. *)
type raised_exception = (string * text)
(** Information in a special comment. *)
type t = {
i_desc : text option; (** The description text. *)
i_authors : string list; (** The list of authors in \@author tags. *)
i_version : string option; (** The string in the \@version tag. *)
i_sees : see list; (** The list of \@see tags. *)
i_since : string option; (** The string in the \@since tag. *)
i_before : (string * text) list; (** the version number and text in \@before tag *)
i_deprecated : text option; (** The of the \@deprecated tag. *)
i_params : param list; (** The list of parameter descriptions. *)
i_raised_exceptions : raised_exception list; (** The list of raised exceptions. *)
i_return_value : text option ; (** The description text of the return value. *)
i_custom : (string * text) list ; (** A text associated to a custom @-tag. *)
}
(** An empty doc_info structure. *)
val dummy : t