Skip to content

Commit e71ada6

Browse files
committed
Improve documentation
1 parent c602752 commit e71ada6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

crates/bevy_ecs/src/removal_detection.rs

+4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ use std::{
1616
ops::{Deref, DerefMut},
1717
};
1818

19+
/// Wrapper around a [`ManualEventReader<Entity>`] so that we
20+
/// can differentiate events between components.
1921
#[derive(Debug)]
2022
pub struct RemovedComponentReader<T>
2123
where
@@ -47,6 +49,8 @@ impl<T: Component> DerefMut for RemovedComponentReader<T> {
4749
}
4850
}
4951

52+
/// Wrapper around a map of components to [`Events<Entity>`].
53+
/// So that we can find the events without naming the type directly.
5054
#[derive(Default, Debug)]
5155
pub struct RemovedComponentEvents {
5256
event_sets: SparseSet<ComponentId, Events<Entity>>,

0 commit comments

Comments
 (0)