Enforce no missing docs in all crates (+ add docs that were missing)

diff --git a/background-processor/src/lib.rs b/background-processor/src/lib.rs
index 23c18623dc59f90189bd47b831acf05b0d21655c..286bfeddf155123668200e2d5971979bd558d714 100644 (file)
--- a/background-processor/src/lib.rs
+++ b/background-processor/src/lib.rs
@@ -1,4 +1,9 @@
+//! Utilities that take care of tasks that (1) need to happen periodically to keep Rust-Lightning
+//! running properly, and (2) either can or should be run in the background. See docs for
+//! [`BackgroundProcessor`] for more details on the nitty-gritty.
+
 #![deny(broken_intra_doc_links)]
+#![deny(missing_docs)]
 #![deny(unsafe_code)]
 
 #[macro_use] extern crate lightning;

diff --git a/lightning-block-sync/src/http.rs b/lightning-block-sync/src/http.rs
index a33d919d05179c7adccc8bf40fc7ed86b467bb21..f745e138fb915eddff035d814ff62de1ab05c9e8 100644 (file)
--- a/lightning-block-sync/src/http.rs
+++ b/lightning-block-sync/src/http.rs
@@ -1,3 +1,6 @@
+//! Simple HTTP implementation which supports both async and traditional execution environments
+//! with minimal dependencies. This is used as the basis for REST and RPC clients.
+
 use chunked_transfer;
 use serde_json;
 

diff --git a/lightning-block-sync/src/init.rs b/lightning-block-sync/src/init.rs
index e9ff098940c67de501634781dc4cdc7a86c3484c..d51cd3ba606f9bd513326cc527ab677459b58b0d 100644 (file)
--- a/lightning-block-sync/src/init.rs
+++ b/lightning-block-sync/src/init.rs
@@ -1,3 +1,6 @@
+//! Utilities to assist in the initial sync required to initialize or reload Rust-Lightning objects
+//! from disk.
+
 use crate::{BlockSource, BlockSourceResult, Cache, ChainNotifier};
 use crate::poll::{ChainPoller, Validate, ValidatedBlockHeader};
 

diff --git a/lightning-block-sync/src/lib.rs b/lightning-block-sync/src/lib.rs
index 96f811d3ee580245672297b306d2b04937fb4a03..6f227b108601fa7796cb1f421fb0c8309937b75f 100644 (file)
--- a/lightning-block-sync/src/lib.rs
+++ b/lightning-block-sync/src/lib.rs
@@ -17,6 +17,7 @@
 //! [`BlockSource`]: trait.BlockSource.html
 
 #![deny(broken_intra_doc_links)]
+#![deny(missing_docs)]
 #![deny(unsafe_code)]
 
 #[cfg(any(feature = "rest-client", feature = "rpc-client"))]

diff --git a/lightning-block-sync/src/poll.rs b/lightning-block-sync/src/poll.rs
index 34be2437c8e2ddae1a3f2c07d43de702c036d10b..e769fe853c59981b355f3a26c6655af5e1d148d1 100644 (file)
--- a/lightning-block-sync/src/poll.rs
+++ b/lightning-block-sync/src/poll.rs
@@ -1,3 +1,5 @@
+//! Adapters that make one or more [`BlockSource`]s simpler to poll for new chain tip transitions.
+
 use crate::{AsyncBlockSourceResult, BlockHeaderData, BlockSource, BlockSourceError, BlockSourceResult};
 
 use bitcoin::blockdata::block::Block;

diff --git a/lightning-block-sync/src/rest.rs b/lightning-block-sync/src/rest.rs
index 3aff104d5546fe520407795d40e10307192a91ec..4c19388275fb935f18301600e211c118aeccda5b 100644 (file)
--- a/lightning-block-sync/src/rest.rs
+++ b/lightning-block-sync/src/rest.rs
@@ -1,3 +1,6 @@
+//! Simple REST client implementation which implements [`BlockSource`] against a Bitcoin Core REST
+//! endpoint.
+
 use crate::{BlockHeaderData, BlockSource, AsyncBlockSourceResult};
 use crate::http::{BinaryResponse, HttpEndpoint, HttpClient, JsonResponse};
 

diff --git a/lightning-block-sync/src/rpc.rs b/lightning-block-sync/src/rpc.rs
index d59401e0f1c090d084f811cc6b9d8be731887ff9..cc3bc4525a1289fbe0d87344b4c865458182f480 100644 (file)
--- a/lightning-block-sync/src/rpc.rs
+++ b/lightning-block-sync/src/rpc.rs
@@ -1,3 +1,6 @@
+//! Simple RPC client implementation which implements [`BlockSource`] against a Bitcoin Core RPC
+//! endpoint.
+
 use crate::{BlockHeaderData, BlockSource, AsyncBlockSourceResult};
 use crate::http::{HttpClient, HttpEndpoint, JsonResponse};
 

diff --git a/lightning-persister/src/lib.rs b/lightning-persister/src/lib.rs
index 1b343ce164f508f7cb0e99adfc3fc5f391751fe0..3db95f35a955e3b46113761eae91e26b105c1086 100644 (file)
--- a/lightning-persister/src/lib.rs
+++ b/lightning-persister/src/lib.rs
@@ -1,4 +1,7 @@
+//! Utilities that handle persisting Rust-Lightning data to disk via standard filesystem APIs.
+
 #![deny(broken_intra_doc_links)]
+#![deny(missing_docs)]
 
 mod util;
 
@@ -74,6 +77,7 @@ impl FilesystemPersister {
                }
        }
 
+       /// Get the directory which was provided when this persister was initialized.
        pub fn get_data_dir(&self) -> String {
                self.path_to_channel_data.clone()
        }