Added @since tags.

This commit is contained in:
jkloos 2016-04-05 17:55:36 +02:00
parent 3ef3465156
commit ec3c881939
3 changed files with 14 additions and 4 deletions

View file

@ -67,8 +67,10 @@ val iter : (int -> 'a -> unit) -> 'a t -> unit
val fold : (int -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val mapi : (int -> 'a -> 'b) -> 'a t -> 'b t
(** @since NEXT_RELEASE *)
val map : ('a -> 'b) -> 'a t -> 'b t
(** @since NEXT_RELEASE *)
val choose : 'a t -> (int * 'a) option

View file

@ -76,10 +76,14 @@ module type S = sig
(** Fold on key/value bindings. Will use {!WORD.of_list} to rebuild keys. *)
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
(** Map values, giving both key and value. Will use {!WORD.of_list} to rebuild keys. *)
(** Map values, giving both key and value. Will use {!WORD.of_list} to rebuild keys.
@since NEXT_RELEASE
*)
val map : ('a -> 'b) -> 'a t -> 'b t
(** Map values, giving only the value. *)
(** Map values, giving only the value.
@since NEXT_RELEASE
*)
val iter : (key -> 'a -> unit) -> 'a t -> unit
(** Same as {!fold}, but for effectful functions *)

View file

@ -63,10 +63,14 @@ module type S = sig
val fold : f:('b -> key -> 'a -> 'b) -> x:'b -> 'a t -> 'b
val mapi : f:(key -> 'a -> 'b) -> 'a t -> 'b t
(** Map values, giving both key and value. Will use {!WORD.of_list} to rebuild keys. *)
(** Map values, giving both key and value. Will use {!WORD.of_list} to rebuild keys.
@since NEXT_RELEASE
*)
val map : f:('a -> 'b) -> 'a t -> 'b t
(** Map values, giving only the value. *)
(** Map values, giving only the value.
@since NEXT_RELEASE
*)
val iter : f:(key -> 'a -> unit) -> 'a t -> unit