Document items behind feature flags

Cargo.toml

@@ -31,3 +31,7 @@ itertools = "0.10"
 [[example]]
 name = "evtest_tokio"
 required-features = ["tokio"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

src/lib.rs

@@ -86,6 +86,14 @@
 
 // should really be cfg(target_os = "linux") and maybe also android?
 #![cfg(unix)]
+// Flag items' docs' with their required feature flags, but only on docsrs so
+// that local docs can still be built on stable toolchains.
+// As of the time of writing, the stabilization plan is such that:
+// - Once stabilized, this attribute should be replaced with #![doc(auto_cfg)]
+// - Then in edition 2024, doc(auto_cfg) will become the default and the
+//   attribute can be removed entirely
+// (see https://github.com/rust-lang/rust/pull/100883#issuecomment-1264470491)
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 
 // has to be first for its macro
 #[macro_use]

src/raw_stream.rs

@@ -814,7 +814,7 @@ mod tokio_stream {
     ///
     /// This can be used by calling [`stream.next_event().await?`](Self::next_event), or if you
     /// need to pass it as a stream somewhere, the [`futures::Stream`](Stream) implementation.
-    /// There's also a lower-level [`poll_event`] function if you need to fetch an event from
+    /// There's also a lower-level [`Self::poll_event`] function if you need to fetch an event from
     /// inside a `Future::poll` impl.
     pub struct EventStream {
         device: AsyncFd<RawDevice>,

src/sync_stream.rs

@@ -739,7 +739,7 @@ mod tokio_stream {
     ///
     /// This can be used by calling [`stream.next_event().await?`](Self::next_event), or if you
     /// need to pass it as a stream somewhere, the [`futures::Stream`](Stream) implementation.
-    /// There's also a lower-level [`poll_event`] function if you need to fetch an event from
+    /// There's also a lower-level [`Self::poll_event`] function if you need to fetch an event from
     /// inside a `Future::poll` impl.
     pub struct EventStream {
         device: AsyncFd<Device>,

src/uinput.rs

@@ -537,7 +537,7 @@ mod tokio_stream {
     ///
     /// This can be used by calling [`stream.next_event().await?`](Self::next_event), or if you
     /// need to pass it as a stream somewhere, the [`futures::Stream`](Stream) implementation.
-    /// There's also a lower-level [`poll_event`] function if you need to fetch an event from
+    /// There's also a lower-level [`Self::poll_event`] function if you need to fetch an event from
     /// inside a `Future::poll` impl.
     pub struct VirtualEventStream {
         device: AsyncFd<VirtualDevice>,