blob: 291673c07676b2a392850dac33febf9294bcc7f1 (
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
|
(***********************************************************************)
(* *)
(* 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. *)
(* *)
(***********************************************************************)
(** The global variables used by the special comment parser.*)
(** the number of chars used in the lexer. *)
val nb_chars : int ref
(** the authors list *)
val authors : string list ref
(** the version string *)
val version : string option ref
(** the see references *)
val sees : string list ref
(** the since string *)
val since : string option ref
(** the before tag information *)
val before : (string * string) list ref
(** the deprecated flag *)
val deprecated : string option ref
(** parameters, with name and description *)
val params : (string * string) list ref
(** the raised exceptions, with name and description *)
val raised_exceptions : (string * string) list ref
(** the description of the return value *)
val return_value : string option ref
(** the strings associated to custom tags. *)
val customs : (string * string) list ref
(** this function inits the variables filled by the parser. *)
val init : unit -> unit
|
