From 60dd3100c0b300d332b8f25e9e47f271c16d3a58 Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Mon, 28 Aug 2023 00:38:11 -0600 Subject: [PATCH] curve: add `doc(hidden)` to serial backend modules (#568) We have a lot of backend types leaking via the public API, including e.g. `FieldElement51`: https://docs.rs/curve25519-dalek/latest/curve25519_dalek/backend/serial/u64/field/struct.FieldElement51.html At the very least, these types shouldn't be visible in the rustdoc. This PR hides them from the docs, but ideally we would hide them completely from the public API (which might technically be considered a breaking change, but IMO leaking them at all is a bug). --- curve25519-dalek/src/backend/serial/mod.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/curve25519-dalek/src/backend/serial/mod.rs b/curve25519-dalek/src/backend/serial/mod.rs index 13fef5c63..4baec838b 100644 --- a/curve25519-dalek/src/backend/serial/mod.rs +++ b/curve25519-dalek/src/backend/serial/mod.rs @@ -24,17 +24,21 @@ cfg_if! { if #[cfg(curve25519_dalek_backend = "fiat")] { #[cfg(curve25519_dalek_bits = "32")] + #[doc(hidden)] pub mod fiat_u32; #[cfg(curve25519_dalek_bits = "64")] + #[doc(hidden)] pub mod fiat_u64; } else { #[cfg(curve25519_dalek_bits = "32")] + #[doc(hidden)] pub mod u32; #[cfg(curve25519_dalek_bits = "64")] + #[doc(hidden)] pub mod u64; }