ocamldoc/odoc_comments_global.mli

   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 (** the number of chars used in the lexer. *)
  17 val nb_chars : int ref
  18
  19 (** the authors list *)
  20 val authors : string list ref
  21
  22 (** the version string *)
  23 val version : string option ref
  24
  25 (** the see references *)
  26 val sees : string list ref
  27
  28 (** the since string *)
  29 val since : string option ref
  30
  31 (** the deprecated flag *)
  32 val deprecated : string option ref
  33
  34 (** parameters, with name and description *)
  35 val params : (string * string) list ref
  36
  37 (** the raised exceptions, with name and description *)
  38 val raised_exceptions : (string * string) list ref
  39
  40 (** the description of the return value *)
  41 val return_value : string option ref
  42
  43 (** the strings associated to custom tags. *)
  44 val customs : (string * string) list ref
  45
  46 (** this function inits the variables filled by the parser. *)
  47 val init : unit -> unit