X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fmod.rs;h=9522e83d18d1cbfa02ddcbe9d0b7ef91ba2d4925;hb=a551a6219c06d4ed149dcecc4553bc8a85e408f0;hp=1e5f49f07df6a0cc5056e6ea26545cfac33d04ec;hpb=e0b9b748d63698908266412a8817cc848bc0d18f;p=rust-lightning diff --git a/lightning/src/ln/mod.rs b/lightning/src/ln/mod.rs index 1e5f49f0..9522e83d 100644 --- a/lightning/src/ln/mod.rs +++ b/lightning/src/ln/mod.rs @@ -9,14 +9,17 @@ //! High level lightning structs and impls live here. //! -//! You probably want to create a channelmanager::ChannelManager, and a routing::NetGraphMsgHandler first. +//! You probably want to create a [`ChannelManager`], and a [`P2PGossipSync`] first. //! Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to //! create/manage connections and call get_and_clear_pending_events after each action, handling //! them appropriately. //! -//! When you want to open/close a channel or send a payment, call into your ChannelManager and when -//! you want to learn things about the network topology (eg get a route for sending a payment), -//! call into your NetGraphMsgHandler. +//! When you want to open/close a channel or send a payment, call into your [`ChannelManager`] and +//! when you want to learn things about the network topology (eg get a route for sending a payment), +//! call into your [`P2PGossipSync`]. +//! +//! [`ChannelManager`]: channelmanager::ChannelManager +//! [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync #[cfg(any(test, feature = "_test_utils"))] #[macro_use]