aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib/pp.mli
diff options
context:
space:
mode:
authorGravatar Emilio Jesus Gallego Arias <e+git@x80.org>2016-05-31 14:58:35 +0200
committerGravatar Emilio Jesus Gallego Arias <e+git@x80.org>2016-06-02 18:10:20 +0200
commit1018be0472d41e9e12b181d1e11b04fa413754f2 (patch)
tree196e4b14cbe1808e2ff0c36eaf67f0d52c7e4705 /lib/pp.mli
parent71b64cc5ec5ab0d70d437ec4542c5903f43063cb (diff)
Add documentation to the low-level `Pp` functions.
Thanks to HH for pointing it out.
Diffstat (limited to 'lib/pp.mli')
-rw-r--r--lib/pp.mli4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/pp.mli b/lib/pp.mli
index ced4b6603..a18744c37 100644
--- a/lib/pp.mli
+++ b/lib/pp.mli
@@ -170,5 +170,9 @@ val pr_vertical_list : ('b -> std_ppcmds) -> 'b list -> std_ppcmds
(** FIXME: These ignore the logging settings and call [Format] directly *)
type tag_handler = Tag.t -> Format.tag
+
+(** [msg_with fmt pp] Print [pp] to [fmt] and flush [fmt] *)
val msg_with : Format.formatter -> std_ppcmds -> unit
+
+(** [msg_with fmt pp] Print [pp] to [fmt] and don't flush [fmt] *)
val pp_with : ?pp_tag:tag_handler -> Format.formatter -> std_ppcmds -> unit