ci: check docs of private items (#3715)

.github/workflows/ci.yml

@@ -277,7 +277,7 @@ jobs:
           override: true
 
       - name: "doc --lib --all-features"
-        run: cargo doc --lib --no-deps --all-features
+        run: cargo doc --lib --no-deps --all-features --document-private-items
         env:
           RUSTDOCFLAGS: --cfg docsrs
 

tokio-stream/src/stream_map.rs

@@ -605,7 +605,7 @@ mod rand {
     /// Fast random number generate
     ///
     /// Implement xorshift64+: 2 32-bit xorshift sequences added together.
-    /// Shift triplet [17,7,16] was calculated as indicated in Marsaglia's
+    /// Shift triplet `[17,7,16]` was calculated as indicated in Marsaglia's
     /// Xorshift paper: https://www.jstatsoft.org/article/view/v008i14/xorshift.pdf
     /// This generator passes the SmallCrush suite, part of TestU01 framework:
     /// http://simul.iro.umontreal.ca/testu01/tu01.html

tokio/src/io/driver/registration.rs

@@ -14,8 +14,9 @@ cfg_io_driver! {
     /// that it will receive task notifications on readiness. This is the lowest
     /// level API for integrating with a reactor.
     ///
-    /// The association between an I/O resource is made by calling [`new`]. Once
+    /// The association between an I/O resource is made by calling
-    /// the association is established, it remains established until the
+    /// [`new_with_interest_and_handle`].
+    /// Once the association is established, it remains established until the
     /// registration instance is dropped.
     ///
     /// A registration instance represents two separate readiness streams. One
@@ -36,7 +37,7 @@ cfg_io_driver! {
     /// stream. The write readiness event stream is only for `Ready::writable()`
     /// events.
     ///
-    /// [`new`]: method@Self::new
+    /// [`new_with_interest_and_handle`]: method@Self::new_with_interest_and_handle
     /// [`poll_read_ready`]: method@Self::poll_read_ready`
     /// [`poll_write_ready`]: method@Self::poll_write_ready`
     #[derive(Debug)]

tokio/src/io/poll_evented.rs

@@ -10,10 +10,10 @@ cfg_io_driver! {
     /// [`std::io::Write`] traits with the reactor that drives it.
     ///
     /// `PollEvented` uses [`Registration`] internally to take a type that
-    /// implements [`mio::Evented`] as well as [`std::io::Read`] and or
+    /// implements [`mio::event::Source`] as well as [`std::io::Read`] and or
     /// [`std::io::Write`] and associate it with a reactor that will drive it.
     ///
-    /// Once the [`mio::Evented`] type is wrapped by `PollEvented`, it can be
+    /// Once the [`mio::event::Source`] type is wrapped by `PollEvented`, it can be
     /// used from within the future's execution model. As such, the
     /// `PollEvented` type provides [`AsyncRead`] and [`AsyncWrite`]
     /// implementations using the underlying I/O resource as well as readiness
@@ -40,13 +40,13 @@ cfg_io_driver! {
     /// [`poll_read_ready`] again will also indicate read readiness.
     ///
     /// When the operation is attempted and is unable to succeed due to the I/O
-    /// resource not being ready, the caller must call [`clear_read_ready`] or
+    /// resource not being ready, the caller must call `clear_read_ready` or
-    /// [`clear_write_ready`]. This clears the readiness state until a new
+    /// `clear_write_ready`. This clears the readiness state until a new
     /// readiness event is received.
     ///
     /// This allows the caller to implement additional functions. For example,
     /// [`TcpListener`] implements poll_accept by using [`poll_read_ready`] and
-    /// [`clear_read_ready`].
+    /// `clear_read_ready`.
     ///
     /// ## Platform-specific events
     ///
@@ -54,17 +54,11 @@ cfg_io_driver! {
     /// These events are included as part of the read readiness event stream. The
     /// write readiness event stream is only for `Ready::writable()` events.
     ///
-    /// [`std::io::Read`]: trait@std::io::Read
+    /// [`AsyncRead`]: crate::io::AsyncRead
-    /// [`std::io::Write`]: trait@std::io::Write
+    /// [`AsyncWrite`]: crate::io::AsyncWrite
-    /// [`AsyncRead`]: trait@AsyncRead
+    /// [`TcpListener`]: crate::net::TcpListener
-    /// [`AsyncWrite`]: trait@AsyncWrite
+    /// [`poll_read_ready`]: Registration::poll_read_ready
-    /// [`mio::Evented`]: trait@mio::Evented
+    /// [`poll_write_ready`]: Registration::poll_write_ready
-    /// [`Registration`]: struct@Registration
-    /// [`TcpListener`]: struct@crate::net::TcpListener
-    /// [`clear_read_ready`]: method@Self::clear_read_ready
-    /// [`clear_write_ready`]: method@Self::clear_write_ready
-    /// [`poll_read_ready`]: method@Self::poll_read_ready
-    /// [`poll_write_ready`]: method@Self::poll_write_ready
     pub(crate) struct PollEvented<E: Source> {
         io: Option<E>,
         registration: Registration,

tokio/src/time/driver/entry.rs

@@ -85,7 +85,7 @@ const STATE_MIN_VALUE: u64 = STATE_PENDING_FIRE;
 /// requires only the driver lock.
 pub(super) struct StateCell {
     /// Holds either the scheduled expiration time for this timer, or (if the
-    /// timer has been fired and is unregistered), [`u64::max_value()`].
+    /// timer has been fired and is unregistered), `u64::max_value()`.
     state: AtomicU64,
     /// If the timer is fired (an Acquire order read on state shows
     /// `u64::max_value()`), holds the result that should be returned from

tokio/src/util/rand.rs

@@ -3,7 +3,7 @@ use std::cell::Cell;
 /// Fast random number generate
 ///
 /// Implement xorshift64+: 2 32-bit xorshift sequences added together.
-/// Shift triplet [17,7,16] was calculated as indicated in Marsaglia's
+/// Shift triplet `[17,7,16]` was calculated as indicated in Marsaglia's
 /// Xorshift paper: https://www.jstatsoft.org/article/view/v008i14/xorshift.pdf
 /// This generator passes the SmallCrush suite, part of TestU01 framework:
 /// http://simul.iro.umontreal.ca/testu01/tu01.html