Document the map macro

phil-opp · phil-opp · commit bf9d375b4f21 · 2023-06-24T14:55:59.000+02:00
diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,7 @@
 # Unreleased
 
+- Fix: Add missing documentation of the `map` macro
+
 # 0.5.0 – 2023-06-24
 
 - **Breaking:** [New design based on raw pointers](https://github.com/rust-osdev/volatile/pull/29)
diff --git a/src/volatile_ptr/macros.rs b/src/volatile_ptr/macros.rs
@@ -1,4 +1,4 @@
-/// TODO
+/// Provides safe field projection for volatile pointers referencing structs.
 ///
 /// ## Examples
 ///

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/// TODO`
	`1`	`+/// Provides safe field projection for volatile pointers referencing structs.`
`2`	`2`	`///`
`3`	`3`	`/// ## Examples`
`4`	`4`	`///`