doc: correct Swarm docs
@@ -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>,
}
