Add some documentation to the bitmap macro

Author: winstonallo

Cargo.toml

@@ -5,7 +5,6 @@ members = ["macros"]
 name = "bitmap"
 version = "0.1.0"
 edition = "2024"
-test = true
 
 [dependencies]
 macros = { path = "./macros" }

macros/src/generator.rs

@@ -40,6 +40,7 @@ pub fn expand_bitmap(input: BitmapInput) -> syn::Result<TokenStream2> {
     });
 
     Ok(quote! {
+        #[derive(Debug, Clone, Copy)]
         #[repr(transparent)]
          pub struct #name(pub #storage_ty);
 

macros/src/lib.rs

@@ -4,6 +4,46 @@ use syn::parse_macro_input;
 mod generator;
 mod parser;
 
+/// Generates a bitmap struct from the given definition.
+///
+/// The macro expands to a newtype struct around a `u8` to `u64` (depending on the total size
+/// of the definition), with automatically generated getters and setters for each field.
+///
+/// ### Supported field types
+/// - `u1` through `u7`
+///
+/// ### Current Limitations
+/// - Total bit size must be ≤ 64 bits.
+/// - No values larger than `u7` currently supported
+///
+/// ### Generated API
+/// For each field `name: T`, the macro generates:
+/// - `fn name(&self) -> T` — returns the field value.
+/// - `fn set_name(&mut self, val: T)` — sets the field value.
+///
+/// ### Example
+/// ```
+/// # use macros::bitmap;
+///
+/// bitmap!(
+///     struct Player {
+///         imposter: u1,
+///         finished_tasks: u3,
+///         kills: u3,
+///     }
+/// );
+///
+/// let mut player = Player(0);
+/// assert_eq!(std::mem::size_of::<Player>(), 1);
+///
+/// player.set_imposter(1);
+/// player.set_finished_tasks(5);
+/// player.set_kills(3);
+///
+/// assert_eq!(player.imposter(), 1);
+/// assert_eq!(player.finished_tasks(), 5);
+/// assert_eq!(player.kills(), 3);
+/// ```
 #[proc_macro]
 pub fn bitmap(input: TokenStream) -> TokenStream {
     let parsed = parse_macro_input!(input as parser::BitmapInput);

src/lib.rs

@@ -1,5 +1,27 @@
-#[cfg(test)]
-use macros::bitmap;
+//! Generates a bitmap from the passed struct definition. The generated
+//! code includes a struct with getters and setters for each field.
+//! Supported types: `u1`, `u2`, `u3`, `u4`, `u5`, `u6`, and `u7`, maximum
+//! size: 64 bits.
+//!
+//! # Example:
+//! ```
+//! use macros::bitmap;
+//!
+//! bitmap!(
+//! 	struct Player {
+//!			imposter: u1,
+//! 		finished_tasks: u3,
+//! 		kills: u3,
+//!		}
+//! );
+//!
+//! let mut player = Player(0);
+//! assert_eq!(std::mem::size_of::<Player>(), 1);
+//! player.set_imposter(1);
+//! player.set_finished_tasks(5);
+//! player.set_kills(3);
+//! ```
+pub use macros::bitmap;
 
 #[test]
 fn one_bit() {