gazagnaire.org
Find and remove dead code and unused APIs in OCaml projects
1(** Output formatting and display module *)
2
3type mode = Normal | Quiet | Verbose | Json
4
5val set_mode : mode -> unit
6(** [set_mode mode] sets the output mode. *)
7
8(** {2 Structured output} *)
9
10val header : ('a, Format.formatter, unit) format -> 'a
11(** [header fmt ...] prints a header. *)
12
13val section : ('a, Format.formatter, unit) format -> 'a
14(** [section fmt ...] prints a section header. *)
15
16val success : ('a, Format.formatter, unit) format -> 'a
17(** [success fmt ...] prints a success message. *)
18
19val warning : ('a, Format.formatter, unit) format -> 'a
20(** [warning fmt ...] prints a warning message. *)
21
22val error : ('a, Format.formatter, unit) format -> 'a
23(** [error fmt ...] prints an error message. *)
24
25(** {2 Progress indicators} *)
26
27type progress
28
29val progress : ?total:int -> unit -> progress
30(** [progress ?total ()] creates a progress indicator. *)
31
32val update_progress : progress -> string -> unit
33(** [update_progress progress message] updates progress with a message. *)
34
35val set_progress_current : progress -> int -> unit
36(** [set_progress_current progress value] sets current progress value. *)
37
38val clear_progress : progress -> unit
39(** [clear_progress progress] clears the progress display. *)