anil.recoil.org
The unpac monorepo manager self-hosting as a monorepo using unpac
Merge pull request #35 from thedufer/fix-docstrings
fix docstrings
authored by
Spiros Eliopoulos
and committed by
GitHub
4a7eee1e
6fe770e8
+14
-15
vendor/opam/bigstringaf/lib/bigstringaf.mli
+14
-15
vendor/opam/bigstringaf/lib/bigstringaf.mli
···
71
71
interpreted as an unsigned integer. *)
72
72
73
73
val get_int16_sign_extended_le : t -> int -> int
74
-
(** [get_int16_le t i] returns the two bytes in [t] starting at offset [i],
75
-
interpreted as a signed integer and performing sign extension to the native
76
-
word size before returning the result. *)
74
+
(** [get_int16_sign_extended_le t i] returns the two bytes in [t] starting at
75
+
offset [i], interpreted as a signed integer and performing sign extension
76
+
to the native word size before returning the result. *)
77
77
78
78
val set_int16_le : t -> int -> int -> unit
79
79
(** [set_int16_le t i v] sets the two bytes in [t] starting at offset [i] to
···
87
87
the value [v]. *)
88
88
89
89
val get_int64_le : t -> int -> int64
90
-
(** [get_int16_le t i] returns the eight bytes in [t] starting at offset [i]. *)
90
+
(** [get_int64_le t i] returns the eight bytes in [t] starting at offset [i]. *)
91
91
92
92
val set_int64_le : t -> int -> int64 -> unit
93
93
(** [set_int64_le t i v] sets the eight bytes in [t] starting at offset [i] to
···
106
106
dealing with raw frames, for example, in a userland networking stack. *)
107
107
108
108
val get_int16_be : t -> int -> int
109
-
(** [get_int16_le t i] returns the two bytes in [t] starting at offset [i],
109
+
(** [get_int16_be t i] returns the two bytes in [t] starting at offset [i],
110
110
interpreted as an unsigned integer. *)
111
111
112
112
val get_int16_sign_extended_be : t -> int -> int
113
-
(** [get_int16_le t i] returns the two bytes in [t] starting at offset [i],
114
-
interpreted as a signed integer and performing sign extension to the native
115
-
word size before returning the result. *)
113
+
(** [get_int16_sign_extended_be t i] returns the two bytes in [t] starting at
114
+
offset [i], interpreted as a signed integer and performing sign extension
115
+
to the native word size before returning the result. *)
116
116
117
117
val set_int16_be : t -> int -> int -> unit
118
-
(** [set_int16_be t i v] sets the eight bytes in [t] starting at offset [off] to
118
+
(** [set_int16_be t i v] sets the two bytes in [t] starting at offset [off] to
119
119
the value [v]. *)
120
120
121
121
val get_int32_be : t -> int -> int32
122
-
(** [get_int64_be t i] returns the four bytes in [t] starting at offset [i]. *)
122
+
(** [get_int32_be t i] returns the four bytes in [t] starting at offset [i]. *)
123
123
124
124
val set_int32_be : t -> int -> int32 -> unit
125
-
(** [set_int32_be t i v] sets the eight bytes in [t] starting at offset [i] to
125
+
(** [set_int32_be t i v] sets the four bytes in [t] starting at offset [i] to
126
126
the value [v]. *)
127
127
128
128
val get_int64_be : t -> int -> int64
129
129
(** [get_int64_be t i] returns the eight bytes in [t] starting at offset [i]. *)
130
130
131
131
val set_int64_be : t -> int -> int64 -> unit
132
-
133
132
(** [set_int64_be t i v] sets the eight bytes in [t] starting at offset [i] to
134
133
the value [v]. *)
135
134
···
145
144
]}
146
145
147
146
And in fact, that's how they're implemented. Except that bounds checking
148
-
performed before performing the blit. *)
147
+
is performed before performing the blit. *)
149
148
150
149
val blit : t -> src_off:int -> t -> dst_off:int -> len:int -> unit
151
150
val blit_from_string : string -> src_off:int -> t -> dst_off:int -> len:int -> unit
···
155
154
156
155
(** {3 [memcmp]}
157
156
158
-
Fast comparisions based on [memcmp]. Simliar to the blits, these are
157
+
Fast comparisons based on [memcmp]. Similar to the blits, these are
159
158
implemented as C calls after performing bounds checks.
160
159
161
160
{[
···
259
258
260
259
(** {3 [memcmp]}
261
260
262
-
Fast comparisions based on [memcmp]. Simliar to the blits, these are not
261
+
Fast comparisons based on [memcmp]. Similar to the blits, these are not
263
262
memory safe and are implemented by the same C call:
264
263
265
264
{[