Add doc comments to all public API items and enforce deny(missing_docs)

[eshork]

Summary

Resolves #1.

• Adds /// doc comments to all 551 previously-undocumented public API items across peeroxide-dht and peeroxide crates
• Enforces #![deny(missing_docs)] in both crate roots to prevent future regressions
• Fixes broken intra-doc links in noise_wrap.rs (HandshakeIK, NoisePayload)

Verification

All three build gates pass clean:

Check	Result
cargo check --workspace	✅ 0 warnings, 0 errors
cargo test --workspace	✅ 483 pass, 0 fail
RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps	✅ clean

Files Changed (16 files, +585 -11)

peeroxide-dht:

• lib.rs — #![deny(missing_docs)] + module-level docs for 11 pub mod declarations
• compact_encoding.rs — 109 doc items
• hyperdht.rs — 92 doc items
• messages.rs — ~40 doc items
• rpc.rs — ~40 doc items
• protomux.rs — ~20 doc items
• blind_relay.rs — 18 doc items
• noise.rs — 9 doc items
• crypto.rs — 8 doc items
• noise_wrap.rs — 4 doc items + fixed broken intra-doc links
• secret_stream.rs — 3 struct field docs
• hyperdht_messages.rs — minor doc formatting

peeroxide:

• lib.rs — #![deny(missing_docs)]
• peer_info.rs — 21 doc items
• error.rs — 5 doc items
• swarm.rs — 1 doc item

[Copilot]

Pull request overview

Adds comprehensive Rustdoc coverage across the public APIs of peeroxide-dht and peeroxide, and enforces documentation completeness going forward via #![deny(missing_docs)].

Changes:

• Added #![deny(missing_docs)] to both crate roots to prevent future undocumented public API items.
• Added/expanded /// doc comments for public enums/structs/fields/functions across the DHT and swarm layers.
• Fixed broken intra-doc links in noise_wrap.rs.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
peeroxide/src/lib.rs	Enforces deny(missing_docs) at the crate level.
peeroxide/src/error.rs	Documents SwarmError variants.
peeroxide/src/peer_info.rs	Documents Priority, PeerInfo fields, and key methods.
peeroxide/src/swarm.rs	Documents SwarmConnection::remote_public_key.
peeroxide-dht/src/lib.rs	Enforces deny(missing_docs) and adds module-level docs for public modules.
peeroxide-dht/src/compact_encoding.rs	Adds public API docs for encoding state, errors, and encode/decode helpers.
peeroxide-dht/src/crypto.rs	Documents hashing/signing helpers and precomputed namespaces.
peeroxide-dht/src/messages.rs	Documents DHT RPC message types and encode/decode helpers.
peeroxide-dht/src/rpc.rs	Documents DhtError, public config/types, DhtHandle API, and spawn.
peeroxide-dht/src/protomux.rs	Documents Protomux public error/result types and frame/message structures.
peeroxide-dht/src/blind_relay.rs	Documents relay message structs and relay-client error/response types.
peeroxide-dht/src/noise.rs	Documents NoiseError and select public API fields/methods.
peeroxide-dht/src/noise_wrap.rs	Fixes intra-doc links and documents NoiseWrapError.
peeroxide-dht/src/secret_stream.rs	Documents SecretStreamError and public error payload fields.
peeroxide-dht/src/hyperdht_messages.rs	Documents wire constants, message structs, and encode/decode helpers.
peeroxide-dht/src/hyperdht.rs	Documents HyperDhtError, public result/config structs, handle methods, and server APIs.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.