tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-09-08 00:00:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix invalid #[doc(inline)] warnings on latest nightly. (#3788)

Browse Source 
This commit fixed issue #3787 by removing [doc(inline)] from
macro `cfg_macros` and added proper #[doc(inline)] attributes
to `pub use` items inside `cfg_macros` calls.

It's probably not `cfg_macros`s responsibility to inlining public
macros, though it's conveninent to do so. Notice that in lib.rs:

cfg_macros! {
    /// Implementation detail of the `select!` macro. This macro is **not**
    /// intended to be used as part of the public API and is permitted to
    /// change.
    #[doc(hidden)]
    pub use tokio_macros::select_priv_declare_output_enum;

    ...
}

`#[doc(hidden)]` and `#[doc(inline)]` are conflict with each other
in the sense of correctness.

Fixes: #3787
This commit is contained in:
Aaron Taner
2021-05-18 01:28:17 +09:00
committed by GitHub
parent f3ed064a26
commit ce9ca45c92
3 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio-util/src/time/mod.rs
+1 -1
View File
@@ -12,9 +12,9 @@ use std::time::Duration;
mod wheel; mod wheel;
#[doc(inline)]
pub mod delay_queue; pub mod delay_queue;
#[doc(inline)]
pub use delay_queue::DelayQueue; pub use delay_queue::DelayQueue;
// ===== Internal utils ===== // ===== Internal utils =====
tokio/src/lib.rs
+8
View File
@@ -453,15 +453,20 @@ cfg_macros! {
#[cfg(feature = "rt-multi-thread")] #[cfg(feature = "rt-multi-thread")]
#[cfg(not(test))] // Work around for rust-lang/rust#62127 #[cfg(not(test))] // Work around for rust-lang/rust#62127
#[cfg_attr(docsrs, doc(cfg(feature = "macros")))] #[cfg_attr(docsrs, doc(cfg(feature = "macros")))]
#[doc(inline)]
pub use tokio_macros::main; pub use tokio_macros::main;
#[cfg(feature = "rt-multi-thread")] #[cfg(feature = "rt-multi-thread")]
#[cfg_attr(docsrs, doc(cfg(feature = "macros")))] #[cfg_attr(docsrs, doc(cfg(feature = "macros")))]
#[doc(inline)]
pub use tokio_macros::test; pub use tokio_macros::test;
cfg_not_rt_multi_thread! { cfg_not_rt_multi_thread! {
#[cfg(not(test))] // Work around for rust-lang/rust#62127 #[cfg(not(test))] // Work around for rust-lang/rust#62127
#[doc(inline)]
pub use tokio_macros::main_rt as main; pub use tokio_macros::main_rt as main;
#[doc(inline)]
pub use tokio_macros::test_rt as test; pub use tokio_macros::test_rt as test;
} }
} }
@@ -469,7 +474,10 @@ cfg_macros! {
// Always fail if rt is not enabled. // Always fail if rt is not enabled.
cfg_not_rt! { cfg_not_rt! {
#[cfg(not(test))] #[cfg(not(test))]
#[doc(inline)]
pub use tokio_macros::main_fail as main; pub use tokio_macros::main_fail as main;
#[doc(inline)]
pub use tokio_macros::test_fail as test; pub use tokio_macros::test_fail as test;
} }
} }
tokio/src/macros/cfg.rs
-1
View File
@@ -157,7 +157,6 @@ macro_rules! cfg_macros {
$( $(
#[cfg(feature = "macros")] #[cfg(feature = "macros")]
#[cfg_attr(docsrs, doc(cfg(feature = "macros")))] #[cfg_attr(docsrs, doc(cfg(feature = "macros")))]
#[doc(inline)]
$item $item
)* )*
} }