From 5106561503ebdf8e21f3c4f2685fe1dcd2dd1fec Mon Sep 17 00:00:00 2001 From: demenik Date: Wed, 10 Dec 2025 17:46:27 +0100 Subject: [PATCH] docs: Change `//` (regular comment) to `///` (doc comment) --- src/features/notification/mod.rs | 4 ++-- src/features/phase/mod.rs | 2 +- src/features/savegame/mod.rs | 2 +- tests/config.rs | 2 +- tests/pathfinding.rs | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/features/notification/mod.rs b/src/features/notification/mod.rs index a639706..29e3c8f 100644 --- a/src/features/notification/mod.rs +++ b/src/features/notification/mod.rs @@ -17,12 +17,12 @@ impl Plugin for NotificationPlugin { } } -// Spawns the notification container up +/// Spawns the notification container up fn setup(mut commands: Commands) { commands.spawn(notification_container()); } -// Spawns/Despawns UI elements for each item in the `Notifications` Resource +/// Spawns/Despawns UI elements for each item in the `Notifications` Resource fn handle_notification( mut commands: Commands, mut notifications: ResMut, diff --git a/src/features/phase/mod.rs b/src/features/phase/mod.rs index 0b78d39..1a63fba 100644 --- a/src/features/phase/mod.rs +++ b/src/features/phase/mod.rs @@ -107,7 +107,7 @@ fn tick_timer( } } -// Rewards the player at the end of a focus phase with `berries_per_focus_minute` * `focus_duration` +/// Rewards the player at the end of a focus phase with `berries_per_focus_minute` * `focus_duration` fn grant_focus_rewards( mut messages: MessageReader, config: Res, diff --git a/src/features/savegame/mod.rs b/src/features/savegame/mod.rs index 347cf06..3be631f 100644 --- a/src/features/savegame/mod.rs +++ b/src/features/savegame/mod.rs @@ -174,7 +174,7 @@ fn load_savegame( } } -// Resets all components/resources loaded by `load_savegame` +/// Resets all components/resources loaded by `load_savegame` fn reset_savegame( mut commands: Commands, grid: Res, diff --git a/tests/config.rs b/tests/config.rs index 1ea4a20..b046c1c 100644 --- a/tests/config.rs +++ b/tests/config.rs @@ -3,7 +3,7 @@ use std::fs; use std::io::Write; use uuid::Uuid; -// Helper function to create a temporary file with content +/// Helper function to create a temporary file with content fn create_temp_file(content: &str) -> (std::path::PathBuf, String) { let filename = format!("test_config_{}.json", Uuid::new_v4()); let temp_dir = std::env::temp_dir(); diff --git a/tests/pathfinding.rs b/tests/pathfinding.rs index 4ddea09..4df44a6 100644 --- a/tests/pathfinding.rs +++ b/tests/pathfinding.rs @@ -4,7 +4,7 @@ use pomomon_garden::features::pom::utils::find_path; use pomomon_garden::prelude::*; use std::collections::VecDeque; -// Helper to set up a Bevy App for pathfinding tests +/// Helper to set up a Bevy App for pathfinding tests fn setup_pathfinding_app( grid_width: u32, grid_height: u32,