docs

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 <[email protected]>
@@ -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();