Move some of our documentation to docs.rs (#3478)

* Move platform-specific documentation to `winit::platform` module

* Document cargo features in crate docs

* Move version requirements to crate-level docs
This commit is contained in:
Mads Marquart 2024-02-23 15:35:18 +01:00 committed by GitHub
parent a127bd6f66
commit 97cfdd4b09
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 223 additions and 201 deletions

View file

@ -1,3 +1,19 @@
//! # macOS / AppKit
//!
//! Winit has an OS requirement of macOS 10.11 or higher (same as Rust
//! itself), and is regularly tested on macOS 10.14.
//!
//! A lot of functionality expects the application to be ready before you
//! start doing anything; this includes creating windows, fetching monitors,
//! drawing, and so on, see issues [#2238], [#2051] and [#2087].
//!
//! If you encounter problems, you should try doing your initialization inside
//! `Event::Resumed`.
//!
//! [#2238]: https://github.com/rust-windowing/winit/issues/2238
//! [#2051]: https://github.com/rust-windowing/winit/issues/2051
//! [#2087]: https://github.com/rust-windowing/winit/issues/2087
use std::os::raw::c_void;
#[cfg(feature = "serde")]