doc: remove link to ocaml manual

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

View file

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

View file

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

View file

@ -4,10 +4,10 @@
@since 0.14 *) @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 module type of struct
include Char include Char
end end
(** @inline *)
val compare : t -> t -> int val compare : t -> t -> int
(** The comparison function for characters, with the same specification as (** The comparison function for characters, with the same specification as

View file

@ -10,10 +10,10 @@ type 'a iter = ('a -> unit) -> unit
see https://discuss.ocaml.org/t/extend-existing-module/1389/4 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 module type of struct
include Format include Format
end end
(** @inline *)
type t = Format.formatter type t = Format.formatter
type -'a printer = t -> 'a -> unit type -'a printer = t -> 'a -> unit

View file

@ -5,8 +5,7 @@
[@@@ifge 4.08] [@@@ifge 4.08]
include module type of Int 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] [@@@endif]

View file

@ -13,10 +13,10 @@
@since 2.1 *) @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 module type of struct
include Int32 include Int32
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].

View file

@ -13,10 +13,10 @@
@since 0.13 *) @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 module type of struct
include Int64 include Int64
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].

View file

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

View file

@ -11,7 +11,7 @@ type 'a printer = Format.formatter -> 'a -> unit
type 'a random_gen = Random.State.t -> 'a type 'a random_gen = Random.State.t -> 'a
include module type of ListLabels 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 type 'a t = 'a list

View file

@ -14,10 +14,10 @@
@since 2.1 *) @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 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].

View file

@ -2,10 +2,10 @@
(** Random Generators *) (** 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 module type of struct
include Random include Random
end end
(** @inline *)
type state = Random.State.t type state = Random.State.t

View file

@ -8,10 +8,10 @@ type 'a iter = ('a -> unit) -> unit
type 'a gen = unit -> 'a option 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 module type of struct
include String include String
end end
(** @inline *)
val length : t -> int val length : t -> int
(** [length s] returns the length (number of characters) of the given string [s]. *) (** [length s] returns the length (number of characters) of the given string [s]. *)