Enable doc_auto_cfg when generating documentation

This commit is contained in:
Héctor Ramón Jiménez 2023-05-11 17:28:51 +02:00
parent 3220d472ac
commit cf434236e7
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
12 changed files with 7 additions and 19 deletions

View file

@ -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;

View file

@ -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;

View file

@ -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 {

View file

@ -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;