chore(workspace): refactored the way some comments were written across the repository

This commit is contained in:
Serkyo 2026-07-10 17:38:07 +02:00
parent 955d62bfcf
commit 0fedd1b30b
5 changed files with 7 additions and 16 deletions

View file

@ -2,9 +2,7 @@
//! Free-fly camera used to observe the world. //! Free-fly camera used to observe the world.
//! //!
//! The camera stores a world-space position and an orientation expressed as yaw and pitch //! The camera stores a world-space position and an orientation expressed as yaw and pitch angles. A view matrix is derived on demand from these values, and the orientation and position are advanced each frame from accumulated keyboard and mouse input.
//! angles. A view matrix is derived on demand from these values, and the orientation and
//! position are advanced each frame from accumulated keyboard and mouse input.
use glam::{Mat4, Vec3}; use glam::{Mat4, Vec3};

View file

@ -2,8 +2,7 @@
//! Main entry point for the Synvael client. //! Main entry point for the Synvael client.
//! //!
//! This crate handles window creation, input processing, and drives the //! This crate handles window creation, input processing, and drives the renderer to display the game world.
//! renderer to display the game world.
mod camera; mod camera;
mod meshing; mod meshing;
@ -22,8 +21,7 @@ use winit::window::{CursorGrabMode, Window, WindowId};
/// Transient per-frame input state sampled from window and device events. /// Transient per-frame input state sampled from window and device events.
/// ///
/// Keyboard fields hold whether a movement key is currently pressed. `mouse_delta` accumulates /// Keyboard fields hold whether a movement key is currently pressed. `mouse_delta` accumulates raw pointer motion between frames and is consumed (reset to zero) once applied to the camera.
/// raw pointer motion between frames and is consumed (reset to zero) once applied to the camera.
// The bools are independent per-key held states, for which a flat struct is the clearest form. // The bools are independent per-key held states, for which a flat struct is the clearest form.
#[expect(clippy::struct_excessive_bools)] #[expect(clippy::struct_excessive_bools)]
#[derive(Default)] #[derive(Default)]

View file

@ -2,8 +2,7 @@
//! Dedicated server for Synvael. //! Dedicated server for Synvael.
//! //!
//! The server handles the authoritative game simulation, including world //! The server handles the authoritative game simulation, including world management, physics, and combat.
//! management, physics, and combat.
/// A bounded LRU cache of regenerated chunk baselines, shared across the worker pool. /// A bounded LRU cache of regenerated chunk baselines, shared across the worker pool.
pub mod chunk_cache; pub mod chunk_cache;

View file

@ -2,11 +2,8 @@
//! Server-side persistence: the durability layer over the `shared` save format. //! Server-side persistence: the durability layer over the `shared` save format.
//! //!
//! `shared::save` owns the pure, in-memory framing (the `SYNR` index and `SYNC` records). This //! `shared::save` owns the pure, in-memory framing (the `SYNR` index and `SYNC` records).
//! module owns the filesystem side: reading a `.region` file into memory, mutating its chunks, and //! This module owns the filesystem side: reading a `.region` file into memory, mutating its chunks, and flushing it back to disk crash-safely. The write strategy is a whole-file atomic rewrite (`.tmp` + fsync + rename); the on-disk format is unchanged.
//! flushing it back to disk crash-safely. The write strategy is a whole-file atomic rewrite
//! (`.tmp` + fsync + rename); the on-disk format is unchanged, so a later slice can switch to an
//! append-in-place strategy without a format change.
mod region_actor; mod region_actor;
mod region_file; mod region_file;

View file

@ -2,8 +2,7 @@
//! Shared types and logic for Synvael. //! Shared types and logic for Synvael.
//! //!
//! This crate contains data structures and constants that are used by both //! This crate contains data structures and constants that are used by both the client and the server.
//! the client and the server.
pub mod generator; pub mod generator;
pub mod save; pub mod save;