From f04338fd2b6170fe227df42a7df445063e0166ec Mon Sep 17 00:00:00 2001
From: modeco80 <lily.modeco80@protonmail.ch>
Date: Mon, 2 Dec 2024 03:27:59 -0500
Subject: [PATCH] add doc to a bit more

---
 src/hzclient.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/hzclient.rs b/src/hzclient.rs
index 59aada2..81526f3 100644
--- a/src/hzclient.rs
+++ b/src/hzclient.rs
@@ -1,3 +1,4 @@
+//! Hazelnut C++ client bindings.
 use std::ffi;
 
 pub(crate) mod sys {
@@ -6,8 +7,13 @@ pub(crate) mod sys {
     #[repr(u32)]
     #[allow(unused)] // it IS used, just not by Rust
     pub enum ResultCode {
+        /// The frame has not been changed. (This is implemented internally by comparing the frame serial; if it has changed then the frame has too)
         Unchanged,
+
+        /// The frame has been changed.
         Changed,
+
+        /// A failure occured during the tick.
         Fail,
     }