simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 11:15:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: remove link to ocaml manual

Browse source 
The goal is to use odig to build the documentation and with odig the
comment of the function from the standard library are shown.
This commit is contained in:
Fardale 2023-02-15 11:58:43 +01:00
parent 8607de2749
commit 0a167dc3dd
12 changed files with 17 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/core/CCArray.mli
View file

@ -17,22 +17,19 @@ type 'a printer = Format.formatter -> 'a -> unit
[@@@ifge 4.8]
include module type of Array
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}
@inline *)
(** @inline *)
[@@@elifge 4.6]
include module type of Array
(** @inline
{{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
(** @inline *)
type 'a t = 'a array
[@@@else_]
include module type of Array
(** @inline
{{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
(** @inline *)
module Floatarray : sig
type t = float array

9
src/core/CCArrayLabels.mli
View file

@ -17,22 +17,19 @@ type 'a printer = Format.formatter -> 'a -> unit
[@@@ifge 4.8]
include module type of ArrayLabels with module Floatarray = Array.Floatarray
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}
@inline *)
(** @inline *)
[@@@elifge 4.6]
include module type of ArrayLabels with module Floatarray = Array.Floatarray
(** @inline
{{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
(** @inline *)
type 'a t = 'a array
[@@@else_]
include module type of ArrayLabels
(** @inline
{{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
(** @inline *)
module Floatarray = CCArray.Floatarray

2
src/core/CCChar.mli
View file

@ -4,10 +4,10 @@
@since 0.14 *)
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Char.html} Documentation for the standard Char module}*)
include module type of struct
include Char
end
(** @inline *)
val compare : t -> t -> int
(** The comparison function for characters, with the same specification as

2
src/core/CCFormat.mli
View file

@ -10,10 +10,10 @@ type 'a iter = ('a -> unit) -> unit
see https://discuss.ocaml.org/t/extend-existing-module/1389/4
*)
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Format.html} Documentation for the standard Format module}*)
include module type of struct
include Format
end
(** @inline *)
type t = Format.formatter
type -'a printer = t -> 'a -> unit

3
src/core/CCInt.mli
View file

@ -5,8 +5,7 @@
[@@@ifge 4.08]
include module type of Int
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int.html} Documentation for the standard Int module}
@inline *)
(** @inline *)
[@@@endif]

2
src/core/CCInt32.mli
View file

@ -13,10 +13,10 @@
@since 2.1 *)
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int32.html} Documentation for the standard Int32 module}*)
include module type of struct
include Int32
end
(** @inline *)
val min : t -> t -> t
(** [min x y] returns the minimum of the two integers [x] and [y].

2
src/core/CCInt64.mli
View file

@ -13,10 +13,10 @@
@since 0.13 *)
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int64.html} Documentation for the standard Int64 module}*)
include module type of struct
include Int64
end
(** @inline *)
val min : t -> t -> t
(** [min x y] returns the minimum of the two integers [x] and [y].

6
src/core/CCList.mli
View file

@ -13,16 +13,14 @@ type 'a random_gen = Random.State.t -> 'a
[@@@ifge 4.8]
include module type of List with type 'a t := 'a list
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/List.html} Documentation for the standard List module}
@inline *)
(** @inline *)
type +'a t = 'a list
[@@@else_]
include module type of List
(** @inline
{{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/List.html} Documentation for the standard List module}*)
(** @inline *)
type +'a t = 'a list

2
src/core/CCListLabels.mli
View file

@ -11,7 +11,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}*)
(** @inline *)
type 'a t = 'a list

2
src/core/CCNativeint.mli
View file

@ -14,10 +14,10 @@
@since 2.1 *)
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Nativeint.html} Documentation for the standard Nativeint module}*)
include module type of struct
include Nativeint
end
(** @inline *)
val min : t -> t -> t
(** [min x y] returns the minimum of the two integers [x] and [y].

2
src/core/CCRandom.mli
View file

@ -2,10 +2,10 @@
(** Random Generators *)
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Random.html} Documentation for the standard Random module}*)
include module type of struct
include Random
end
(** @inline *)
type state = Random.State.t

2
src/core/CCString.mli
View file

@ -8,10 +8,10 @@ type 'a iter = ('a -> unit) -> unit
type 'a gen = unit -> 'a option
(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/String.html} Documentation for the standard String module}*)
include module type of struct
include String
end
(** @inline *)
val length : t -> int
(** [length s] returns the length (number of characters) of the given string [s]. *)