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

Author: TheBlueMatt

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;

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;
 

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};
 

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"))]

lightning-block-sync/src/poll.rs

@@ -1,3 +1,5 @@
+//! Adapters which 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;

lightning-block-sync/src/rest.rs

@@ -1,3 +1,7 @@
+
+//! 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};
 

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};
 

lightning-persister/src/lib.rs

@@ -1,4 +1,7 @@
+//! Utilities which 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()
 	}