diff --git a/tokio-util/src/time/wheel/mod.rs b/tokio-util/src/time/wheel/mod.rs index 2ad70a97c..f310d10c1 100644 --- a/tokio-util/src/time/wheel/mod.rs +++ b/tokio-util/src/time/wheel/mod.rs @@ -10,15 +10,17 @@ use std::fmt::Debug; /// Timing wheel implementation. /// -/// This type provides the hashed timing wheel implementation that backs `Timer` -/// and `DelayQueue`. +/// This type provides the hashed timing wheel implementation that backs +/// [`DelayQueue`]. /// /// The structure is generic over `T: Stack`. This allows handling timeout data /// being stored on the heap or in a slab. In order to support the latter case, /// the slab must be passed into each function allowing the implementation to /// lookup timer entries. /// -/// See `Timer` documentation for some implementation notes. +/// See `Driver` documentation for some implementation notes. +/// +/// [`DelayQueue`]: crate::time::DelayQueue #[derive(Debug)] pub(crate) struct Wheel { /// The number of milliseconds elapsed since the wheel started. diff --git a/tokio/src/runtime/time/wheel/mod.rs b/tokio/src/runtime/time/wheel/mod.rs index 89adc8f2d..c0c51ef74 100644 --- a/tokio/src/runtime/time/wheel/mod.rs +++ b/tokio/src/runtime/time/wheel/mod.rs @@ -12,15 +12,12 @@ use super::EntryList; /// Timing wheel implementation. /// -/// This type provides the hashed timing wheel implementation that backs `Timer` -/// and `DelayQueue`. +/// This type provides the hashed timing wheel implementation that backs +/// [`Driver`]. /// -/// The structure is generic over `T: Stack`. This allows handling timeout data -/// being stored on the heap or in a slab. In order to support the latter case, -/// the slab must be passed into each function allowing the implementation to -/// lookup timer entries. +/// See [`Driver`] documentation for some implementation notes. /// -/// See `Timer` documentation for some implementation notes. +/// [`Driver`]: crate::runtime::time::Driver #[derive(Debug)] pub(crate) struct Wheel { /// The number of milliseconds elapsed since the wheel started. diff --git a/tokio/src/runtime/time_alt/wheel/mod.rs b/tokio/src/runtime/time_alt/wheel/mod.rs index f66a91c15..e7699457b 100644 --- a/tokio/src/runtime/time_alt/wheel/mod.rs +++ b/tokio/src/runtime/time_alt/wheel/mod.rs @@ -7,17 +7,11 @@ use super::{EntryHandle, EntryList, WakeQueue}; use std::array; -/// Timing wheel implementation. +/// Hashed timing wheel implementation. /// -/// This type provides the hashed timing wheel implementation that backs `Timer` -/// and `DelayQueue`. +/// See [`Driver`] documentation for some implementation notes. /// -/// The structure is generic over `T: Stack`. This allows handling timeout data -/// being stored on the heap or in a slab. In order to support the latter case, -/// the slab must be passed into each function allowing the implementation to -/// lookup timer entries. -/// -/// See `Timer` documentation for some implementation notes. +/// [`Driver`]: crate::runtime::time::Driver #[derive(Debug)] pub(crate) struct Wheel { /// The number of milliseconds elapsed since the wheel started.