doc: add missing docs for Swarm

Author: niklaslong

src/p2p/mod.rs

@@ -17,13 +17,20 @@ mod transport;
 pub use addr::{MultiaddrWithPeerId, MultiaddrWithoutPeerId};
 pub use {behaviour::KadResult, swarm::Connection};
 
+/// An IPFS swarm.
 pub type TSwarm<T> = Swarm<behaviour::Behaviour<T>>;
 
+/// Defines the configuration for an IPFS swarm.
 pub struct SwarmOptions {
+    /// The keypair for the PKI based identity of the local node.
     pub keypair: Keypair,
+    /// The peer address of the local node created from the keypair.
     pub peer_id: PeerId,
+    /// The peers to connect to on startup.
     pub bootstrap: Vec<(Multiaddr, PeerId)>,
+    /// Enables mdns for peer discovery and announcement when true.
     pub mdns: bool,
+    /// Custom Kademlia protocol name.
     pub kad_protocol: Option<String>,
 }
 

src/p2p/swarm.rs

@@ -15,7 +15,7 @@ use std::time::Duration;
 pub struct Connection {
     /// The connected peer along with its address.
     pub addr: MultiaddrWithPeerId,
-    /// Latest ping report on any of the connections
+    /// Latest ping report on any of the connections.
     pub rtt: Option<Duration>,
 }