SpaceWire (ECSS-E-ST-50-12C) and RMAP (ECSS-E-ST-50-52C)
spacewire: fix doc format for rmap_command_exn and rmap_status_of_int (E410)
+4
-2
+4
-2
lib/spacewire.mli
+4
-2
lib/spacewire.mli
···
225
225
data_length:int ->
226
226
unit ->
227
227
rmap_command
228
-
(** Like {!rmap_command} but raises [Invalid_argument] on error. *)
228
+
(** [rmap_command_exn] is like {!rmap_command} but raises [Invalid_argument] on
229
+
error. *)
229
230
230
231
(** {1 RMAP Command Access} *)
231
232
···
356
357
(** Convert a status to its wire value. *)
357
358
358
359
val rmap_status_of_int : int -> rmap_status option
359
-
(** Convert a wire value to a status. Returns [None] for undefined codes. *)
360
+
(** [rmap_status_of_int n] converts a wire value to a status. Returns [None]
361
+
for undefined codes. *)