mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-15 23:36:01 -05:00
doc(core): add link to the doc of std module
This commit is contained in:
parent
1469c72f30
commit
d09fe93c10
11 changed files with 26 additions and 3 deletions
|
|
@ -5,6 +5,7 @@
|
|||
@since 0.14 *)
|
||||
|
||||
include module type of struct include Char end
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Char.html} Documentation for the standard Char module}*)
|
||||
|
||||
val compare : t -> t -> int
|
||||
(** The comparison function for characters, with the same specification as
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ type 'a iter = ('a -> unit) -> unit
|
|||
see https://discuss.ocaml.org/t/extend-existing-module/1389/4
|
||||
*)
|
||||
include module type of struct include Format end
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Format.html} Documentation for the standard Format module}*)
|
||||
|
||||
type t = Format.formatter
|
||||
type 'a printer = t -> 'a -> unit
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@
|
|||
@since 2.1 *)
|
||||
|
||||
include module type of struct include Int32 end
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int32.html} Documentation for the standard Int32 module}*)
|
||||
|
||||
val min : t -> t -> t
|
||||
(** [min x y] returns the minimum of the two integers [x] and [y].
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@
|
|||
@since 0.13 *)
|
||||
|
||||
include module type of struct include Int64 end
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int64.html} Documentation for the standard Int64 module}*)
|
||||
|
||||
val min : t -> t -> t
|
||||
(** [min x y] returns the minimum of the two integers [x] and [y].
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ type 'a printer = Format.formatter -> 'a -> unit
|
|||
type 'a random_gen = Random.State.t -> 'a
|
||||
|
||||
include module type of List
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/List.html} Documentation for the standard List module}*)
|
||||
|
||||
type 'a t = 'a list
|
||||
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ type 'a printer = Format.formatter -> 'a -> unit
|
|||
type 'a random_gen = Random.State.t -> 'a
|
||||
|
||||
include module type of ListLabels
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/ListLabels.html} Documentation for the standard ListLabels module}*)
|
||||
|
||||
type 'a t = 'a list
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@
|
|||
@since 2.1 *)
|
||||
|
||||
include module type of struct include Nativeint end
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Nativeint.html} Documentation for the standard Nativeint module}*)
|
||||
|
||||
val min : t -> t -> t
|
||||
(** [min x y] returns the minimum of the two integers [x] and [y].
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@
|
|||
(** {1 Random Generators} *)
|
||||
|
||||
include module type of struct include Random end
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Random.html} Documentation for the standard Random module}*)
|
||||
|
||||
type state = Random.State.t
|
||||
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ type 'a gen = unit -> 'a option
|
|||
type 'a klist = unit -> [`Nil | `Cons of 'a * 'a klist]
|
||||
|
||||
include module type of struct include String end
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/String.html} Documentation for the standard String module}*)
|
||||
|
||||
val length : t -> int
|
||||
(** Return the length (number of characters) of the given string. *)
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ type 'a gen = unit -> 'a option
|
|||
type 'a klist = unit -> [`Nil | `Cons of 'a * 'a klist]
|
||||
|
||||
include module type of struct include StringLabels end
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/StringLabels.html} Documentation for the standard StringLabels module}*)
|
||||
|
||||
val length : t -> int
|
||||
(** Return the length (number of characters) of the given string. *)
|
||||
|
|
|
|||
|
|
@ -76,27 +76,37 @@ let shims_list_post_408 = "include List"
|
|||
|
||||
let shims_array_pre_406 = "
|
||||
include Array
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
|
||||
module Floatarray = struct type t = float array end
|
||||
type 'a t = 'a array
|
||||
"
|
||||
|
||||
let shims_array_label_pre_406 = "
|
||||
include ArrayLabels
|
||||
(** {{: http://caml.inria.fr/pub/docs/manual-ocaml/libref/ArrayLabels.html} Documentation for the standard ArrayLabels module}*)
|
||||
module Floatarray = CCShimsArray_.Floatarray
|
||||
type 'a t = 'a array
|
||||
"
|
||||
|
||||
let shims_array_label_406_408 = "
|
||||
include (ArrayLabels : module type of ArrayLabels with module Floatarray = Array.Floatarray)
|
||||
(** {{: http://caml.inria.fr/pub/docs/manual-ocaml/libref/ArrayLabels.html} Documentation for the standard ArrayLabels module}*)
|
||||
type 'a t = 'a array
|
||||
"
|
||||
|
||||
let shims_array_406_408 = "
|
||||
include Array
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
|
||||
type 'a t = 'a array
|
||||
"
|
||||
let shims_array_post_408 = "include Array"
|
||||
let shims_array_label_post_408 = "include (ArrayLabels : module type of ArrayLabels with module Floatarray = Array.Floatarray)"
|
||||
let shims_array_post_408 = "
|
||||
include Array
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
|
||||
"
|
||||
let shims_array_label_post_408 = "
|
||||
include (ArrayLabels : module type of ArrayLabels with module Floatarray = Array.Floatarray)
|
||||
(** {{: http://caml.inria.fr/pub/docs/manual-ocaml/libref/ArrayLabels.html} Documentation for the standard ArrayLabels module}*)
|
||||
"
|
||||
|
||||
let shims_let_op_pre_408 =
|
||||
"
|
||||
|
|
@ -151,7 +161,10 @@ let shims_let_op_post_408 =
|
|||
"
|
||||
|
||||
let shims_int_pre_408 = ""
|
||||
let shims_int_post_408 = "include Int"
|
||||
let shims_int_post_408 = "
|
||||
include Int
|
||||
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int.html} Documentation for the standard Int module}*)
|
||||
"
|
||||
|
||||
let () =
|
||||
C.main ~name:"mkshims" (fun c ->
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue