Added description for dgn_place_map().

git-svn-id: https://crawl-ref.svn.sourceforge.net/svnroot/crawl-ref/trunk@1943 c06c8d41-db1a-0410-9941-cceddc491573

1 files changed, 7 insertions, 0 deletions

diff --git a/crawl-ref/source/dungeon.cc b/crawl-ref/source/dungeon.cc
index 6a77697fef..e0c0817a81 100644
--- a/crawl-ref/source/dungeon.cc
+++ b/crawl-ref/source/dungeon.cc
@@ -3418,6 +3418,13 @@ static dungeon_feature_type dgn_find_rune_subst_tags(const std::string &tags)
     return (DNGN_FLOOR);
 }
 
+// Places a map on the current level (minivault or regular vault).
+// generating_level: If true, assumes that this is in the middle of normal
+//                   level generation, and does not link items or handle
+//                   changing terrain.
+// clobber: If true, assumes the newly placed vault can clobber existing
+//          items and monsters (items may be destroyed, monsters may be
+//          teleported).
 bool dgn_place_map(int map, bool generating_level, bool clobber)
 {
     const map_def *mdef = map_by_index(map);