Documentation tweaks.

georust · Sep 28, 2022 · cb1a814 · cb1a814
1 parent a70e2b2
commit cb1a814
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/src/raster/rasterband.rs b/src/raster/rasterband.rs
@@ -856,11 +856,13 @@ impl PaletteInterpretation {
     }
 }
 
+/// Grayscale [`ColorTable`] entry.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub struct GrayEntry {
     pub g: i16,
 }
 
+/// Red, green, blue, alpha [`ColorTable`] entry.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub struct RgbaEntry {
     pub r: i16,
@@ -869,6 +871,7 @@ pub struct RgbaEntry {
     pub a: i16,
 }
 
+/// Cyan, magenta, yellow, black [`ColorTable`] entry.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub struct CmykEntry {
     pub c: i16,
@@ -877,13 +880,15 @@ pub struct CmykEntry {
     pub k: i16,
 }
 
+/// Hue, lightness, saturation [`ColorTable`] entry.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub struct HlsEntry {
     pub h: i16,
     pub l: i16,
     pub s: i16,
 }
 
+/// Options for defining [`ColorInterpretation::PaletteIndex`] entries in a [`ColorTable`].
 #[derive(Copy, Clone, PartialEq, Eq)]
 pub enum ColorEntry {
     Gray(GrayEntry),
@@ -993,9 +998,6 @@ impl Debug for ColorEntry {
 
 /// Color table for raster bands that use [`ColorInterpretation::PaletteIndex`] color interpretation.
 ///
-/// This object carries the lifetime of the raster band that
-/// contains it. This is necessary to prevent the raster band
-/// from being dropped before the color table.
 ///
 /// # Example
 ///