docs: add documentation comments to crate

Also, make it an error for a public symbol to not be documented.

Sponsored-by: author

1 files changed, 6 insertions, 1 deletions

diff --git a/src/benchmark.rs b/src/benchmark.rs
index e5057ac..d2d9003 100644
--- a/src/benchmark.rs
+++ b/src/benchmark.rs
@@ -1,15 +1,20 @@
+//! Benchmark chunk generation.
+//!
+//! This is only for development.
+
 use crate::checksummer::Checksum;
 use crate::chunk::DataChunk;
 use crate::chunkid::ChunkId;
 use crate::chunkmeta::ChunkMeta;
 
-// Generate a desired number of empty data chunks with id and metadata.
+/// Generate a desired number of empty data chunks with id and metadata.
 pub struct ChunkGenerator {
     goal: u32,
     next: u32,
 }
 
 impl ChunkGenerator {
+    /// Create a new ChunkGenerator.
     pub fn new(goal: u32) -> Self {
         Self { goal, next: 0 }
     }