Documentation|Fixed|World: Various minor fixes plus some cleanup

skyjake · Jun 13, 2013 · 7fa518e · 7fa518e
1 parent c145f4f
commit 7fa518e
Show file tree

Hide file tree

Showing 59 changed files with 109 additions and 114 deletions.
diff --git a/doomsday/client/include/world/blockmap.h b/doomsday/client/include/world/blockmap.h
@@ -1,4 +1,4 @@
-/** @file world/blockmap.h World map element blockmap.
+/** @file blockmap.h World map element blockmap.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/bspbuilder.h b/doomsday/client/include/world/bspbuilder.h
@@ -1,4 +1,4 @@
-/** @file bspbuilder.h World Map BSP Builder.
+/** @file bspbuilder.h World map BSP builder.
  *
  * @authors Copyright © 2007-2013 Daniel Swanson <danij@dengine.net>
  * @authors Copyright © 2000-2007 Andrew Apted <ajapted@gmail.com>

diff --git a/doomsday/client/include/world/bspleaf.h b/doomsday/client/include/world/bspleaf.h
@@ -1,4 +1,4 @@
-/** @file world/bspleaf.h World BSP Leaf.
+/** @file bspleaf.h World map BSP leaf.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
@@ -72,6 +72,9 @@ class BspLeaf : public de::MapElement
     DENG2_ERROR(UnknownGeometryGroupError);
 #endif
 
+    /*
+     * Linked-element lists/sets:
+     */
     typedef QSet<polyobj_s *> Polyobjs;
     typedef QList<Segment *>  Segments;
 
@@ -181,24 +184,6 @@ class BspLeaf : public de::MapElement
      */
     void setSector(Sector *newSector);
 
-#ifdef __CLIENT__
-
-    /**
-     * Determines whether the BSP leaf has a positive world volume. For this
-     * to be true the following criteria must be met:
-     *
-     * - The polygon geometry is @em not degenerate (see @ref isDegenerate()).
-     * - A sector is attributed (see @ref hasSector())
-     * - The height of floor is lower than that of the ceiling plane for the
-     *   attributed sector.
-     *
-     * @param useVisualHeights  @c true= use the visual (i.e., smoothed) plane
-     *                          heights instead of the @em sharp heights.
-     */
-    bool hasWorldVolume(bool useVisualHeights = true) const;
-
-#endif // __CLIENT__
-
     /**
      * Returns @c true iff at least one polyobj is linked to the BSP leaf.
      */
@@ -244,6 +229,20 @@ class BspLeaf : public de::MapElement
 
 #ifdef __CLIENT__
 
+    /**
+     * Determines whether the BSP leaf has a positive world volume. For this
+     * to be true the following criteria must be met:
+     *
+     * - The polygon geometry is @em not degenerate (see @ref isDegenerate()).
+     * - A sector is attributed (see @ref hasSector())
+     * - The height of floor is lower than that of the ceiling plane for the
+     *   attributed sector.
+     *
+     * @param useVisualHeights  @c true= use the visual (i.e., smoothed) plane
+     *                          heights instead of the @em sharp heights.
+     */
+    bool hasWorldVolume(bool useVisualHeights = true) const;
+
     /**
      * Returns a pointer to the face geometry half-edge which has been chosen
      * for use as the base for a triangle fan GL primitive. May return @c 0 if

diff --git a/doomsday/client/include/world/bspnode.h b/doomsday/client/include/world/bspnode.h
@@ -1,4 +1,4 @@
-/** @file world/bspnode.h World BSP Node.
+/** @file bspnode.h World map BSP node.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/dmuargs.h b/doomsday/client/include/world/dmuargs.h
@@ -1,7 +1,7 @@
-/** @file world/dmuargs.h Doomsday Map Update (API) Arguments.
+/** @file dmuargs.h Doomsday Map Update (DMU) API arguments.
  *
- * @author Copyright © 2006-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
- * @author Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
+ * @authors Copyright © 2006-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
  *
  * @par License
  * GPL: http://www.gnu.org/licenses/gpl.html

diff --git a/doomsday/client/include/world/entitydatabase.h b/doomsday/client/include/world/entitydatabase.h
@@ -1,4 +1,4 @@
-/** @file world/entitydatabase.h World entity property database.
+/** @file entitydatabase.h World map entity property value database.
  *
  * @authors Copyright © 2007-2013 Daniel Swanson <danij@dengine.net>
  *

diff --git a/doomsday/client/include/world/generators.h b/doomsday/client/include/world/generators.h
@@ -1,4 +1,4 @@
-/** @file world/generators.h Generator collection.
+/** @file generators.h World map generator collection.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/line.h b/doomsday/client/include/world/line.h
@@ -1,4 +1,4 @@
-/** @file world/line.h World map line.
+/** @file line.h World map line.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
@@ -35,9 +35,9 @@
 #include "Surface"
 #include "Vertex"
 
-class Segment;
 class LineOwner;
 class Sector;
+class Segment;
 
 /**
  * World map line.

diff --git a/doomsday/client/include/world/lineowner.h b/doomsday/client/include/world/lineowner.h
@@ -1,4 +1,4 @@
-/** @file world/lineowner.h World Line Owner.
+/** @file lineowner.h World map line owner.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/linesighttest.h b/doomsday/client/include/world/linesighttest.h
@@ -1,4 +1,4 @@
-/** @file world/linesighttest.h World Line of Sight Testing.
+/** @file linesighttest.h World map line of sight testing.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/mapelement.h b/doomsday/client/include/world/mapelement.h
@@ -1,4 +1,4 @@
-/** @file world/mapelement.h Base class for all world map elements.
+/** @file mapelement.h Base class for all world map elements.
  *
  * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2013 Daniel Swanson <danij@dengine.net>
@@ -101,7 +101,7 @@ class MapElement
     }
 
     /**
-     * @note The Current index indices are retained.
+     * @note The current index indices are retained.
      *
      * @see setIndexInArchive(), setIndexInMap()
      */

diff --git a/doomsday/client/include/world/p_intercept.h b/doomsday/client/include/world/p_intercept.h
@@ -1,4 +1,4 @@
-/** @file world/p_intercept.h World Line / Object Interception.
+/** @file p_intercept.h World map line / object interception.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/p_mapdata.h b/doomsday/client/include/world/p_mapdata.h
@@ -1,7 +1,7 @@
-/** @file world/p_mapdata.h World Map Entity Definitions.
+/** @file p_mapdata.h World map entity definitions.
  *
- * @authors Copyright &copy; 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
- * @authors Copyright &copy; 2006-2013 Daniel Swanson <danij@dengine.net>
+ * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
  *
  * @par License
  * GPL: http://www.gnu.org/licenses/gpl.html

diff --git a/doomsday/client/include/world/p_maptypes.h b/doomsday/client/include/world/p_maptypes.h
@@ -1,4 +1,5 @@
-/** @file world/p_maptypes.h Convenience header for including all map data types.
+/** @file p_maptypes.h Convenience header for including all map data types.
+ *
  * @ingroup world
  *
  * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>

diff --git a/doomsday/client/include/world/p_maputil.h b/doomsday/client/include/world/p_maputil.h
@@ -1,4 +1,4 @@
-/** @file world/p_maputil.h World Map Utility Routines.
+/** @file p_maputil.h World map utility routines.
  *
  * @ingroup world
  *

diff --git a/doomsday/client/include/world/p_object.h b/doomsday/client/include/world/p_object.h
@@ -1,4 +1,4 @@
-/** @file world/p_object.h World Map Objects.
+/** @file p_object.h World map objects.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2005-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/p_objlink.h b/doomsday/client/include/world/p_objlink.h
@@ -1,4 +1,4 @@
-/** @file world/p_objlink.h World Object => BspLeaf contact blockmap.
+/** @file p_objlink.h World map object => BSP leaf contact blockmap.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/p_particle.h b/doomsday/client/include/world/p_particle.h
@@ -1,8 +1,9 @@
-/** @file world/p_particle.h World Generator Management (Particles).
+/** @file p_particle.h World map generator management (particles).
+ *
  * @ingroup world
  *
- * @author Copyright &copy; 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
- * @author Copyright &copy; 2006-2013 Daniel Swanson <danij@dengine.net>
+ * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
  *
  * @par License
  * GPL: http://www.gnu.org/licenses/gpl.html

diff --git a/doomsday/client/include/world/p_players.h b/doomsday/client/include/world/p_players.h
@@ -1,4 +1,4 @@
-/** @file world/p_players.h: World Player Entities.
+/** @file p_players.h World player entities.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2005-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/p_ticker.h b/doomsday/client/include/world/p_ticker.h
@@ -1,4 +1,4 @@
-/** @file world/p_ticker.h Timed World Events.
+/** @file p_ticker.h Timed world events.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/plane.h b/doomsday/client/include/world/plane.h
@@ -1,7 +1,7 @@
-/** @file world/plane.h World map plane.
+/** @file plane.h World map plane.
  *
- * @author Copyright &copy; 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
- * @author Copyright &copy; 2006-2013 Daniel Swanson <danij@dengine.net>
+ * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
  *
  * @par License
  * GPL: http://www.gnu.org/licenses/gpl.html
@@ -21,11 +21,8 @@
 #ifndef DENG_WORLD_PLANE_H
 #define DENG_WORLD_PLANE_H
 
-#include <QList>
-
 #include <de/types.h>
 
-#include <de/Error>
 #include <de/Observers>
 #include <de/Vector>
 

diff --git a/doomsday/client/include/world/polyobj.h b/doomsday/client/include/world/polyobj.h
@@ -1,4 +1,4 @@
-/** @file world/polyobj.h World Polyobj.
+/** @file polyobj.h World map polyobj.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/propertyvalue.h b/doomsday/client/include/world/propertyvalue.h
@@ -1,11 +1,11 @@
-/**
- * @file propertyvalue.h
- * Data types for representing property values. @ingroup data
+/** @file propertyvalue.h Data types for representing world map property values.
+ *
+ * @ingroup data
  *
  * Data type class hierarchy with integral RTTI mechanism and basic in-place
  * value/type conversions.
  *
- * @author Copyright &copy; 2013 Daniel Swanson <danij@dengine.net>
+ * @authors Copyright © 2013 Daniel Swanson <danij@dengine.net>
  *
  * @par License
  * GPL: http://www.gnu.org/licenses/gpl.html

diff --git a/doomsday/client/include/world/r_world.h b/doomsday/client/include/world/r_world.h
@@ -1,4 +1,4 @@
-/** @file world/r_world.h World map utilities.
+/** @file r_world.h World map utilities.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/reject.h b/doomsday/client/include/world/reject.h
@@ -1,4 +1,4 @@
-/** @file world/reject.h World Reject LUT building.
+/** @file reject.h World map sector LOS reject LUT building.
  *
  * @authors Copyright © 2007-2013 Daniel Swanson <danij@dengine.net>
  * @authors Copyright © 2000-2007 Andrew Apted <ajapted@gmail.com>

diff --git a/doomsday/client/include/world/sector.h b/doomsday/client/include/world/sector.h
@@ -1,4 +1,4 @@
-/** @file world/sector.h World map sector.
+/** @file sector.h World map sector.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/segment.h b/doomsday/client/include/world/segment.h
@@ -1,4 +1,4 @@
-/** @file world/segment.h World Line Segment.
+/** @file segment.h World map line segment.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/surface.h b/doomsday/client/include/world/surface.h
@@ -1,7 +1,7 @@
-/** @file world/surface.h World map surface.
+/** @file surface.h World map surface.
  *
- * @authors Copyright &copy; 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
- * @authors Copyright &copy; 2006-2013 Daniel Swanson <danij@dengine.net>
+ * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
  *
  * @par License
  * GPL: http://www.gnu.org/licenses/gpl.html

diff --git a/doomsday/client/include/world/vertex.h b/doomsday/client/include/world/vertex.h
@@ -1,4 +1,4 @@
-/** @file world/vertex.h World map vertex.
+/** @file vertex.h World map vertex.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/include/world/world.h b/doomsday/client/include/world/world.h
@@ -1,4 +1,4 @@
-/** @file world/world.h World.
+/** @file world.h World.
  *
  * Ideas for improvement:
  *

diff --git a/doomsday/client/src/world/api_mapedit.cpp b/doomsday/client/src/world/api_mapedit.cpp
@@ -1,4 +1,4 @@
-/** @file world/api_mapedit.cpp Internal runtime map editing interface.
+/** @file api_mapedit.cpp Internal runtime map editing interface.
  *
  * @authors Copyright © 2007-2013 Daniel Swanson <danij@dengine.net>
  *

diff --git a/doomsday/client/src/world/blockmap.cpp b/doomsday/client/src/world/blockmap.cpp
@@ -1,4 +1,4 @@
-/** @file world/blockmap.cpp World map element blockmap.
+/** @file blockmap.cpp World map element blockmap.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/src/world/bspbuilder.cpp b/doomsday/client/src/world/bspbuilder.cpp
@@ -1,4 +1,4 @@
-/** @file bspbuilder.cpp BSP Builder.
+/** @file bspbuilder.cpp World map BSP builder.
  *
  * @authors Copyright © 2013 Daniel Swanson <danij@dengine.net>
  *

diff --git a/doomsday/client/src/world/bspleaf.cpp b/doomsday/client/src/world/bspleaf.cpp
@@ -1,4 +1,4 @@
-/** @file world/bspleaf.cpp World BSP Leaf.
+/** @file bspleaf.cpp World map BSP leaf.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/src/world/bspnode.cpp b/doomsday/client/src/world/bspnode.cpp
@@ -1,4 +1,4 @@
-/** @file bspnode.cpp World Map BSP Node.
+/** @file bspnode.cpp World map BSP node.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/src/world/dmuargs.cpp b/doomsday/client/src/world/dmuargs.cpp
@@ -1,4 +1,4 @@
-/** @file world/dmuargs.cpp Doomsday Map Update (API) Arguments.
+/** @file dmuargs.cpp Doomsday Map Update (DMU) API arguments.
  *
  * @authors Copyright © 2006-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/src/world/entitydatabase.cpp b/doomsday/client/src/world/entitydatabase.cpp
@@ -1,4 +1,4 @@
-/** @file entitydatabase.cpp Database of map entity property values.
+/** @file entitydatabase.cpp World map entity property value database.
  * @ingroup world
  *
  * @authors Copyright &copy; 2007-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/src/world/generators.cpp b/doomsday/client/src/world/generators.cpp
@@ -1,5 +1,4 @@
-/** @file generators.cpp Generators.
- * @ingroup world
+/** @file generators.cpp World map generator collection.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
@@ -21,10 +20,6 @@
 
 #include <de/memoryzone.h>
 
-//#include "de_platform.h"
-//#include "de_console.h"
-//#include "dd_main.h"
-
 #include "world/generators.h"
 
 namespace de {

diff --git a/doomsday/client/src/world/line.cpp b/doomsday/client/src/world/line.cpp
@@ -1,4 +1,4 @@
-/** @file world/line.cpp World Map Line.
+/** @file line.cpp World map line.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
@@ -18,8 +18,6 @@
  * 02110-1301 USA</small>
  */
 
-//#include <de/mathutil.h>
-
 #include <de/libdeng2.h>
 #include <de/Vector>
 

diff --git a/doomsday/client/src/world/linesighttest.cpp b/doomsday/client/src/world/linesighttest.cpp
@@ -1,4 +1,4 @@
-/** @file linesighttest.cpp World Map Line of Sight Testing.
+/** @file linesighttest.cpp World map line of sight testing.
  *
  * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/src/world/mapelement.cpp b/doomsday/client/src/world/mapelement.cpp
@@ -1,4 +1,4 @@
-/** @file world/mapelement.cpp Base class for all map elements.
+/** @file mapelement.cpp Base class for all map elements.
  *
  * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright © 2013 Daniel Swanson <danij@dengine.net>

diff --git a/doomsday/client/src/world/p_data.cpp b/doomsday/client/src/world/p_data.cpp
@@ -1,4 +1,4 @@
-/** @file p_data.cpp Playsim Data Structures
+/** @file p_data.cpp World playsim data structures.
  *
  * @authors Copyright &copy; 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  * @authors Copyright &copy; 2006-2013 Daniel Swanson <danij@dengine.net>