Add module and all-pub-things docs and deny missing docs

[rust-lightning] / src / ln / mod.rs

diff --git a/src/ln/mod.rs b/src/ln/mod.rs
index fe4eeed8e7d49d8e4742b7a03d1bc4e4021cf906..0f3b745443e378d5e53c77c26fc2f339a1693823 100644 (file)
--- a/src/ln/mod.rs
+++ b/src/ln/mod.rs
@@ -1,3 +1,12 @@
+//! High level lightning structs and impls live here.
+//! You probably want to create a channelmanager::ChannelManager, and a router::Router 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 Router.
+
 pub mod channelmanager;
 pub mod channelmonitor;
 pub mod msgs;