add minimal doc entry for the traits

imrn99 · May 13, 2024 · ff9b2fc · ff9b2fc
1 parent 8e93813
commit ff9b2fc
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/integraal/src/traits.rs b/integraal/src/traits.rs
@@ -1,5 +1,8 @@
 //! module doc
 
+/// Scalar domain value trait.
+///
+/// This trait is automatically implemented for all types implementing its requirements.
 pub trait DomainScalar:
     Clone + Copy + std::ops::Sub<Output = Self> + num::Float + num::Signed + num::FromPrimitive
 {
@@ -11,6 +14,9 @@ impl<
 {
 }
 
+/// Scalar image value trait.
+///
+/// This trait is automatically implemented for all types implementing its requirements.
 pub trait ImageScalar<X: DomainScalar, W: IntegratedScalar>:
     Clone
     + Copy
@@ -36,6 +42,9 @@ impl<
 {
 }
 
+/// Scalar post-integration value trait.
+///
+/// This trait is automatically implemented for all types implementing its requirements.
 pub trait IntegratedScalar: Clone + Copy + std::iter::Sum {}
 
 impl<W: Clone + Copy + std::iter::Sum> IntegratedScalar for W {}