Skip to content

Commit 15f9e53

Browse files
committed
fix documentation warnings
1 parent 7db79b7 commit 15f9e53

32 files changed

+315
-138
lines changed

jscomp/others/belt_Array.mli

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@ val range: int -> int -> int array
139139
range 3 3 = [|3|];;
140140
]}
141141
*)
142+
142143
val rangeBy: int -> int -> step:int -> int array
143144
(** [rangeBy start finish ~step]
144145

jscomp/others/belt_Id.mli

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ type ('a, 'id) cmp
5555
Its runtime representation is a [cmp] function, but signed with a
5656
type parameter, so that different hash functions type mismatch
5757
*)
58+
5859
module type Comparable = sig
5960
type identity
6061
type t

jscomp/others/belt_List.mli

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ val head: 'a t -> 'a option
5454
head [1;2;3] = Some 1 ;;
5555
]}
5656
*)
57+
5758
val headExn: 'a t -> 'a
5859
(** [headExn xs]
5960
@@ -90,6 +91,7 @@ val add: 'a t -> 'a -> 'a t
9091
add [1] 3 = [3;1];;
9192
]}
9293
*)
94+
9395
val get: 'a t -> int -> 'a option
9496
(** [get xs n]
9597
@@ -618,6 +620,7 @@ val keepMap: 'a t -> ('a -> 'b option) -> 'b t
618620
[-2;-4]
619621
]}
620622
*)
623+
621624
val partitionU: 'a t -> ('a -> bool [@bs]) -> 'a t * 'a t
622625
val partition: 'a t -> ('a -> bool) -> 'a t * 'a t
623626
(** [partition xs p] creates a pair of lists; the first list consists of all elements of [xs] that satisfy the predicate function [p]; the second list consists of all elements of [xs] that do not satisfy [p]
@@ -627,6 +630,7 @@ val partition: 'a t -> ('a -> bool) -> 'a t * 'a t
627630
([2;4], [1;3])
628631
]}
629632
*)
633+
630634
val unzip: ('a * 'b) t -> 'a t * 'b t
631635
(** [unzip xs] takes a list of pairs and creates a pair of lists. The first list contains all the first items of the pairs; the second list contains all the second items.
632636
@@ -635,6 +639,7 @@ val unzip: ('a * 'b) t -> 'a t * 'b t
635639
unzip [(1,2) ; (3,4) ; (5,6) ; (7,8)] = ([1;3;5;7], [2;4;6;8]);;
636640
]}
637641
*)
642+
638643
val getAssocU: ('a * 'c) t -> 'b -> ('a -> 'b -> bool [@bs]) -> 'c option
639644
val getAssoc: ('a * 'c) t -> 'b -> ('a -> 'b -> bool) -> 'c option
640645
(** [getAssoc xs k eq]

jscomp/others/belt_Map.ml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
than the generic type
1717
*)
1818
module Int = Belt_MapInt
19+
20+
1921
(** specalized when key type is [string], more efficient
2022
than the generic type *)
2123
module String = Belt_MapString

jscomp/others/belt_Map.mli

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,7 @@ val size: ('k, 'v, 'id) t -> int
205205
size (fromArray [2,"2"; 2,"1"; 3,"3"] ~id:(module IntCmp)) = 2 ;;
206206
]}
207207
*)
208+
208209
val toArray: ('k, 'v, 'id) t -> ('k * 'v) array
209210
(** [toArray s]
210211
@@ -213,6 +214,7 @@ val toArray: ('k, 'v, 'id) t -> ('k * 'v) array
213214
]}
214215
215216
*)
217+
216218
val toList: ('k, 'v, 'id) t -> ('k * 'v) list
217219
(** In increasing order
218220
@@ -226,13 +228,15 @@ val fromArray: ('k * 'v) array -> id:('k,'id) id -> ('k,'v,'id) t
226228
toArray (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) = [1,"1";2,"2";3,"3"]
227229
]}
228230
*)
231+
229232
val keysToArray: ('k, 'v, 'id) t -> 'k array
230233
(** [keysToArray s]
231234
@example {[
232235
keysToArray (fromArray [2,"2"; 1,"1"; 3,"3"] ~id:(module IntCmp)) =
233236
[|1;2;3|];;
234237
]}
235238
*)
239+
236240
val valuesToArray: ('k, 'v, 'id) t -> 'v array
237241
(** [valuesToArray s]
238242
@example {[
@@ -291,6 +295,7 @@ val getUndefined: ('k, 'v, 'id) t -> 'k -> 'v Js.undefined
291295
292296
@return [undefined] when not found
293297
*)
298+
294299
val getWithDefault:
295300
('k, 'v, 'id) t -> 'k -> 'v -> 'v
296301
(** [getWithDefault s k default]
@@ -300,6 +305,7 @@ val getWithDefault:
300305
@return [default] when [k] is not found
301306
302307
*)
308+
303309
val getExn: ('k, 'v, 'id) t -> 'k -> 'v
304310
(** [getExn s k]
305311

jscomp/others/belt_MutableMap.mli

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ val cmp:
5454
First compare by size, if size is the same,
5555
compare by key, value pair
5656
*)
57+
5758
val eqU: ('k, 'a, 'id) t -> ('k, 'a, 'id) t -> ('a -> 'a -> bool [@bs]) -> bool
5859
val eq: ('k, 'a, 'id) t -> ('k, 'a, 'id) t -> ('a -> 'a -> bool) -> bool
5960
(** [eq m1 m2 eqf] tests whether the maps [m1] and [m2] are
@@ -86,12 +87,16 @@ val some: ('k, 'a, 'id) t -> ('k -> 'a -> bool) -> bool
8687
(** [some m p] checks if at least one binding of the map
8788
satisfy the predicate [p].
8889
*)
90+
8991
val size: ('k, 'a, 'id) t -> int
9092

9193

9294
val toList: ('k, 'a, 'id) t -> ('k * 'a) list
9395
(** In increasing order*)
96+
9497
val toArray: ('k, 'a, 'id) t -> ('k * 'a) array
98+
(** In increasing order*)
99+
95100
val fromArray: ('k * 'a) array -> id:('k,'id) id -> ('k,'a,'id) t
96101
val keysToArray: ('k, _, _) t -> 'k array
97102
val valuesToArray: (_, 'a, _) t -> 'a array
@@ -121,6 +126,7 @@ val checkInvariantInternal: _ t -> unit
121126
val remove: ('k, 'a, 'id) t -> 'k -> unit
122127
(** [remove m x] do the in-place modification,
123128
*)
129+
124130
val removeMany: ('k, 'a, 'id) t -> 'k array -> unit
125131

126132
val set: ('k, 'a, 'id) t -> 'k -> 'a -> unit

jscomp/others/belt_MutableMapInt.mli

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,9 @@ val some: 'a t -> (key -> 'a -> bool) -> bool
7979
val size: 'a t -> int
8080
val toList: 'a t -> (key * 'a) list
8181
(** In increasing order *)
82-
val toArray: 'a t -> (key * 'a) array
8382

83+
val toArray: 'a t -> (key * 'a) array
84+
(** In increasing order *)
8485

8586
val fromArray: (key * 'a) array -> 'a t
8687
val keysToArray: 'a t -> key array
@@ -110,6 +111,7 @@ val checkInvariantInternal: _ t -> unit
110111

111112
val remove: 'a t -> key -> unit
112113
(** [remove m x] do the in-place modification *)
114+
113115
val removeMany: 'a t -> key array -> unit
114116

115117
val set: 'a t -> key -> 'a -> unit

jscomp/others/belt_MutableMapString.mli

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,9 @@ val some: 'a t -> (key -> 'a -> bool) -> bool
7979
val size: 'a t -> int
8080
val toList: 'a t -> (key * 'a) list
8181
(** In increasing order *)
82-
val toArray: 'a t -> (key * 'a) array
8382

83+
val toArray: 'a t -> (key * 'a) array
84+
(** In increasing order *)
8485

8586
val fromArray: (key * 'a) array -> 'a t
8687
val keysToArray: 'a t -> key array
@@ -110,6 +111,7 @@ val checkInvariantInternal: _ t -> unit
110111

111112
val remove: 'a t -> key -> unit
112113
(** [remove m x] do the in-place modification *)
114+
113115
val removeMany: 'a t -> key array -> unit
114116

115117
val set: 'a t -> key -> 'a -> unit

jscomp/others/belt_MutableQueue.mli

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ val peek: 'a t -> 'a option
4242

4343
val peekUndefined: 'a t -> 'a Js.undefined
4444
(** [peekUndefined q] returns [undefined] if not found *)
45+
4546
val peekExn: 'a t -> 'a
4647
(** [peekExn q]
4748

jscomp/others/belt_MutableSet.mli

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,9 @@ val partition: ('value, 'id) t -> ('value -> bool) -> ('value, 'id) t * ('value,
111111
val size: ('value, 'id) t -> int
112112
val toList: ('value, 'id) t -> 'value list
113113
(** In increasing order*)
114+
114115
val toArray: ('value, 'id) t -> 'value array
116+
(** In increasing order*)
115117

116118
val minimum: ('value, 'id) t -> 'value option
117119
val minUndefined: ('value, 'id) t -> 'value Js.undefined

0 commit comments

Comments
 (0)