ocamldoc/odoc_comments_global.ml

   1 (***********************************************************************)
   2 (*                             OCamldoc                                *)
   3 (*                                                                     *)
   4 (*            Maxence Guesdon, projet Cristal, INRIA Rocquencourt      *)
   5 (*                                                                     *)
   6 (*  Copyright 2001 Institut National de Recherche en Informatique et   *)
   7 (*  en Automatique.  All rights reserved.  This file is distributed    *)
   8 (*  under the terms of the Q Public License version 1.0.               *)
   9 (*                                                                     *)
  10 (***********************************************************************)
  11
  12 (* $Id$ *)
  13
  14 (** The global variables used by the special comment parser.*)
  15
  16 let nb_chars = ref 0
  17
  18 let authors = ref ([] : string list)
  19
  20 let version = ref (None : string option)
  21
  22 let sees = ref ([] : string list)
  23
  24 let since = ref (None : string option)
  25
  26 let deprecated = ref (None : string option)
  27
  28 let params = ref ([] : (string * string) list)
  29
  30 let raised_exceptions = ref ([] : (string * string) list)
  31
  32 let return_value = ref (None : string option)
  33
  34 let customs = ref []
  35
  36 let init () =
  37   nb_chars := 0;
  38   authors := [];
  39   version := None;
  40   sees := [];
  41   since := None;
  42   deprecated := None;
  43   params := [];
  44   raised_exceptions := [];
  45   return_value := None ;
  46   customs := []
  47
  48 (* eof $Id$ *)