Skip to content

Commit

Permalink
docs: Add doc comments for external crates
Browse files Browse the repository at this point in the history
  • Loading branch information
yancyribbens committed May 8, 2023
1 parent dea6282 commit 639c548
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
10 changes: 10 additions & 0 deletions bitcoin/src/lib.rs
Expand Up @@ -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")]
Expand Down
3 changes: 3 additions & 0 deletions hashes/src/lib.rs
Expand Up @@ -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)]
Expand Down

0 comments on commit 639c548

Please sign in to comment.