devices: clean up ioapic comments.
BUG=b:266513575
TEST=n/a
Change-Id: Iafd3da07ab90c750f8b39703d1b817b9023ebca4
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4391782
Commit-Queue: Noah Gold <nkgold@google.com>
Reviewed-by: Frederick Mayle <fmayle@google.com>
diff --git a/devices/src/irqchip/ioapic.rs b/devices/src/irqchip/ioapic.rs
index 9ea78a5..e50ebeb 100644
--- a/devices/src/irqchip/ioapic.rs
+++ b/devices/src/irqchip/ioapic.rs
@@ -80,11 +80,14 @@
// not exactly the same as) KVM's IOAPIC.
const RTC_IRQ: usize = 0x8;
-/// [Ioapic] stores MSIs used to back GSIs, but not enough information to re-create these MSIs
-/// (it is missing the address & data). It also includes data that is unused by the userspace
-/// ioapic (the per gsi resample event, [IrqEvent::resample_event], is always None).
/// This struct is essentially the complete serialized form of [IrqEvent] as used in
/// [Ioapic::out_events].
+///
+/// [Ioapic] stores MSIs used to back GSIs, but not enough information to re-create these MSIs
+/// (it is missing the address & data). It also includes data that is unused by the userspace
+/// ioapic (the per gsi resample event, [IrqEvent::resample_event], is always None). This
+/// struct incorporates the necessary information for snapshotting, and excludes that which
+/// is not required.
#[derive(Clone, Serialize, Deserialize)]
struct OutEventSnapshot {
gsi: u32,
