blob: cf5bbe98bfa43b7b8c4ed060fe6f5285236398e8 (
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
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
(***********************************************************************)
(* 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. *)
(* *)
(***********************************************************************)
(** Analysis of the command line arguments. *)
(** The include_dirs in the OCaml compiler. *)
val include_dirs : string list ref
(** The class type of documentation generators. *)
class type doc_generator =
object method generate : Odoc_module.t_module list -> unit end
(** The function to be used to create a generator. *)
val doc_generator : doc_generator option ref
(** The merge options to be used. *)
val merge_options : Odoc_types.merge_option list ref
(** The iso checks to perform on each type. *)
val iso_type_options : Odoc_types.iso_check list ref
(** The iso checks to perform on each value / method / attribute. *)
val iso_val_options : Odoc_types.iso_check list ref
(** The iso checks to perform on each exception. *)
val iso_exception_options : Odoc_types.iso_check list ref
(** The iso checks to perform on each class and class type. *)
val iso_class_options : Odoc_types.iso_check list ref
(** The iso checks to perform on each module and module type. *)
val iso_module_options : Odoc_types.iso_check list ref
(** Classic mode or not. *)
val classic : bool ref
(** The optional file name to dump the collected information into.*)
val dump : string option ref
(** The list of information files to load. *)
val load : string list ref
(** Verbose mode or not. *)
val verbose : bool ref
(** We must sort the list of top modules or not.*)
val sort_modules : bool ref
(** We must not stop at the stop special comments. Default is false (we stop).*)
val no_stop : bool ref
(** We must raise an exception when we find an unknown @-tag. *)
val no_custom_tags : bool ref
(** We must remove the the first characters of each comment line, until the first asterisk '*'. *)
val remove_stars : bool ref
(** To keep the code while merging, when we have both .ml and .mli files for a module. *)
val keep_code : bool ref
(** To inverse implementation and interface files when merging. *)
val inverse_merge_ml_mli : bool ref
(** The optional title to use in the generated documentation. *)
val title : string option ref
(** Flag to indicate whether we must display the complete list of parameters
for functions and methods. *)
val with_parameter_list : bool ref
(** The list of module names to hide. *)
val hidden_modules : string list ref
(** The directory where files have to be generated. *)
val target_dir : string ref
(** An optional file to use where a CSS style is defined (for HTML). *)
val css_style : string option ref
(** Generate only index files. (for HTML). *)
val index_only : bool ref
(** To colorize code in HTML generated documentation pages, not code pages. *)
val colorize_code : bool ref
(** The flag which indicates if we must generate a header (for LaTeX). *)
val with_header : bool ref
(** The flag which indicates if we must generate a trailer (for LaTeX). *)
val with_trailer : bool ref
(** The flag to indicate if we must generate one file per module (for LaTeX). *)
val separate_files : bool ref
(** The list of pairs (title level, sectionning style). *)
val latex_titles : (int * string) list ref
(** The flag which indicates if we must generate a table of contents (for LaTeX). *)
val with_toc : bool ref
(** The flag which indicates if we must generate an index (for TeXinfo). *)
val with_index : bool ref
(** The flag which indicates if we must escape accentuated characters (for TeXinfo).*)
val esc_8bits : bool ref
(** The file used byt the dot generator. *)
val dot_file : string ref
(** Include all modules or only the ones on the command line, for the dot ouput. *)
val dot_include_all : bool ref
(** Generate dependency graph for types. *)
val dot_types : bool ref
(** Perform transitive reduction before dot output. *)
val dot_reduce : bool ref
(** The colors used in the dot output. *)
val dot_colors : string list ref
(** The files to be analysed. *)
val files : string list ref
(** To set the documentation generator. *)
val set_doc_generator : doc_generator option -> unit
(** Add an option specification. *)
val add_option : string * Arg.spec * string -> unit
(** Parse the args. *)
val parse :
html_generator:doc_generator ->
latex_generator:doc_generator ->
texi_generator:doc_generator ->
man_generator:doc_generator ->
iso_generator:doc_generator ->
dot_generator:doc_generator ->
unit
|
