Add more docs

1 files changed, 9 insertions, 7 deletions

diff --git a/lib/models/emoji.mli b/lib/models/emoji.mli
index 10b12d5..1660719 100644
--- a/lib/models/emoji.mli
+++ b/lib/models/emoji.mli
@@ -1,14 +1,16 @@
+(** A partial emoji, used internally. *)
 type partial_emoji = {
     id: Snowflake.t option;
     name: string;
 } [@@deriving sexp, yojson]
 
+(** A full emoji object. *)
 type t = {
-    id: Snowflake.t option;
-    name: string;
-    roles: Role_id.t list;
-    user: User_t.t option;
-    require_colons: bool option;
-    managed: bool option;
-    animated: bool option;
+    id: Snowflake.t option; (** Snowflake ID of the emoji. Only exists for custom emojis. *)
+    name: string; (** Name of the emoji. Either the emoji custom name or a unicode character. *)
+    roles: Role_id.t list;  (** List of roles required to use this emoji. Is only non-empty on some integration emojis. *)
+    user: User_t.t option;  (** User object of the person who uploaded the emoji. Only exists for custom emojis. *)
+    require_colons: bool; (** Whether the emoji must be wrapped in colons. Is false for unicode emojis. *)
+    managed: bool; (** Whether the emoji is managed by an integration. *)
+    animated: bool; (** Whether the emoji is animated. *)
 } [@@deriving sexp, yojson]
\ No newline at end of file