mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2026-03-07 21:27:55 -05:00
chore: inline the doc of the included modules
This commit is contained in:
parent
30f7ac7551
commit
405dfa4891
5 changed files with 5 additions and 0 deletions
|
|
@ -16,6 +16,7 @@ module type OrderedType = Map.OrderedType
|
||||||
|
|
||||||
module type S = sig
|
module type S = sig
|
||||||
include Map.S
|
include Map.S
|
||||||
|
(** @inline *)
|
||||||
|
|
||||||
val get : key -> 'a t -> 'a option
|
val get : key -> 'a t -> 'a option
|
||||||
(** [get k m] returns [Some v] if the current binding of [k] in [m] is [v],
|
(** [get k m] returns [Some v] if the current binding of [k] in [m] is [v],
|
||||||
|
|
|
||||||
|
|
@ -18,6 +18,7 @@
|
||||||
include module type of struct
|
include module type of struct
|
||||||
include Nativeint
|
include Nativeint
|
||||||
end
|
end
|
||||||
|
(** @inline *)
|
||||||
|
|
||||||
val min : t -> t -> t
|
val min : t -> t -> t
|
||||||
(** [min x y] returns the minimum of the two integers [x] and [y].
|
(** [min x y] returns the minimum of the two integers [x] and [y].
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,7 @@
|
||||||
@since 3.6 *)
|
@since 3.6 *)
|
||||||
|
|
||||||
include module type of Option
|
include module type of Option
|
||||||
|
(** @inline *)
|
||||||
|
|
||||||
val map_or : default:'b -> ('a -> 'b) -> 'a t -> 'b
|
val map_or : default:'b -> ('a -> 'b) -> 'a t -> 'b
|
||||||
(** [map_or ~default f o] is [f x] if [o = Some x], [default] otherwise.
|
(** [map_or ~default f o] is [f x] if [o = Some x], [default] otherwise.
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,7 @@
|
||||||
[@@@ifge 5.4]
|
[@@@ifge 5.4]
|
||||||
|
|
||||||
include module type of Pair
|
include module type of Pair
|
||||||
|
(** @inline *)
|
||||||
|
|
||||||
[@@@else_]
|
[@@@else_]
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,7 @@ type 'a printer = Format.formatter -> 'a -> unit
|
||||||
(** {2 Basics} *)
|
(** {2 Basics} *)
|
||||||
|
|
||||||
include module type of Result
|
include module type of Result
|
||||||
|
(** @inline *)
|
||||||
|
|
||||||
val return : 'a -> ('a, 'err) t
|
val return : 'a -> ('a, 'err) t
|
||||||
(** Successfully return a value. *)
|
(** Successfully return a value. *)
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue