docs: Change // (regular comment) to /// (doc comment)

This commit is contained in:
demenik
2025-12-10 17:46:27 +01:00
parent 6bd135ca72
commit 5106561503
5 changed files with 6 additions and 6 deletions

View File

@@ -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<Notifications>,

View File

@@ -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<PhaseTimerFinishedMessage>,
config: Res<GameConfig>,

View File

@@ -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<Grid>,

View File

@@ -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();

View File

@@ -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,