From 0a167dc3ddb3744a308e66f833b7a6840e3d59b5 Mon Sep 17 00:00:00 2001 From: Fardale Date: Wed, 15 Feb 2023 11:58:43 +0100 Subject: [PATCH] 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. --- src/core/CCArray.mli | 9 +++------ src/core/CCArrayLabels.mli | 9 +++------ src/core/CCChar.mli | 2 +- src/core/CCFormat.mli | 2 +- src/core/CCInt.mli | 3 +-- src/core/CCInt32.mli | 2 +- src/core/CCInt64.mli | 2 +- src/core/CCList.mli | 6 ++---- src/core/CCListLabels.mli | 2 +- src/core/CCNativeint.mli | 2 +- src/core/CCRandom.mli | 2 +- src/core/CCString.mli | 2 +- 12 files changed, 17 insertions(+), 26 deletions(-) diff --git a/src/core/CCArray.mli b/src/core/CCArray.mli index 487bf760..89970e24 100644 --- a/src/core/CCArray.mli +++ b/src/core/CCArray.mli @@ -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 diff --git a/src/core/CCArrayLabels.mli b/src/core/CCArrayLabels.mli index 85e2e3c3..a6fa09e4 100644 --- a/src/core/CCArrayLabels.mli +++ b/src/core/CCArrayLabels.mli @@ -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 diff --git a/src/core/CCChar.mli b/src/core/CCChar.mli index cc646fd4..80d32653 100644 --- a/src/core/CCChar.mli +++ b/src/core/CCChar.mli @@ -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 diff --git a/src/core/CCFormat.mli b/src/core/CCFormat.mli index a5bc11ed..d762574f 100644 --- a/src/core/CCFormat.mli +++ b/src/core/CCFormat.mli @@ -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 diff --git a/src/core/CCInt.mli b/src/core/CCInt.mli index e39ee474..3c0e0f49 100644 --- a/src/core/CCInt.mli +++ b/src/core/CCInt.mli @@ -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] diff --git a/src/core/CCInt32.mli b/src/core/CCInt32.mli index c3c8403f..732ab3e5 100644 --- a/src/core/CCInt32.mli +++ b/src/core/CCInt32.mli @@ -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]. diff --git a/src/core/CCInt64.mli b/src/core/CCInt64.mli index d4e13e76..bbe89d4c 100644 --- a/src/core/CCInt64.mli +++ b/src/core/CCInt64.mli @@ -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]. diff --git a/src/core/CCList.mli b/src/core/CCList.mli index c7a15253..f620df87 100644 --- a/src/core/CCList.mli +++ b/src/core/CCList.mli @@ -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 diff --git a/src/core/CCListLabels.mli b/src/core/CCListLabels.mli index fb6a5c10..eaf238fb 100644 --- a/src/core/CCListLabels.mli +++ b/src/core/CCListLabels.mli @@ -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 diff --git a/src/core/CCNativeint.mli b/src/core/CCNativeint.mli index 62431152..0f9bbebc 100644 --- a/src/core/CCNativeint.mli +++ b/src/core/CCNativeint.mli @@ -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]. diff --git a/src/core/CCRandom.mli b/src/core/CCRandom.mli index d2149495..2282bd20 100644 --- a/src/core/CCRandom.mli +++ b/src/core/CCRandom.mli @@ -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 diff --git a/src/core/CCString.mli b/src/core/CCString.mli index 1174b258..2fe96b91 100644 --- a/src/core/CCString.mli +++ b/src/core/CCString.mli @@ -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]. *)