Map: Cleanup

skyjake · Jun 14, 2013 · 74869e1 · 74869e1
1 parent 6336a25
commit 74869e1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 15 deletions.
diff --git a/doomsday/client/include/world/map.h b/doomsday/client/include/world/map.h
@@ -417,11 +417,13 @@ class Map
      * Links a mobj into both a block and a BSP leaf based on it's (x,y).
      * Sets mobj->bspLeaf properly. Calling with flags==0 only updates
      * the BspLeaf pointer. Can be called without unlinking first.
+     * Should be called AFTER mobj translation to (re-)insert the mobj.
      */
     void link(struct mobj_s &mobj, byte flags);
 
     /**
-     * Unlinks a mobj from everything it has been linked to.
+     * Unlinks a mobj from everything it has been linked to. Should be called
+     * BEFORE mobj translation to extract the mobj.
      *
      * @param mo  Mobj to be unlinked.
      *

diff --git a/doomsday/client/src/world/map.cpp b/doomsday/client/src/world/map.cpp
@@ -539,26 +539,12 @@ DENG2_PIMPL(Map)
 #undef BLOCKMAP_MARGIN
     }
 
-    /**
-     * Unlink the specified @a mobj from any internal data structures for
-     * bookkeeping purposes. Should be called BEFORE mobj translation to
-     * extract the mobj.
-     *
-     * @param mobj  Mobj to be unlinked.
-     */
     bool unlinkMobjInBlockmap(mobj_t &mo)
     {
         Blockmap::Cell cell = mobjBlockmap->toCell(mo.origin);
         return mobjBlockmap->unlink(cell, &mo);
     }
 
-    /**
-     * Link the specified @a mobj in any internal data structures for
-     * bookkeeping purposes. Should be called AFTER mobj translation to
-     * (re-)insert the mobj.
-     *
-     * @param mobj  Mobj to be linked (must be currently unlinked).
-     */
     void linkMobjInBlockmap(mobj_t &mo)
     {
         Blockmap::Cell cell = mobjBlockmap->toCell(mo.origin);