summaryrefslogtreecommitdiff
path: root/engine
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2024-08-02 16:43:25 +0200
committerHampusM <hampus@hampusmat.com>2024-08-02 16:43:25 +0200
commit900bc3b6c6b79f91a01a24fcda841808d13e2048 (patch)
tree26740ec60520e1d740eb818828103e058a9911f9 /engine
parent8bfef89e26c880b2c2f5c1c7b81ede90c40fa015 (diff)
docs(engine): correct Engine function comments
Diffstat (limited to 'engine')
-rw-r--r--engine/src/lib.rs10
1 files changed, 2 insertions, 8 deletions
diff --git a/engine/src/lib.rs b/engine/src/lib.rs
index 6d7fa1e..3080047 100644
--- a/engine/src/lib.rs
+++ b/engine/src/lib.rs
@@ -56,10 +56,7 @@ pub struct Engine
impl Engine
{
- /// Creates and initializes a new engine.
- ///
- /// # Errors
- /// Will return `Err` if window creation or window configuration fails.
+ /// Returns a new `Engine`.
#[must_use]
pub fn new() -> Self
{
@@ -107,10 +104,7 @@ impl Engine
self.world.add_extension(extension);
}
- /// Starts the engine.
- ///
- /// # Errors
- /// Will return `Err` if updating the window fails.
+ /// Emits the [`StartEvent`] event and then runs the event loop.
pub fn start(&self)
{
self.world.emit(StartEvent);