SpaceWire (ECSS-E-ST-50-12C) and RMAP (ECSS-E-ST-50-52C)
spacewire: document RMAP pp/compare values, fix _exn docs (merlint E400/E410)
+18
-1
+18
-1
lib/spacewire.mli
+18
-1
lib/spacewire.mli
···
74
74
Returns [Error `Cargo_empty] if [cargo] is empty. *)
75
75
76
76
val packet_exn : ?address:int list -> cargo:string -> eop -> packet
77
-
(** Like {!packet} but raises [Invalid_argument] on error. *)
77
+
(** [packet_exn] is like {!packet} but raises [Invalid_argument] on error. *)
78
78
79
79
val address : packet -> int list
80
80
(** [address p] returns the path address bytes. *)
···
323
323
(** {1 RMAP Comparison and Printing} *)
324
324
325
325
val equal_rmap_command : rmap_command -> rmap_command -> bool
326
+
326
327
val compare_rmap_command : rmap_command -> rmap_command -> int
328
+
(** [compare_rmap_command] is the comparison function for RMAP commands. *)
329
+
327
330
val pp_rmap_command : rmap_command Fmt.t
331
+
(** [pp_rmap_command] is the pretty-printer for RMAP commands. *)
332
+
328
333
val equal_rmap_reply : rmap_reply -> rmap_reply -> bool
334
+
329
335
val compare_rmap_reply : rmap_reply -> rmap_reply -> int
336
+
(** [compare_rmap_reply] is the comparison function for RMAP replies. *)
337
+
330
338
val pp_rmap_reply : rmap_reply Fmt.t
339
+
(** [pp_rmap_reply] is the pretty-printer for RMAP replies. *)
340
+
331
341
val pp_rmap_command_code : rmap_command_code Fmt.t
342
+
(** [pp_rmap_command_code] is the pretty-printer for RMAP command codes. *)
343
+
332
344
val pp_rmap_status : rmap_status Fmt.t
345
+
(** [pp_rmap_status] is the pretty-printer for RMAP status codes. *)
346
+
333
347
val pp_rmap_ack : rmap_ack Fmt.t
348
+
(** [pp_rmap_ack] is the pretty-printer for RMAP ack types. *)
349
+
334
350
val pp_rmap_increment : rmap_increment Fmt.t
351
+
(** [pp_rmap_increment] is the pretty-printer for RMAP increment types. *)
335
352
336
353
(** {1 RMAP Status Codes} *)
337
354