Doc fixes.

gfx-rs · Dec 16, 2024 · 01b89cf · 01b89cf
1 parent ce5a26c
commit 01b89cf
Showing 1 changed file with 22 additions and 4 deletions.
diff --git a/naga/src/front/atomic_upgrade.rs b/naga/src/front/atomic_upgrade.rs
@@ -101,8 +101,25 @@ impl UpgradeState<'_> {
         self.padding.inc_padding()
     }
 
-    /// Upgrade the type, recursing until we reach the leaves.
-    /// At the leaves, replace scalars with atomic scalars.
+    /// Get a type equivalent to `ty`, but with [`Scalar`] leaves upgraded to [`Atomic`] scalars.
+    ///
+    /// If such a type already exists in `self.module.types`, return its handle.
+    /// Otherwise, construct a new one and return that handle.
+    ///
+    /// If `ty` is a [`Pointer`], [`Array`], [`BindingArray`], recurse into the
+    /// type and upgrade its leaf types.
+    ///
+    /// If `ty` is a [`Struct`], recurse into it and upgrade only those fields
+    /// whose indices appear in `field_indices`.
+    ///
+    /// The existing type is not affected.
+    ///
+    /// [`Scalar`]: crate::TypeInner::Scalar
+    /// [`Atomic`]: crate::TypeInner::Atomic
+    /// [`Pointer`]: crate::TypeInner::Pointer
+    /// [`Array`]: crate::TypeInner::Array
+    /// [`Struct`]: crate::TypeInner::Struct
+    /// [`BindingArray`]: crate::TypeInner::BindingArray
     fn upgrade_type(
         &mut self,
         ty: Handle<Type>,
@@ -147,8 +164,9 @@ impl UpgradeState<'_> {
             _ => return Ok(ty),
         };
 
-        // Now that we've upgraded any subtypes, re-borrow a reference to our
-        // type and update its `inner`.
+        // At this point, we have a `TypeInner` that is the upgraded version of
+        // `ty`. Find a suitable `Type` for this, creating a new one if
+        // necessary, and return its handle.
         let r#type = &self.module.types[ty];
         let span = self.module.types.get_span(ty);
         let new_type = Type {