From 9172d3d372409d68294b403f8ed981b034b0c9b7 Mon Sep 17 00:00:00 2001
From: oberrich <6305520+oberrich@users.noreply.github.com>
Date: Wed, 10 Apr 2024 12:49:28 +0200
Subject: [PATCH] docs

---
 Cargo.lock |  2 +-
 src/lib.rs | 21 ++++++++++++---------
 2 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 0f8ef3a..6d42af9 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -297,7 +297,7 @@ checksum = "3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92"
 
 [[package]]
 name = "phnt"
-version = "0.0.15"
+version = "0.0.16"
 dependencies = [
  "bindgen",
  "chrono",
diff --git a/src/lib.rs b/src/lib.rs
index 5ceae90..a11efda 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,11 +1,3 @@
-#![doc = include_str!("../README.md")]
-#![allow(
-   warnings,
-   unused,
-   non_snake_case,
-   non_camel_case_types,
-   non_upper_case_globals
-)]
 // MIT License
 //
 // Copyright (c) 2024 oberrich <oberrich.llvm@proton.me>
@@ -28,16 +20,27 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 //
+#![doc = include_str!("../README.md")]
+#![allow(
+   warnings,
+   unused,
+   non_snake_case,
+   non_camel_case_types,
+   non_upper_case_globals
+)]
 
+/// Bindings for `phnt` (nightly) generated by `bindgen` 
 pub mod ffi {
    // use vendored `generated.rs` for docs.rs
    #[cfg(feature = "docsrs")]
    include!("ffi/generated.rs");
 
+   // use regenerated bindings in production
    #[cfg(not(feature = "docsrs"))]
    include!(concat!(env!("OUT_DIR"), "\\generated.rs"));
 }
 
+/// Extensions to the bindings (useful functions, macros, etc.)
 pub mod ext {
    use crate::ffi::*;
    use std::arch::asm;
@@ -54,7 +57,7 @@ pub mod ext {
          _o.SecurityQualityOfService = ::std::ptr::null_mut();
       }};
    }
-
+   
    macro_rules! FIELD_OFFSET {
      ($_type:ty, $field:ident$(.$cfields:ident)*) => {{
          let obj = core::mem::MaybeUninit::<$_type>::uninit();