added comments to clearify what is in each rust file

This commit is contained in:
grimsace
2026-05-18 09:01:14 -05:00
parent 665a3a3bfa
commit 49ebe351d6
15 changed files with 94 additions and 0 deletions
+7
View File
@@ -1,3 +1,10 @@
/*
* High-level procedural generation algorithms.
* Contains the logic for building room connection graphs,
* placing packed rooms, and populating random markers, traps,
* monsters, and staircase transitions between levels.
*/
use super::types::{
AreaMarker, Corridor, Door, DoorSettings, DungeonLayout, Room, Staircase, Window,
WindowSettings, WindowSide,
+6
View File
@@ -1,4 +1,10 @@
pub mod generation;
/*
* Public entry point for the layout module.
* Exports types, utilities, and generation algorithms used to build
* the dungeon structure.
*/
pub mod types;
pub mod utils;
+6
View File
@@ -1,3 +1,9 @@
/*
* Core data structures for the dungeon layout.
* Defines structs for Rooms, Corridors, Doors, Windows, Stairs,
* TextLabels, and the master DungeonLayout container.
*/
use serde::{Deserialize, Serialize};
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+6
View File
@@ -1,3 +1,9 @@
/*
* Geometric utilities and low-level layout helpers.
* Provides logic for Manhattan distance, room overlap testing,
* BFS-based shortest pathfinding, and custom deterministic RNG.
*/
use super::types::{DungeonLayout, Room};
use std::collections::{HashSet, VecDeque};