doc: correct Swarm docs

rs-ipfs · Oct 7, 2020 · d5f4c72 · d5f4c72
1 parent 23fda6e
commit d5f4c72
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/p2p/mod.rs b/src/p2p/mod.rs
@@ -17,7 +17,7 @@ mod transport;
 pub use addr::{MultiaddrWithPeerId, MultiaddrWithoutPeerId};
 pub use {behaviour::KadResult, swarm::Connection};
 
-/// An IPFS swarm.
+/// Type alias for [`libp2p::Swarm`] running the [`behaviour::Behaviour`] with the given [`IpfsTypes`].
 pub type TSwarm<T> = Swarm<behaviour::Behaviour<T>>;
 
 /// Defines the configuration for an IPFS swarm.
@@ -30,7 +30,7 @@ pub struct SwarmOptions {
     pub bootstrap: Vec<(Multiaddr, PeerId)>,
     /// Enables mdns for peer discovery and announcement when true.
     pub mdns: bool,
-    /// Custom Kademlia protocol name.
+    /// Custom Kademlia protocol name, see [`IpfsOptions::kad_protocol`].
     pub kad_protocol: Option<String>,
 }