From 639c548aed7b2bdb75cb9eb67cbc267f440eacb9 Mon Sep 17 00:00:00 2001 From: yancy Date: Mon, 8 May 2023 10:57:49 +0200 Subject: [PATCH] docs: Add doc comments for external crates --- bitcoin/src/lib.rs | 10 ++++++++++ hashes/src/lib.rs | 3 +++ 2 files changed, 13 insertions(+) diff --git a/bitcoin/src/lib.rs b/bitcoin/src/lib.rs index 1a6f2ea1..c8cec516 100644 --- a/bitcoin/src/lib.rs +++ b/bitcoin/src/lib.rs @@ -56,11 +56,21 @@ extern crate test; extern crate alloc; #[cfg(feature = "base64")] +/// Encodes and decodes base64 as bytes or utf8. pub extern crate base64; + +/// Encodes and decodes the Bech32 forrmat. pub extern crate bech32; + #[cfg(feature = "bitcoinconsensus")] +/// Bitcoin's libbitcoinconsensus with Rust binding. pub extern crate bitcoinconsensus; + +/// Rust implementation of cryptographic hash function algorithems. pub extern crate hashes; + +/// Rust wrapper library for Pieter Wuille's libsecp256k1. Implements ECDSA and BIP 340 signatures +/// for the SECG elliptic curve group secp256k1 and related utilities. pub extern crate secp256k1; #[cfg(feature = "serde")] diff --git a/hashes/src/lib.rs b/hashes/src/lib.rs index 840c3aa3..69f66564 100644 --- a/hashes/src/lib.rs +++ b/hashes/src/lib.rs @@ -85,8 +85,11 @@ extern crate alloc; extern crate core; #[cfg(feature = "core2")] extern crate core2; + #[cfg(feature = "serde")] +/// A generic serialization/deserialization framework. pub extern crate serde; + #[cfg(all(test, feature = "serde"))] extern crate serde_test; #[cfg(bench)]