diff options
author | 2023-05-11 17:28:51 +0200 | |
---|---|---|
committer | 2023-05-11 17:28:51 +0200 | |
commit | cf434236e7e15e0fa05e5915b8d4d78dcaf1b7e8 (patch) | |
tree | 27d32b10298698c30a5a5abb55e3ce8a143bd184 | |
parent | 3220d472ac7ab2d11d6fc61d50bcbf9de91e1def (diff) | |
download | iced-cf434236e7e15e0fa05e5915b8d4d78dcaf1b7e8.tar.gz iced-cf434236e7e15e0fa05e5915b8d4d78dcaf1b7e8.tar.bz2 iced-cf434236e7e15e0fa05e5915b8d4d78dcaf1b7e8.zip |
Enable `doc_auto_cfg` when generating documentation
-rw-r--r-- | futures/src/backend/native.rs | 4 | ||||
-rw-r--r-- | futures/src/backend/native/smol.rs | 2 | ||||
-rw-r--r-- | futures/src/backend/native/thread_pool.rs | 1 | ||||
-rw-r--r-- | futures/src/lib.rs | 2 | ||||
-rw-r--r-- | graphics/src/lib.rs | 2 | ||||
-rw-r--r-- | runtime/src/lib.rs | 2 | ||||
-rw-r--r-- | src/lib.rs | 2 | ||||
-rw-r--r-- | src/window/icon.rs | 3 | ||||
-rw-r--r-- | wgpu/src/lib.rs | 2 | ||||
-rw-r--r-- | widget/src/helpers.rs | 3 | ||||
-rw-r--r-- | widget/src/lib.rs | 1 | ||||
-rw-r--r-- | winit/src/lib.rs | 2 |
12 files changed, 7 insertions, 19 deletions
diff --git a/futures/src/backend/native.rs b/futures/src/backend/native.rs index 4199ad16..85af2c88 100644 --- a/futures/src/backend/native.rs +++ b/futures/src/backend/native.rs @@ -1,16 +1,12 @@ //! Backends that are only available in native platforms: Windows, macOS, or Linux. -#[cfg_attr(docsrs, doc(cfg(feature = "tokio",)))] #[cfg(feature = "tokio")] pub mod tokio; -#[cfg_attr(docsrs, doc(cfg(feature = "async-std",)))] #[cfg(feature = "async-std")] pub mod async_std; -#[cfg_attr(docsrs, doc(cfg(feature = "smol",)))] #[cfg(feature = "smol")] pub mod smol; -#[cfg_attr(docsrs, doc(cfg(feature = "thread-pool",)))] #[cfg(feature = "thread-pool")] pub mod thread_pool; diff --git a/futures/src/backend/native/smol.rs b/futures/src/backend/native/smol.rs index 30bc8291..00d13d35 100644 --- a/futures/src/backend/native/smol.rs +++ b/futures/src/backend/native/smol.rs @@ -1,9 +1,7 @@ //! A `smol` backend. - use futures::Future; /// A `smol` executor. -#[cfg_attr(docsrs, doc(cfg(feature = "smol")))] #[derive(Debug)] pub struct Executor; diff --git a/futures/src/backend/native/thread_pool.rs b/futures/src/backend/native/thread_pool.rs index da5d4b9b..c96f2682 100644 --- a/futures/src/backend/native/thread_pool.rs +++ b/futures/src/backend/native/thread_pool.rs @@ -2,7 +2,6 @@ use futures::Future; /// A thread pool executor for futures. -#[cfg_attr(docsrs, doc(cfg(feature = "thread-pool")))] pub type Executor = futures::executor::ThreadPool; impl crate::Executor for Executor { diff --git a/futures/src/lib.rs b/futures/src/lib.rs index 397fc2d2..34d81e1e 100644 --- a/futures/src/lib.rs +++ b/futures/src/lib.rs @@ -16,7 +16,7 @@ )] #![forbid(unsafe_code, rust_2018_idioms)] #![allow(clippy::inherent_to_string, clippy::type_complexity)] -#![cfg_attr(docsrs, feature(doc_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub use futures; pub use iced_core as core; diff --git a/graphics/src/lib.rs b/graphics/src/lib.rs index 91f50282..12fc54f6 100644 --- a/graphics/src/lib.rs +++ b/graphics/src/lib.rs @@ -20,7 +20,7 @@ )] #![forbid(rust_2018_idioms)] #![allow(clippy::inherent_to_string, clippy::type_complexity)] -#![cfg_attr(docsrs, feature(doc_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] mod antialiasing; mod error; mod transformation; diff --git a/runtime/src/lib.rs b/runtime/src/lib.rs index d3b84c7d..50abf7b2 100644 --- a/runtime/src/lib.rs +++ b/runtime/src/lib.rs @@ -42,7 +42,7 @@ clippy::useless_conversion )] #![forbid(unsafe_code, rust_2018_idioms)] -#![cfg_attr(docsrs, feature(doc_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub mod clipboard; pub mod command; pub mod font; @@ -163,7 +163,7 @@ )] #![forbid(rust_2018_idioms, unsafe_code)] #![allow(clippy::inherent_to_string, clippy::type_complexity)] -#![cfg_attr(docsrs, feature(doc_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] use iced_widget::graphics; use iced_widget::renderer; use iced_widget::style; diff --git a/src/window/icon.rs b/src/window/icon.rs index b67b2ea3..0fe010ca 100644 --- a/src/window/icon.rs +++ b/src/window/icon.rs @@ -12,7 +12,6 @@ use std::path::Path; /// /// This will return an error in case the file is missing at run-time. You may prefer [`Self::from_file_data`] instead. #[cfg(feature = "image")] -#[cfg_attr(docsrs, doc(cfg(feature = "image")))] pub fn from_file<P: AsRef<Path>>(icon_path: P) -> Result<Icon, Error> { let icon = image_rs::io::Reader::open(icon_path)?.decode()?.to_rgba8(); @@ -24,7 +23,6 @@ pub fn from_file<P: AsRef<Path>>(icon_path: P) -> Result<Icon, Error> { /// This content can be included in your application at compile-time, e.g. using the `include_bytes!` macro. /// You can pass an explicit file format. Otherwise, the file format will be guessed at runtime. #[cfg(feature = "image")] -#[cfg_attr(docsrs, doc(cfg(feature = "image")))] pub fn from_file_data( data: &[u8], explicit_format: Option<image_rs::ImageFormat>, @@ -60,7 +58,6 @@ pub enum Error { /// The `image` crate reported an error. #[cfg(feature = "image")] - #[cfg_attr(docsrs, doc(cfg(feature = "image")))] #[error("Unable to create icon from a file: {0}")] ImageError(#[from] image_rs::error::ImageError), } diff --git a/wgpu/src/lib.rs b/wgpu/src/lib.rs index 4a92c345..7004416f 100644 --- a/wgpu/src/lib.rs +++ b/wgpu/src/lib.rs @@ -36,7 +36,7 @@ )] #![forbid(rust_2018_idioms)] #![allow(clippy::inherent_to_string, clippy::type_complexity)] -#![cfg_attr(docsrs, feature(doc_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub mod layer; pub mod settings; pub mod window; diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs index 336ac4ee..3f5136f8 100644 --- a/widget/src/helpers.rs +++ b/widget/src/helpers.rs @@ -310,7 +310,6 @@ where /// /// [`Image`]: widget::Image #[cfg(feature = "image")] -#[cfg_attr(docsrs, doc(cfg(feature = "image")))] pub fn image<Handle>(handle: impl Into<Handle>) -> crate::Image<Handle> { crate::Image::new(handle.into()) } @@ -320,7 +319,6 @@ pub fn image<Handle>(handle: impl Into<Handle>) -> crate::Image<Handle> { /// [`Svg`]: widget::Svg /// [`Handle`]: widget::svg::Handle #[cfg(feature = "svg")] -#[cfg_attr(docsrs, doc(cfg(feature = "svg")))] pub fn svg<Renderer>( handle: impl Into<core::svg::Handle>, ) -> crate::Svg<Renderer> @@ -333,7 +331,6 @@ where /// Creates a new [`Canvas`]. #[cfg(feature = "canvas")] -#[cfg_attr(docsrs, doc(cfg(feature = "canvas")))] pub fn canvas<P, Message, Renderer>( program: P, ) -> crate::Canvas<P, Message, Renderer> diff --git a/widget/src/lib.rs b/widget/src/lib.rs index ab1ab95b..9da13f9b 100644 --- a/widget/src/lib.rs +++ b/widget/src/lib.rs @@ -14,6 +14,7 @@ )] #![forbid(unsafe_code, rust_2018_idioms)] #![allow(clippy::inherent_to_string, clippy::type_complexity)] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub use iced_renderer as renderer; pub use iced_renderer::graphics; pub use iced_runtime as runtime; diff --git a/winit/src/lib.rs b/winit/src/lib.rs index 9f6bcebb..62d66d5e 100644 --- a/winit/src/lib.rs +++ b/winit/src/lib.rs @@ -29,7 +29,7 @@ )] #![forbid(rust_2018_idioms, unsafe_code)] #![allow(clippy::inherent_to_string, clippy::type_complexity)] -#![cfg_attr(docsrs, feature(doc_cfg))] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] pub use iced_graphics as graphics; pub use iced_runtime as runtime; pub use iced_runtime::core; |