From ef93c7448f6c74ec20bd7846cb324b836bb2e222 Mon Sep 17 00:00:00 2001
From: Adelyn Breelove <tenseiken595@gmail.com>
Date: Mon, 21 Jan 2019 12:14:58 -0700
Subject: More signature improvements

---
 lib/opcode.mli | 33 ++++++++++++++++++++++-----------
 1 file changed, 22 insertions(+), 11 deletions(-)

(limited to 'lib/opcode.mli')

diff --git a/lib/opcode.mli b/lib/opcode.mli
index e07f82e..b0e7adb 100644
--- a/lib/opcode.mli
+++ b/lib/opcode.mli
@@ -1,18 +1,29 @@
+(** Internal Opcode abstractions. *)
+
+(** Type of known opcodes. *)
 type t =
-    | DISPATCH
-    | HEARTBEAT
-    | IDENTIFY
-    | STATUS_UPDATE
-    | VOICE_STATE_UPDATE
-    | RESUME
-    | RECONNECT
-    | REQUEST_GUILD_MEMBERS
-    | INVALID_SESSION
-    | HELLO
-    | HEARTBEAT_ACK
+| DISPATCH
+| HEARTBEAT
+| IDENTIFY
+| STATUS_UPDATE
+| VOICE_STATE_UPDATE
+| RESUME
+| RECONNECT
+| REQUEST_GUILD_MEMBERS
+| INVALID_SESSION
+| HELLO
+| HEARTBEAT_ACK
 
+(** Raised when receiving an invalid opcode. This should never occur. *)
 exception Invalid_Opcode of int
 
+(** Converts an opcode to its integer form for outgoing frames. *)
 val to_int : t -> int
+
+(** Converts an integer to an opcode for incoming frames.
+    Raise {!Invalid_Opcode} Raised when an unkown opcode is received.
+*)
 val from_int : int -> t
+
+(** Converts and opcode to a human-readable string. Used for logging purposes. *)
 val to_string : t -> string
\ No newline at end of file
-- 
cgit v1.2.3