Check documentation building in CI

Now that we split out UniFFI to its own feature, we can make use of
the `missing_docs` lint again and enforce it in CI for release docs as
well as private items.

Author: tnull

.github/workflows/build.yml

@@ -24,6 +24,10 @@ jobs:
         run: cargo build --verbose --color always
       - name: Build with UniFFI support on Rust ${{ matrix.toolchain }}
         run: cargo build --features uniffi --verbose --color always
+      - name: Build documentation on Rust ${{ matrix.toolchain }}
+        run: |
+          cargo doc --release --verbose --color always
+          cargo doc --document-private-items --verbose --color always
       - name: Check release build on Rust ${{ matrix.toolchain }}
         run: cargo check --release --verbose --color always
       - name: Check release build with UniFFI support on Rust ${{ matrix.toolchain }}

src/io/mod.rs

@@ -54,6 +54,7 @@ pub(crate) const LATEST_NODE_ANN_BCAST_TIMESTAMP_KEY: &str = "latest_node_ann_bc
 /// Keys and namespaces are required to be valid ASCII strings and the empty namespace (`""`) is
 /// assumed to be valid namespace.
 pub trait KVStore: KVStorePersister {
+	/// A reader as returned by [`Self::read`].
 	type Reader: Read;
 	/// Returns a [`Read`] for the given `namespace` and `key` from which [`Readable`]s may be
 	/// read.

src/io/utils.rs

@@ -31,6 +31,7 @@ use super::KVStore;
 /// [`Builder::set_entropy_bip39_mnemonic`].
 ///
 /// [BIP 39]: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki
+/// [`Node`]: crate::Node
 /// [`Builder::set_entropy_bip39_mnemonic`]: crate::Builder::set_entropy_bip39_mnemonic
 pub fn generate_entropy_mnemonic() -> Mnemonic {
 	// bip39::Mnemonic supports 256 bit entropy max
@@ -121,7 +122,7 @@ where
 	})
 }
 
-/// Read a previously persisted [`Scorer`] from the store.
+/// Read a previously persisted [`ProbabilisticScorer`] from the store.
 pub(crate) fn read_scorer<
 	K: KVStore + Send + Sync,
 	G: Deref<Target = NetworkGraph<L>>,

src/lib.rs

@@ -67,12 +67,7 @@
 //! [`connect_open_channel`]: Node::connect_open_channel
 //! [`send_payment`]: Node::send_payment
 //!
-
-// We currently disable the missing_docs lint due to incompatibility with the generated Uniffi
-// scaffolding.
-// TODO: Re-enable after https://github.com/mozilla/uniffi-rs/issues/1502 has been
-// addressed.
-//#![deny(missing_docs)]
+#![cfg_attr(not(feature = "uniffi"), deny(missing_docs))]
 #![deny(rustdoc::broken_intra_doc_links)]
 #![deny(rustdoc::private_intra_doc_links)]
 #![allow(bare_trait_objects)]