summaryrefslogtreecommitdiff
path: root/ecs/src/lib.rs
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2025-04-22 18:47:53 +0200
committerHampusM <hampus@hampusmat.com>2025-04-22 18:47:53 +0200
commitf5d257ff2670147ec4ddc77862a8c93c02e21deb (patch)
tree35a04e6f19752a1b058a19c6640f264a4b0afb9b /ecs/src/lib.rs
parentf6baed4c29df1fe048e3045e63db74a3623a6b5e (diff)
docs(ecs): correct doc comments of World functions
Diffstat (limited to 'ecs/src/lib.rs')
-rw-r--r--ecs/src/lib.rs12
1 files changed, 1 insertions, 11 deletions
diff --git a/ecs/src/lib.rs b/ecs/src/lib.rs
index c953290..53abc6b 100644
--- a/ecs/src/lib.rs
+++ b/ecs/src/lib.rs
@@ -94,9 +94,6 @@ impl World
}
/// Creates a new entity with the given components.
- ///
- /// # Panics
- /// Will panic if mutable internal lock cannot be acquired.
pub fn create_entity<Comps>(&mut self, components: Comps) -> Uid
where
Comps: ComponentSequence,
@@ -168,9 +165,6 @@ impl World
}
/// Adds a extensions.
- ///
- /// # Panics
- /// Will panic if mutable internal lock cannot be acquired.
pub fn add_extension(&mut self, extension: impl Extension)
{
let extension_collector = ExtensionCollector::new(self);
@@ -195,9 +189,8 @@ impl World
}
/// Performs a single tick.
- ///
/// # Panics
- /// Will panic if a internal lock cannot be acquired.
+ /// Will panic if mutable internal lock cannot be acquired.
pub fn step(&mut self) -> StepResult
{
if self.stop.load(Ordering::Relaxed) {
@@ -240,9 +233,6 @@ impl World
}
/// Starts a loop which calls [`Self::step`] until the world is stopped.
- ///
- /// # Panics
- /// Will panic if a internal lock cannot be acquired.
pub fn start_loop(&mut self)
{
while let StepResult::Continue = self.step() {}