diff options
author | Török Edwin <edwin@etorok.net> | 2016-12-09 00:45:15 +0200 |
---|---|---|
committer | Török Edwin <edwin@etorok.net> | 2017-02-21 17:11:51 +0200 |
commit | 20f61d7fb41f69ceed84b2a30a119719db7a4533 (patch) | |
tree | f0fa5f2de429f644a80dfe52c75e769d59520424 /otherlibs/unix | |
parent | 4a7560eb5558fc2648d95d5318841e88a6f97fb2 (diff) | |
download | ocaml-20f61d7fb41f69ceed84b2a30a119719db7a4533.tar.gz |
Documentation: improve @since annotations
Add missing @since annotations for OCaml versions 4.00.0 - 4.05.0,
and fix existing annotations as needed:
Format.ikprintf: clarify ambiguity on @since 4.0 annotation
See https://github.com/ocaml/ocaml/commit/b81519668f7fa3d84f1453dc022a0d4a9b722eb8
Hashtbl.is_randomized and ListLabels.sort_uniq should be @since 4.03
List.sort_uniq is 4.02 but ListLabels.sort_uniq is 4.03
See:
https://github.com/ocaml/ocaml/commit/512d128918544ae1da0c808e811f3a7f177524d2
https://github.com/ocaml/ocaml/commit/189d29bfcf98525f63c1c3c4a4a2be9989a62ef7
Diffstat (limited to 'otherlibs/unix')
-rw-r--r-- | otherlibs/unix/unix.mli | 18 | ||||
-rw-r--r-- | otherlibs/unix/unixLabels.mli | 15 |
2 files changed, 22 insertions, 11 deletions
diff --git a/otherlibs/unix/unix.mli b/otherlibs/unix/unix.mli index 6762c25316..cd25e2cb1c 100644 --- a/otherlibs/unix/unix.mli +++ b/otherlibs/unix/unix.mli @@ -301,11 +301,13 @@ val single_write : file_descr -> bytes -> int -> int -> int val write_substring : file_descr -> string -> int -> int -> int (** Same as [write], but take the data from a string instead of a byte - sequence. *) + sequence. + @since 4.02.0 *) val single_write_substring : file_descr -> string -> int -> int -> int (** Same as [single_write], but take the data from a string instead of - a byte sequence. *) + a byte sequence. + @since 4.02.0 *) (** {6 Interfacing with the standard input/output library} *) @@ -513,7 +515,8 @@ val map_file : file is shrunk. [Invalid_argument] or [Failure] may be raised in cases where argument - validation fails. *) + validation fails. + @since 4.05.0 *) (** {6 Operations on file names} *) @@ -822,7 +825,8 @@ val has_symlink : unit -> bool (** Returns [true] if the user is able to create symbolic links. On Windows, this indicates that the user not only has the SeCreateSymbolicLinkPrivilege but is also running elevated, if necessary. On other platforms, this is - simply indicates that the symlink system call is available. *) + simply indicates that the symlink system call is available. + @since 4.03.0 *) val readlink : string -> string (** Read the contents of a symbolic link. *) @@ -1278,7 +1282,8 @@ val send : file_descr -> bytes -> int -> int -> msg_flag list -> int val send_substring : file_descr -> string -> int -> int -> msg_flag list -> int (** Same as [send], but take the data from a string instead of a byte - sequence. *) + sequence. + @since 4.02.0 *) val sendto : file_descr -> bytes -> int -> int -> msg_flag list -> sockaddr -> int @@ -1287,7 +1292,8 @@ val sendto : val sendto_substring : file_descr -> string -> int -> int -> msg_flag list -> sockaddr -> int (** Same as [sendto], but take the data from a string instead of a - byte sequence. *) + byte sequence. + @since 4.02.0 *) (** {6 Socket options} *) diff --git a/otherlibs/unix/unixLabels.mli b/otherlibs/unix/unixLabels.mli index 5a6c80cfd2..b65e8b12dc 100644 --- a/otherlibs/unix/unixLabels.mli +++ b/otherlibs/unix/unixLabels.mli @@ -284,12 +284,14 @@ val single_write : file_descr -> buf:bytes -> pos:int -> len:int -> int val write_substring : file_descr -> buf:string -> pos:int -> len:int -> int (** Same as [write], but take the data from a string instead of a byte - sequence. *) + sequence. + @since 4.02.0 *) val single_write_substring : file_descr -> buf:string -> pos:int -> len:int -> int (** Same as [single_write], but take the data from a string instead of - a byte sequence. *) + a byte sequence. + @since 4.02.0 *) (** {6 Interfacing with the standard input/output library} *) @@ -630,7 +632,8 @@ val has_symlink : unit -> bool (** Returns [true] if the user is able to create symbolic links. On Windows, this indicates that the user not only has the SeCreateSymbolicLinkPrivilege but is also running elevated, if necessary. On other platforms, this is - simply indicates that the symlink system call is available. *) + simply indicates that the symlink system call is available. + @since 4.03.0 *) val readlink : string -> string (** Read the contents of a link. *) @@ -1035,7 +1038,8 @@ val send : val send_substring : file_descr -> buf:string -> pos:int -> len:int -> mode:msg_flag list -> int (** Same as [send], but take the data from a string instead of a byte - sequence. *) + sequence. + @since 4.02.0 *) val sendto : file_descr -> buf:bytes -> pos:int -> len:int -> mode:msg_flag list -> @@ -1046,7 +1050,8 @@ val sendto_substring : file_descr -> buf:string -> pos:int -> len:int -> mode:msg_flag list -> sockaddr -> int (** Same as [sendto], but take the data from a string instead of a - byte sequence. *) + byte sequence. + @since 4.02.0 *) |