chore: pre-publish checks

Author: naorunaoru

Cargo.toml

@@ -8,6 +8,7 @@ description = "Demosaicing algorithms for Bayer and X-Trans CFA sensors"
 repository = "https://github.com/naorunaoru/demosaic"
 keywords = ["demosaic", "bayer", "xtrans", "raw", "image-processing"]
 categories = ["multimedia::images"]
+exclude = [".github/", ".gitignore", "Cargo.lock"]
 
 [features]
 default = ["std"]

README.md

@@ -1,5 +1,9 @@
 # demosaic
 
+[![crates.io](https://img.shields.io/crates/v/demosaic.svg)](https://crates.io/crates/demosaic)
+[![docs.rs](https://docs.rs/demosaic/badge.svg)](https://docs.rs/demosaic)
+[![CI](https://github.com/naorunaoru/demosaic/actions/workflows/ci.yml/badge.svg)](https://github.com/naorunaoru/demosaic/actions/workflows/ci.yml)
+
 Demosaicing algorithms for Bayer and X-Trans CFA sensors. Pure Rust, `no_std` compatible. *Not* blazingly fast, just moderately. Use at your own pace. 
 
 ## Algorithms

src/cfa.rs

@@ -1,9 +1,13 @@
 use core::fmt;
 
+/// Color channel in a CFA pattern.
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 pub enum Channel {
+    /// Red channel.
     Red = 0,
+    /// Green channel.
     Green = 1,
+    /// Blue channel.
     Blue = 2,
 }
 
@@ -94,23 +98,28 @@ impl CfaPattern {
         Self { pattern: shifted, width: self.width, height: self.height }
     }
 
+    /// Return the color channel at the given row and column (wraps modulo pattern size).
     #[inline]
     pub fn color_at(&self, row: usize, col: usize) -> Channel {
         self.pattern[(row % self.height) * self.width + (col % self.width)]
     }
 
+    /// Pattern width: 2 for Bayer, 6 for X-Trans.
     pub fn width(&self) -> usize {
         self.width
     }
 
+    /// Pattern height: 2 for Bayer, 6 for X-Trans.
     pub fn height(&self) -> usize {
         self.height
     }
 
+    /// Returns `true` if this is a 2x2 Bayer pattern.
     pub fn is_bayer(&self) -> bool {
         self.width == 2
     }
 
+    /// Returns `true` if this is a 6x6 X-Trans pattern.
     pub fn is_xtrans(&self) -> bool {
         self.width == 6
     }

src/error.rs

@@ -1,15 +1,36 @@
 use core::fmt;
 
+/// Errors returned by demosaicing operations.
 #[derive(Debug)]
 pub enum DemosaicError {
-    /// Input buffer length doesn't match width * height
-    InputSizeMismatch { expected: usize, got: usize },
-    /// Output buffer length doesn't match 3 * width * height
-    OutputSizeMismatch { expected: usize, got: usize },
-    /// Algorithm not supported for this CFA pattern
-    UnsupportedAlgorithm { algorithm: &'static str, cfa: &'static str },
-    /// Image too small for the chosen algorithm
-    ImageTooSmall { min_width: usize, min_height: usize },
+    /// Input buffer length doesn't match width * height.
+    InputSizeMismatch {
+        /// Expected number of elements.
+        expected: usize,
+        /// Actual number of elements.
+        got: usize,
+    },
+    /// Output buffer length doesn't match 3 * width * height.
+    OutputSizeMismatch {
+        /// Expected number of elements.
+        expected: usize,
+        /// Actual number of elements.
+        got: usize,
+    },
+    /// Algorithm not supported for this CFA pattern.
+    UnsupportedAlgorithm {
+        /// Name of the algorithm.
+        algorithm: &'static str,
+        /// CFA type (e.g. "Bayer", "X-Trans").
+        cfa: &'static str,
+    },
+    /// Image too small for the chosen algorithm.
+    ImageTooSmall {
+        /// Minimum required width.
+        min_width: usize,
+        /// Minimum required height.
+        min_height: usize,
+    },
 }
 
 impl fmt::Display for DemosaicError {

src/lib.rs

@@ -38,6 +38,7 @@
 //! ```
 
 #![no_std]
+#![warn(missing_docs)]
 
 extern crate alloc;