add more documentation, add doc lint

crates/servicepoint/Cargo.toml

@@ -30,4 +30,7 @@ all_compressions = ["compression_zlib", "compression_bzip2", "compression_lzma",
 [dev-dependencies]
 # for examples
 clap = { version = "4.5", features = ["derive"] }
-rand = "0.8"
+rand = "0.8"
+
+[lints]
+workspace = true

crates/servicepoint/src/compression_code.rs

@@ -2,14 +2,19 @@
 #[repr(u16)]
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub enum CompressionCode {
+    /// no compression
     Uncompressed = 0x0,
     #[cfg(feature = "compression_zlib")]
+    /// compress using flate2 with zlib header
     Zlib = 0x677a,
     #[cfg(feature = "compression_bzip2")]
+    /// compress using bzip2
     Bzip2 = 0x627a,
     #[cfg(feature = "compression_lzma")]
+    /// compress using lzma
     Lzma = 0x6c7a,
     #[cfg(feature = "compression_zstd")]
+    /// compress using Zstandard
     Zstd = 0x7a73,
 }
 

crates/servicepoint/src/grid.rs

@@ -1,5 +1,14 @@
+/// A two-dimensional grid of `T`
 pub trait Grid<T> {
     #[must_use]
+    /// Creates a new Grid with the specified dimensions.
+    ///
+    /// # Arguments
+    ///
+    /// - width: size in x-direction
+    /// - height: size in y-direction
+    ///
+    /// returns: Grid with all cells initialized to default state.
     fn new(width: usize, height: usize) -> Self;
 
     /// Sets the value at the specified position

crates/servicepoint/src/lib.rs

@@ -1,3 +1,5 @@
+//! Abstractions for the UDP protocol of the CCCB servicepoint display.
+
 use std::time::Duration;
 
 pub use crate::bit_vec::BitVec;