diff --git a/chacha20_poly1305/src/lib.rs b/chacha20_poly1305/src/lib.rs index 42b2df3af..0deea843d 100644 --- a/chacha20_poly1305/src/lib.rs +++ b/chacha20_poly1305/src/lib.rs @@ -1,7 +1,10 @@ // SPDX-License-Identifier: CC0-1.0 +//! # ChaCha20 - Poly1305 +//! //! Combine the ChaCha20 stream cipher with the Poly1305 message authentication code //! to form an authenticated encryption with additional data (AEAD) algorithm. + #![no_std] // Experimental features we need. #![cfg_attr(docsrs, feature(doc_auto_cfg))] diff --git a/hashes/src/lib.rs b/hashes/src/lib.rs index 2b8d5924c..06cfbcda3 100644 --- a/hashes/src/lib.rs +++ b/hashes/src/lib.rs @@ -1,6 +1,6 @@ // SPDX-License-Identifier: CC0-1.0 -//! Rust hashes library. +//! # Rust Bitcoin Hashes Library //! //! This library implements the hash functions needed by Bitcoin. As an ancillary thing, it exposes //! hexadecimal serialization and deserialization, since these are needed to display hashes. diff --git a/io/src/lib.rs b/io/src/lib.rs index 3c020d0b4..0b7ee5093 100644 --- a/io/src/lib.rs +++ b/io/src/lib.rs @@ -1,6 +1,6 @@ // SPDX-License-Identifier: CC0-1.0 -//! Rust-Bitcoin I/O Library +//! # Rust Bitcoin I/O Library //! //! The [`std::io`] module is not exposed in `no-std` Rust so building `no-std` applications which //! require reading and writing objects via standard traits is not generally possible. Thus, this diff --git a/primitives/src/lib.rs b/primitives/src/lib.rs index 451a3c166..f73a7ce17 100644 --- a/primitives/src/lib.rs +++ b/primitives/src/lib.rs @@ -1,6 +1,6 @@ // SPDX-License-Identifier: CC0-1.0 -//! # Rust Bitcoin - primitive types. +//! # Rust Bitcoin - primitive types //! //! Primitive data types that are used throughout the [`rust-bitcoin`] ecosystem. //! diff --git a/units/src/lib.rs b/units/src/lib.rs index 4d3be98ac..5a9742986 100644 --- a/units/src/lib.rs +++ b/units/src/lib.rs @@ -1,6 +1,6 @@ // SPDX-License-Identifier: CC0-1.0 -//! Rust Bitcoin units library +//! # Rust Bitcoin - unit types //! //! This library provides basic types used by the Rust Bitcoin ecosystem.