ocamldoc/odoc_global.ml


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

(***********************************************************************)
(*                                                                     *)
(*                             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$ *)

(** Global variables. *)

(* Tell ocaml compiler not to generate files. *)
let _ = Clflags.dont_write_files := true

open Clflags

type source_file =
    Impl_file of string
  | Intf_file of string
  | Text_file of string

let include_dirs = Clflags.include_dirs

let errors = ref 0

let warn_error = ref false

let pwarning s =
  if !Odoc_config.print_warnings then prerr_endline (Odoc_messages.warning^": "^s);
  if !warn_error then incr errors

let merge_options = ref ([] : Odoc_types.merge_option list)

let classic = Clflags.classic

let dump = ref (None : string option)

let load = ref ([] : string list)

(** Allow arbitrary recursive types. *)
let recursive_types = Clflags.recursive_types

(** Optional preprocessor command. *)
let preprocessor = Clflags.preprocessor
let ppx = Clflags.ppx

let sort_modules = ref false

let no_custom_tags = ref false

let no_stop = ref false

let remove_stars = ref false

let keep_code = ref false

let inverse_merge_ml_mli = ref false

let filter_with_module_constraints = ref true

let hidden_modules = ref ([] : string list)

let files = ref []


let out_file = ref Odoc_messages.default_out_file

let verbose = ref false

let target_dir = ref Filename.current_dir_name

let title = ref (None : string option)

let intro_file = ref (None : string option)

let with_header = ref true

let with_trailer = ref true

let with_toc = ref true

let with_index = ref true