From 3218316420ee071806c7048a32d4c999de06cecf Mon Sep 17 00:00:00 2001
From: Mads Marquart <mads@marquart.dk>
Date: Sat, 7 Jun 2025 15:43:38 +0200
Subject: [PATCH] Document platform-specific modules

---
 winit/src/platform/mod.rs | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/winit/src/platform/mod.rs b/winit/src/platform/mod.rs
index 14e215a0..34efd0ff 100644
--- a/winit/src/platform/mod.rs
+++ b/winit/src/platform/mod.rs
@@ -1,6 +1,25 @@
-//! Contains traits with platform-specific methods in them.
+//! # Platform implementations
 //!
-//! Only the modules corresponding to the platform you're compiling to will be available.
+//! This module re-exports the platform-specific implementation crates that are used by default in
+//! Winit.
+//!
+//! Only the crates / modules corresponding to the platform you're compiling to will be available.
+//!
+//! | Platform | Crate | Module |
+//! | -------- | ----- | ------ |
+#![doc = concat!("| Android | [`winit-android`](https://docs.rs/winit-android/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::android` |")]
+#![doc = concat!("| macOS | [`winit-appkit`](https://docs.rs/winit-appkit/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::macos` |")]
+#![doc = concat!("| Redox | [`winit-orbital`](https://docs.rs/winit-orbital/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::orbital` |")]
+#![doc = concat!("| iOS/visionOS/tvOS/Mac Catalyst | [`winit-uikit`](https://docs.rs/winit-uikit/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::ios` |")]
+#![doc = concat!("| Wayland | [`winit-wayland`](https://docs.rs/winit-wayland/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::wayland` |")]
+#![doc = concat!("| Web | [`winit-web`](https://docs.rs/winit-web/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::web` |")]
+#![doc = concat!("| Windows | [`winit-win32`](https://docs.rs/winit-win32/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::windows` |")]
+#![doc = concat!("| X11 | [`winit-x11`](https://docs.rs/winit-x11/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::x11` |")]
+//! ## Common modules
+//!
+//! Furthermore, we provide two modules for common functionality:
+//! - `scancode`, available on Windows, macOS, Wayland and X11.
+//! - `startup_notify`, available on Wayland and X11.
 
 #[cfg(android_platform)]
 pub use winit_android as android;
@@ -10,8 +29,6 @@ pub use winit_appkit as macos;
 pub use winit_orbital as orbital;
 #[cfg(ios_platform)]
 pub use winit_uikit as ios;
-#[cfg(any(x11_platform, wayland_platform))]
-pub mod startup_notify;
 #[cfg(wayland_platform)]
 pub use winit_wayland as wayland;
 #[cfg(web_platform)]
@@ -23,3 +40,5 @@ pub use winit_x11 as x11;
 
 #[cfg(any(windows_platform, macos_platform, x11_platform, wayland_platform, docsrs))]
 pub mod scancode;
+#[cfg(any(x11_platform, wayland_platform, docsrs))]
+pub mod startup_notify;