update @since tags

This commit is contained in:
Simon Cruanes 2014-08-07 14:24:52 +02:00
commit 072131dd3e
7 changed files with 19 additions and 19 deletions

View file

@ -48,7 +48,7 @@ val of_exn : exn -> 'a t
val fail_printf : ('a, Buffer.t, unit, 'a t) format4 -> 'a val fail_printf : ('a, Buffer.t, unit, 'a t) format4 -> 'a
(** [fail_printf format] uses [format] to obtain an error message (** [fail_printf format] uses [format] to obtain an error message
and then returns [`Error msg] and then returns [`Error msg]
@since NEXT_VERSION *) @since 0.3.3 *)
val map : ('a -> 'b) -> 'a t -> 'b t val map : ('a -> 'b) -> 'a t -> 'b t

View file

@ -29,7 +29,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
A simple abstraction over blocking IO, with strict evaluation. This is in A simple abstraction over blocking IO, with strict evaluation. This is in
no way an alternative to Lwt/Async if you need concurrency. no way an alternative to Lwt/Async if you need concurrency.
@since NEXT_RELEASE @since 0.3.3
*) *)
(** (**

View file

@ -50,11 +50,11 @@ val singleton : 'a -> 'a t
val repeat : ?n:int -> 'a -> 'a t val repeat : ?n:int -> 'a -> 'a t
(** [repeat ~n x] repeats [x] [n] times then stops. If [n] is omitted, (** [repeat ~n x] repeats [x] [n] times then stops. If [n] is omitted,
then [x] is repeated forever. then [x] is repeated forever.
@since NEXT_RELEASE *) @since 0.3.3 *)
val cycle : 'a t -> 'a t val cycle : 'a t -> 'a t
(** Cycle through the iterator infinitely. The iterator shouldn't be empty. (** Cycle through the iterator infinitely. The iterator shouldn't be empty.
@since NEXT_RELEASE *) @since 0.3.3 *)
val is_empty : 'a t -> bool val is_empty : 'a t -> bool
@ -91,23 +91,23 @@ val append : 'a t -> 'a t -> 'a t
val product_with : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t val product_with : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t
(** Fair product of two (possibly infinite) lists into a new list. Lazy. (** Fair product of two (possibly infinite) lists into a new list. Lazy.
The first parameter is used to combine each pair of elements The first parameter is used to combine each pair of elements
@since NEXT_RELEASE *) @since 0.3.3 *)
val product : 'a t -> 'b t -> ('a * 'b) t val product : 'a t -> 'b t -> ('a * 'b) t
(** Specialization of {!product_with} producing tuples (** Specialization of {!product_with} producing tuples
@since NEXT_RELEASE *) @since 0.3.3 *)
val group : 'a equal -> 'a t -> 'a t t val group : 'a equal -> 'a t -> 'a t t
(** [group eq l] groups together consecutive elements that satisfy [eq]. Lazy. (** [group eq l] groups together consecutive elements that satisfy [eq]. Lazy.
For instance [group (=) [1;1;1;2;2;3;3;1]] yields For instance [group (=) [1;1;1;2;2;3;3;1]] yields
[[1;1;1]; [2;2]; [3;3]; [1]] [[1;1;1]; [2;2]; [3;3]; [1]]
@since NEXT_RELEASE *) @since 0.3.3 *)
val uniq : 'a equal -> 'a t -> 'a t val uniq : 'a equal -> 'a t -> 'a t
(** [uniq eq l] returns [l] but removes consecutive duplicates. Lazy. (** [uniq eq l] returns [l] but removes consecutive duplicates. Lazy.
In other words, if several values that are equal follow one another, In other words, if several values that are equal follow one another,
only the first of them is kept. only the first of them is kept.
@since NEXT_RELEASE *) @since 0.3.3 *)
val flat_map : ('a -> 'b t) -> 'a t -> 'b t val flat_map : ('a -> 'b t) -> 'a t -> 'b t
@ -140,15 +140,15 @@ val merge : 'a ord -> 'a t -> 'a t -> 'a t
val sort : ?cmp:'a ord -> 'a t -> 'a t val sort : ?cmp:'a ord -> 'a t -> 'a t
(** Eager sort. Requires the iterator to be finite. O(n ln(n)) time (** Eager sort. Requires the iterator to be finite. O(n ln(n)) time
and space. and space.
@since NEXT_RELEASE *) @since 0.3.3 *)
val sort_uniq : ?cmp:'a ord -> 'a t -> 'a t val sort_uniq : ?cmp:'a ord -> 'a t -> 'a t
(** Eager sort that removes duplicate values. Requires the iterator to be (** Eager sort that removes duplicate values. Requires the iterator to be
finite. O(n ln(n)) time and space. finite. O(n ln(n)) time and space.
@since NEXT_RELEASE *) @since 0.3.3 *)
(** {2 Implementations} (** {2 Implementations}
@since NEXT_RELEASE *) @since 0.3.3 *)
val return : 'a -> 'a t val return : 'a -> 'a t
val pure : 'a -> 'a t val pure : 'a -> 'a t

View file

@ -226,7 +226,7 @@ module Zipper : sig
end end
(** {2 References on Lists} (** {2 References on Lists}
@since NEXT_RELEASE *) @since 0.3.3 *)
module Ref : sig module Ref : sig
type 'a t = 'a list ref type 'a t = 'a list ref

View file

@ -109,7 +109,7 @@ module Make(K : OrderedType)(V : OrderedType) : S with type key = K.t and type v
Represents n-to-n mappings between two types. Each element from the "left" Represents n-to-n mappings between two types. Each element from the "left"
is mapped to several right values, and conversely. is mapped to several right values, and conversely.
@since NEXT_RELEASE *) @since 0.3.3 *)
module type BIDIR = sig module type BIDIR = sig
type t type t

View file

@ -38,11 +38,11 @@ val map_same : ('a -> 'b) -> ('a*'a) -> ('b*'b)
val map_fst : ('a -> 'b) -> ('a * _) -> 'b val map_fst : ('a -> 'b) -> ('a * _) -> 'b
(** Compose the given function with [fst]. (** Compose the given function with [fst].
@since NEXT_RELEASE *) @since 0.3.3 *)
val map_snd : ('a -> 'b) -> (_ * 'a) -> 'b val map_snd : ('a -> 'b) -> (_ * 'a) -> 'b
(** Compose the given function with [snd]. (** Compose the given function with [snd].
@since NEXT_RELEASE *) @since 0.3.3 *)
val iter : ('a -> 'b -> unit) -> ('a * 'b) -> unit val iter : ('a -> 'b -> unit) -> ('a * 'b) -> unit
@ -67,16 +67,16 @@ val merge : ('a -> 'b -> 'c) -> ('a * 'b) -> 'c
val fold : ('a -> 'b -> 'c) -> ('a * 'b) -> 'c val fold : ('a -> 'b -> 'c) -> ('a * 'b) -> 'c
(** Synonym to {!merge} (** Synonym to {!merge}
@since NEXT_RELEASE *) @since 0.3.3 *)
val dup : 'a -> ('a * 'a) val dup : 'a -> ('a * 'a)
(** [dup x = (x,x)] (duplicate the value) (** [dup x = (x,x)] (duplicate the value)
@since NEXT_RELEASE *) @since 0.3.3 *)
val dup_map : ('a -> 'b) -> 'a -> ('a * 'b) val dup_map : ('a -> 'b) -> 'a -> ('a * 'b)
(** [dup_map f x = (x, f x)]. Duplicates the value and applies the function (** [dup_map f x = (x, f x)]. Duplicates the value and applies the function
to the second copy. to the second copy.
@since NEXT_RELEASE *) @since 0.3.3 *)
val equal : ('a -> 'a -> bool) -> ('b -> 'b -> bool) -> ('a * 'b) -> ('a * 'b) -> bool val equal : ('a -> 'a -> bool) -> ('b -> 'b -> bool) -> ('a * 'b) -> ('a * 'b) -> bool

View file

@ -64,7 +64,7 @@ val hash : t -> int
val init : int -> (int -> char) -> t val init : int -> (int -> char) -> t
(** Analog to [Array.init]. (** Analog to [Array.init].
@since NEXT_VERSION *) @since 0.3.3 *)
val of_gen : char gen -> t val of_gen : char gen -> t
val of_seq : char sequence -> t val of_seq : char sequence -> t