Fix rustdoc warnings (#21)

crates/pallet-bitcoin/src/lib.rs

@@ -1,10 +1,11 @@
 //! # Bitcoin Pallet
 //!
-//! This pallet is designed to be minimalist, containing only one storage item for maintaining the state
-//! of the UTXO (Unspent Transaction Output) set by processing the inputs and outputs of each Bitcoin
-//! transaction wrapped in [`Call::transact`]. There is no verification logic within the
-//! pallet, all validation work should be performed outside the runtime. This approach simplifies
-//! off-runtime execution, allowing for easier syncing performance optimization.
+//! This pallet is designed to be minimalist, containing only one storage item for maintaining
+//! the state of the UTXO (Unspent Transaction Output) set by processing the inputs and outputs
+//! of each Bitcoin transaction wrapped in [`Call::transact`]. There is no verification logic
+//! within the pallet, all validation work should be performed outside the runtime. This approach
+//! simplifies off-runtime execution, allowing for easier syncing performance optimization off
+//! chain.
 
 // Ensure we're `no_std` when compiling for Wasm.
 #![cfg_attr(not(feature = "std"), no_std)]

crates/sc-consensus-nakamoto/src/block_import.rs

@@ -1,3 +1,23 @@
+//! This module provides the implementation for importing Bitcoin blocks into Subcoin.
+//!
+//! Each Bitcoin block is converted into a Substrate block and imported into the database.
+//! The Bitcoin header is included in the Substrate header as a `DigestItem`, each Bitcoin
+//! transaction is wrapped into an unsigned extrinsic defined in pallet-bitcoin.
+//!
+//! Key components:
+//!
+//! - [`BitcoinBlockImporter`]
+//!     The main struct responsible for importing Bitcoin blocks and managing the import process.
+//!
+//! - [`BitcoinBlockImport`]
+//!     An async trait for importing Bitcoin blocks, which is implemented by [`BitcoinBlockImporter`].
+//!
+//! - [`ImportConfig`]
+//!     Configuration for block import, including network type, verification level, and execution options.
+//!
+//! - [`ImportStatus`]
+//!     An enum representing the result of an import operation, with variants for different import outcomes.
+
 use crate::block_executor::{BlockExecutor, ExecuteBlockResult};
 use crate::verification::{BlockVerification, BlockVerifier};
 use bitcoin::hashes::Hash;

crates/sc-consensus-nakamoto/src/import_queue.rs

@@ -128,7 +128,7 @@ async fn block_import_process(
 
 type BlockImportStatus = sc_consensus::BlockImportStatus<u32>;
 
-/// Result of [`import_many_blocks`].
+/// Result of `import_many_blocks`.
 #[derive(Debug)]
 pub struct ImportManyBlocksResult {
     /// The number of blocks imported successfully.

crates/subcoin-node/src/lib.rs

@@ -1,3 +1,7 @@
+//! Subcoin Node Library.
+//!
+//! The main feature of this library is to start and run the node as a CLI application.
+
 mod cli;
 mod commands;
 mod rpc;

crates/subcoin-rpc/src/subcoin.rs

@@ -40,7 +40,7 @@ where
     Block: BlockT + 'static,
     Client: HeaderBackend<Block> + BlockBackend<Block> + AuxStore + 'static,
 {
-    /// Constructs a new instance of [`Blockchain`].
+    /// Constructs a new instance of [`Subcoin`].
     pub fn new(client: Arc<Client>, network_handle: NetworkHandle) -> Self {
         Self {
             client,

crates/subcoin-runtime/src/lib.rs

@@ -15,8 +15,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Subcoin runtime is a minimalistic Substrate runtime, it does not implement all the typical
-//! runtime APIs the other runtimes would do.
+//! Subcoin runtime is a minimalistic Substrate runtime consisting of frame-system and
+//! pallet-bitcoin. It does not implement all the typical runtime APIs the normal runtimes
+//! would do as many of them does not make sense in Subcoin.
 
 #![cfg_attr(not(feature = "std"), no_std)]
 
@@ -255,7 +256,7 @@ mod types_common {
     // circular dependency (self-referential generics).
     pub type BlockOf<T, Extra = ()> = generic::Block<HeaderInner, ExtrinsicInner<T, Extra>>;
 
-    /// The opaque block type. This is the same [`BlockOf`], but it has
+    /// The opaque block type. This is the same `BlockOf`, but it has
     /// [`sp_runtime::OpaqueExtrinsic`] as its final extrinsic type.
     ///
     /// This should be provided to the client side as the extrinsic type.