diff options
author | Bukolab99 <112485492+Bukolab99@users.noreply.github.com> | 2022-12-14 13:24:40 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-14 13:24:40 +0100 |
commit | 24b3547ebeacfc3e0ba8a66b88d8a10824d5b5da (patch) | |
tree | 89c9de585bb1d95992147eb0f1b5b7997232b5b4 /stdlib | |
parent | 8c25e3266411dc8a2c2f8f92090464aeddbb93b7 (diff) | |
download | ocaml-24b3547ebeacfc3e0ba8a66b88d8a10824d5b5da.tar.gz |
Updated Documentation For Since Annotations (#11676)
Co-authored-by: Florian Angeletti <florian.angeletti@inria.fr>
Diffstat (limited to 'stdlib')
-rw-r--r-- | stdlib/format.mli | 13 | ||||
-rw-r--r-- | stdlib/sys.mli | 6 |
2 files changed, 16 insertions, 3 deletions
diff --git a/stdlib/format.mli b/stdlib/format.mli index b251ce1353..ef8093bb1b 100644 --- a/stdlib/format.mli +++ b/stdlib/format.mli @@ -493,9 +493,11 @@ coupled variables, margin and maximum indentation limit. *) type geometry = { max_indent:int; margin: int} +(** @since 4.08 *) val check_geometry: geometry -> bool -(** Check if the formatter geometry is valid: [1 < max_indent < margin] *) +(** Check if the formatter geometry is valid: [1 < max_indent < margin] + @since 4.08 *) val pp_set_geometry : formatter -> max_indent:int -> margin:int -> unit val set_geometry : max_indent:int -> margin:int -> unit @@ -983,6 +985,7 @@ val std_formatter : formatter val get_std_formatter : unit -> formatter (** [get_std_formatter ()] returns the current domain's standard formatter used to write to standard output. + @since 5.0 *) val err_formatter : formatter @@ -992,8 +995,9 @@ val err_formatter : formatter *) val get_err_formatter : unit -> formatter -(* [get_err_formatter ()] returns the current domain's formatter used to write +(** [get_err_formatter ()] returns the current domain's formatter used to write to standard error. + @since 5.0 *) val formatter_of_buffer : Buffer.t -> formatter @@ -1008,7 +1012,8 @@ val stdbuf : Buffer.t val get_stdbuf : unit -> Buffer.t (** [get_stdbuf ()] returns the current domain's string buffer in which the - current domain's string formatter writes. *) + current domain's string formatter writes. + @since 5.0 *) val str_formatter : formatter (** The initial domain's formatter to output to the {!stdbuf} string buffer. @@ -1019,6 +1024,7 @@ val str_formatter : formatter val get_str_formatter : unit -> formatter (** The current domain's formatter to output to the current domains string buffer. + @since 5.0 *) val flush_str_formatter : unit -> string @@ -1050,6 +1056,7 @@ val make_synchronized_formatter : When the formatter is used with multiple domains, the output from the domains will be interleaved with each other at points where the formatter is flushed, such as with {!print_flush}. + @since 5.0 *) val formatter_of_out_functions : diff --git a/stdlib/sys.mli b/stdlib/sys.mli index 6177d6ba2f..e214603e5c 100644 --- a/stdlib/sys.mli +++ b/stdlib/sys.mli @@ -357,8 +357,10 @@ val development_version : bool *) type extra_prefix = Plus | Tilde +(** @since 4.14 *) type extra_info = extra_prefix * string +(** @since 4.14 *) type ocaml_release_info = { major : int; @@ -366,8 +368,12 @@ type ocaml_release_info = { patchlevel : int; extra : extra_info option } +(** @since 4.14 *) val ocaml_release : ocaml_release_info +(** [ocaml_release] is the version of OCaml. + @since 4.14 +*) val enable_runtime_warnings: bool -> unit [@@alert unsynchronized_access |