From 293853de3d51314fdc8c42829439c5ad3bb013ee Mon Sep 17 00:00:00 2001
From: klangner <klangner@gmail.com>
Date: Thu, 3 Sep 2020 21:58:43 +0200
Subject: [PATCH] Added doc

---
 src/dungeon/cull_unreachable.rs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/dungeon/cull_unreachable.rs b/src/dungeon/cull_unreachable.rs
index efbd291..0632315 100644
--- a/src/dungeon/cull_unreachable.rs
+++ b/src/dungeon/cull_unreachable.rs
@@ -1,9 +1,16 @@
+//! Remove unreachable areas from the map.
+//! 
+//! This modifier reuires starting position on the map.
+//! It will add wall on every tile which is not accessible from the starting point.
+//! 
+
 use rand::prelude::StdRng;
 use super::MapModifier;
 use super::map::{Map, TileType};
 use super::dijkstra::DijkstraMap;
 
 
+/// Remove unreachable areas from the map.
 pub struct CullUnreachable {}
 
 impl MapModifier for CullUnreachable {