add doc to newtypes

esp-rs · Nov 5, 2024 · f8c46c6 · f8c46c6
1 parent 350c4ff
commit f8c46c6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/esp-wifi/src/wifi/event.rs b/esp-wifi/src/wifi/event.rs
@@ -74,6 +74,7 @@ impl<T: sealed::Event + 'static> EventExt for T {}
 macro_rules! impl_wifi_event {
     // no data
     ($newtype:ident) => {
+        /// See [`WifiEvent`].
         #[derive(Copy, Clone)]
         pub struct $newtype;
         impl sealed::Event for $newtype {
@@ -90,6 +91,7 @@ macro_rules! impl_wifi_event {
     // data
     ($newtype:ident, $data:ident) => {
         pub use esp_wifi_sys::include::$data;
+        /// See [`WifiEvent`].
         #[derive(Copy, Clone)]
         pub struct $newtype(pub $data);
         impl sealed::Event for $newtype {