Fix some broken links in rustdoc

Author: Demi-Marie

core/src/lib.rs

@@ -23,17 +23,26 @@
 //! The main concepts of libp2p-core are:
 //!
 //! - A [`PeerId`] is a unique global identifier for a node on the network.
-//!   Each node must have a different `PeerId`. Normally, a `PeerId` is the
+//!   Each node must have a different [`PeerId`]. Normally, a [`PeerId`] is the
 //!   hash of the public key used to negotiate encryption on the
 //!   communication channel, thereby guaranteeing that they cannot be spoofed.
 //! - The [`Transport`] trait defines how to reach a remote node or listen for
-//!   incoming remote connections. See the `transport` module.
+//!   incoming remote connections. See the [`transport`] module.
 //! - The [`StreamMuxer`] trait is implemented on structs that hold a connection
 //!   to a remote and can subdivide this connection into multiple substreams.
-//!   See the `muxing` module.
+//!   See the [`muxing`] module.
 //! - The [`UpgradeInfo`], [`InboundUpgrade`] and [`OutboundUpgrade`] traits
 //!   define how to upgrade each individual substream to use a protocol.
 //!   See the `upgrade` module.
+//!
+//! [`PeerId`]: <struct.PeerId.html>
+//! [`UpgradeInfo`]: <upgrade/trait.UpgradeInfo.html>
+//! [`InboundUpgrade`]: <upgrade/trait.InboundUpgrade.html>
+//! [`OutboundUpgrade`]: <upgrade/trait.OutboundUpgrade.html>
+//! [`Transport`]: <transport/trait.Transport.html>
+//! [`transport`]: <transport/index.html>
+//! [`StreamMuxer`]: <muxing/trait.StreamMuxer.html>
+//! [`muxing`]: <muxing/index.html>
 
 mod keys_proto {
     include!(concat!(env!("OUT_DIR"), "/keys_proto.rs"));

core/src/transport/upgrade.rs

@@ -53,22 +53,26 @@ use std::{error::Error, fmt, pin::Pin, task::Context, task::Poll};
 ///
 /// The upgrade process is defined by the following stages:
 ///
-///    [`authenticate`](Builder::authenticate)`{1}`
-/// -> [`apply`](Builder::apply)`{*}`
-/// -> [`multiplex`](Builder::multiplex)`{1}`
+///    [`authenticate`](struct.Builder.html#method.authenticate)`{1}`
+/// -> [`apply`](struct.Builder.html#method.apply)`{*}`
+/// -> [`multiplex`](struct.Builder.html#method.multiplex)`{1}`
 ///
 /// It thus enforces the following invariants on every transport
-/// obtained from [`multiplex`](Builder::multiplex):
+/// obtained from [`multiplex`](struct.Builder.html#method.multiplex)
 ///
-///   1. The transport must be [authenticated](Builder::authenticate)
-///      and [multiplexed](Builder::multiplex).
+///   1. The transport must be [authenticated](struct.Builder.html#method.authenticate)
+///      and [multiplexed](struct.Builder.html#method.multiplex).
 ///   2. Authentication must precede the negotiation of a multiplexer.
 ///   3. Applying a multiplexer is the last step in the upgrade process.
 ///   4. The [`Transport::Output`] conforms to the requirements of a [`Network`],
 ///      namely a tuple of a [`ConnectionInfo`] (from the authentication upgrade) and a
 ///      [`StreamMuxer`] (from the multiplexing upgrade).
 ///
-/// [`Network`]: crate::nodes::Network
+/// [`ConnectionInfo`]: <../../nodes/collection/trait.ConnectionInfo.html>
+/// [`Network`]: <../../nodes/network/struct.Network.html>
+/// [`Transport`]: <../../transport/trait.Transport.html>
+/// [`Transport::Output`]: <../../transport/trait.Transport.html#associatedType.Output>
+/// [`StreamMuxer`]: <../../muxing/trait.StreamMuxing.html>
 pub struct Builder<T> {
     inner: T,
     version: upgrade::Version,
@@ -97,6 +101,8 @@ where
     ///
     ///   * I/O upgrade: `C -> (I, D)`.
     ///   * Transport output: `C -> (I, D)`
+    ///
+    /// [`ConnectionInfo`]: <../../nodes/collection/trait.ConnectionInfo.html>
     pub fn authenticate<C, D, U, I, E>(self, upgrade: U) -> Builder<
         AndThen<T, impl FnOnce(C, ConnectedPoint) -> Authenticate<C, U> + Clone>
     > where
@@ -151,6 +157,8 @@ where
     ///
     ///   * I/O upgrade: `C -> M`.
     ///   * Transport output: `(I, C) -> (I, M)`.
+    ///
+    /// [`StreamMuxer`]: <../../muxing/trait.StreamMuxing.html>
     pub fn multiplex<C, M, U, I, E>(self, upgrade: U)
         -> AndThen<T, impl FnOnce((I, C), ConnectedPoint) -> Multiplex<C, U, I> + Clone>
     where
@@ -174,6 +182,8 @@ where
 /// in the context of negotiating a secure channel.
 ///
 /// Configured through [`Builder::authenticate`].
+///
+/// [`Builder::authenticate`]: <../struct.Builder.html#method.authenticate>
 #[pin_project::pin_project]
 pub struct Authenticate<C, U>
 where
@@ -204,6 +214,8 @@ where
 /// top of an authenticated transport.
 ///
 /// Configured through [`Builder::multiplex`].
+///
+/// [`Builder::multiplex`]: <../struct.Builder.html#method.multiplex>
 #[pin_project::pin_project]
 pub struct Multiplex<C, U, I>
 where
@@ -239,7 +251,10 @@ type EitherUpgrade<C, U> = future::Either<InboundUpgradeApply<C, U>, OutboundUpg
 
 /// An upgrade on an authenticated, non-multiplexed [`Transport`].
 ///
-/// See [`Builder::upgrade`](Builder::upgrade).
+/// See [`Builder`](../struct.Builder.html)
+///
+/// [`Transport`]: <../../transport/trait.Transport.html>
+///
 #[derive(Debug, Copy, Clone)]
 pub struct Upgrade<T, U> { inner: T, upgrade: U }
 
@@ -319,6 +334,9 @@ where
 }
 
 /// The [`Transport::Dial`] future of an [`Upgrade`]d transport.
+///
+/// [`Transport::Dial`]: <../../transport/trait.Transport.html#associatedType.Dial>
+/// [`Upgrade`]: <../struct.Upgrade.html>
 pub struct DialUpgradeFuture<F, U, I, C>
 where
     U: OutboundUpgrade<Negotiated<C>>,
@@ -373,6 +391,9 @@ where
 }
 
 /// The [`Transport::Listener`] stream of an [`Upgrade`]d transport.
+///
+/// [`Transport::Listener`]: <../../transport/trait.Transport.html#associatedType.Listener>
+/// [`Upgrade`]: <../struct.Upgrade.html>
 pub struct ListenerStream<S, U> {
     stream: Pin<Box<S>>,
     upgrade: U
@@ -410,6 +431,9 @@ impl<S, U> Unpin for ListenerStream<S, U> {
 }
 
 /// The [`Transport::ListenerUpgrade`] future of an [`Upgrade`]d transport.
+///
+/// [`Transport::ListenerUpgrade`]: <../../transport/trait.Transport.html#associatedType.ListenerUpgrade>
+/// [`Upgrade`]: <../struct.Upgrade.html>
 pub struct ListenerUpgradeFuture<F, U, I, C>
 where
     C: AsyncRead + AsyncWrite + Unpin,