simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 11:15:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

CCFormat: add @since tags for space/append/etc.

Browse source
This commit is contained in:
Kye Shi 2020-12-13 13:26:17 -08:00 • committed by Simon Cruanes
parent 82781aa9c7
commit 78681736cd
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/core/CCFormat.mli
View file

@ -35,13 +35,16 @@ val exn : exn printer
@since 3.0 *) @since 3.0 *)
val space : unit printer val space : unit printer
(** Alias to {!pp_print_space}. *) (** Alias to {!pp_print_space}.
@since NEXT_RELEASE *)
val cut : unit printer val cut : unit printer
(** Alias to {!pp_print_cut}. *) (** Alias to {!pp_print_cut}.
@since NEXT_RELEASE *)
val break : (int * int) printer val break : (int * int) printer
(** Tuple-ized {!printer} form of {!pp_print_break}. *) (** Tuple-ized {!printer} form of {!pp_print_break}.
@since NEXT_RELEASE *)
val newline : unit printer val newline : unit printer
(** Force newline (see {!Format.pp_force_newline}). (** Force newline (see {!Format.pp_force_newline}).
@ -96,10 +99,12 @@ val quad : ?sep:unit printer -> 'a printer -> 'b printer ->
'c printer -> 'd printer -> ('a * 'b * 'c * 'd) printer 'c printer -> 'd printer -> ('a * 'b * 'c * 'd) printer
val append : unit printer -> unit printer -> unit printer val append : unit printer -> unit printer -> unit printer
(** [append ppa ppb] first prints [ppa ()], then prints [ppb ()]. *) (** [append ppa ppb] first prints [ppa ()], then prints [ppb ()].
@since NEXT_RELEASE *)
val append_l : unit printer list -> unit printer val append_l : unit printer list -> unit printer
(** [append_l pps] runs the printers in [pps] sequentially. *) (** [append_l pps] runs the printers in [pps] sequentially.
@since NEXT_RELEASE *)
val within : string -> string -> 'a printer -> 'a printer val within : string -> string -> 'a printer -> 'a printer
(** [within a b p] wraps [p] inside the strings [a] and [b]. Convenient, (** [within a b p] wraps [p] inside the strings [a] and [b]. Convenient,
@ -358,7 +363,8 @@ end
module Infix : sig module Infix : sig
val (++) : unit printer -> unit printer -> unit printer val (++) : unit printer -> unit printer -> unit printer
(** Alias to {!append}. *) (** Alias to {!append}.
@since NEXT_RELEASE *)
end end
include module type of Infix include module type of Infix