Finish documenting the action, asset, color, and element modules in GPUI

Remove SmallVec from the public API of GPUI

crates/gpui/src/assets.rs

@@ -8,8 +8,12 @@ use std::{
     sync::atomic::{AtomicUsize, Ordering::SeqCst},
 };
 
+/// A source of assets for this app to use.
 pub trait AssetSource: 'static + Send + Sync {
+    /// Load the given asset from the source path.
     fn load(&self, path: &str) -> Result<Cow<[u8]>>;
+
+    /// List the assets at the given path.
     fn list(&self, path: &str) -> Result<Vec<SharedString>>;
 }
 
@@ -26,15 +30,19 @@ impl AssetSource for () {
     }
 }
 
+/// A unique identifier for the image cache
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
 pub struct ImageId(usize);
 
+/// A cached and processed image.
 pub struct ImageData {
+    /// The ID associated with this image
     pub id: ImageId,
     data: ImageBuffer<Bgra<u8>, Vec<u8>>,
 }
 
 impl ImageData {
+    /// Create a new image from the given data.
     pub fn new(data: ImageBuffer<Bgra<u8>, Vec<u8>>) -> Self {
         static NEXT_ID: AtomicUsize = AtomicUsize::new(0);
 
@@ -44,10 +52,12 @@ impl ImageData {
         }
     }
 
+    /// Convert this image into a byte slice.
     pub fn as_bytes(&self) -> &[u8] {
         &self.data
     }
 
+    /// Get the size of this image, in pixels
     pub fn size(&self) -> Size<DevicePixels> {
         let (width, height) = self.data.dimensions();
         size(width.into(), height.into())