Skip to content

Commit

Permalink
Documentation: Renamed "map" module as "world"
Browse files Browse the repository at this point in the history
  • Loading branch information
danij-deng committed Jun 7, 2013
1 parent 8e5125b commit 05751f9
Show file tree
Hide file tree
Showing 18 changed files with 32 additions and 32 deletions.
6 changes: 3 additions & 3 deletions doomsday/api/api_map.h
Expand Up @@ -3,7 +3,7 @@
* World data comprises the map and all the objects in it. The public API
* includes accessing and modifying map data objects via DMU.
*
* @ingroup map
* @ingroup world
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
Expand Down Expand Up @@ -160,7 +160,7 @@ typedef void const *MapElementPtrConst;
extern "C" {
#endif

/// @addtogroup map
/// @addtogroup world
///@{

DENG_API_TYPEDEF(Map)
Expand Down Expand Up @@ -623,7 +623,7 @@ DENG_API_T(Map);
#define P_FreeDummy _api_Map.FreeDummy
#define P_IsDummy _api_Map.IsDummy
#define P_DummyExtraData _api_Map.DummyExtraData
#define P_CountMapObjs _api_Map.CountMapObjs
#define P_CountMapObjs _api_Map.CountMapObjs
#define P_GetGMOByte _api_Map.GetGMOByte
#define P_GetGMOShort _api_Map.GetGMOShort
#define P_GetGMOInt _api_Map.GetGMOInt
Expand Down
4 changes: 2 additions & 2 deletions doomsday/api/api_mapedit.h
@@ -1,5 +1,5 @@
/** @file api_mapedit.h Public API for creating maps.
* @ingroup map
* @ingroup world
*
* @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2013 Daniel Swanson <danij@dengine.net>
Expand All @@ -26,7 +26,7 @@
#include "api_base.h"

/// @defgroup mapEdit Map Editor
/// @ingroup map
/// @ingroup world
///@{

/// Value types.
Expand Down
20 changes: 10 additions & 10 deletions doomsday/api/dd_share.h
Expand Up @@ -296,15 +296,15 @@ enum {

//------------------------------------------------------------------------
//
// Map Data
// World Data
//
//------------------------------------------------------------------------

/// @defgroup map Map Data
/// @defgroup world World Data

/**
* @defgroup dmu Map Update (DMU)
* @ingroup map
* @ingroup world
*/
///@{

Expand Down Expand Up @@ -483,14 +483,14 @@ typedef struct ddmobj_base_s {
DD_BASE_DDMOBJ_ELEMENTS()
} ddmobj_base_t;

/// R_SetupMap() modes. @ingroup map
/// R_SetupMap() modes. @ingroup world
enum {
DDSMM_AFTER_LOADING, ///< After loading a savegame...
DDSMM_FINALIZE, ///< After everything else is done.
DDSMM_INITIALIZE ///< Before anything else if done.
};

/// Sector reverb data indices. @ingroup map
/// Sector reverb data indices. @ingroup world
enum {
SRD_VOLUME,
SRD_SPACE,
Expand All @@ -499,10 +499,10 @@ enum {
NUM_REVERB_DATA
};

/// Environmental audio characteristics. @ingroup map
/// Environmental audio characteristics. @ingroup world
typedef float AudioEnvironmentFactors[NUM_REVERB_DATA];

/// Side section indices. @ingroup map
/// Side section indices. @ingroup world
typedef enum sidesection_e {
SS_MIDDLE,
SS_BOTTOM,
Expand All @@ -511,7 +511,7 @@ typedef enum sidesection_e {

#define VALID_SIDESECTION(v) ((v) >= SS_MIDDLE && (v) <= SS_TOP)

/// Helper macro for converting SideSection indices to their associated DMU flag. @ingroup map
/// Helper macro for converting SideSection indices to their associated DMU flag. @ingroup world
#define DMU_FLAG_FOR_SIDESECTION(s) (\
(s) == SS_MIDDLE? DMU_MIDDLE_OF_SIDE : \
(s) == SS_BOTTOM? DMU_BOTTOM_OF_SIDE : DMU_TOP_OF_SIDE)
Expand Down Expand Up @@ -584,7 +584,7 @@ typedef struct traceopening_s {
//------------------------------------------------------------------------

/// @defgroup mobj Map Objects
/// @ingroup map
/// @ingroup world

/**
* Linknodes are used when linking mobjs to lines. Each mobj has a ring
Expand Down Expand Up @@ -702,7 +702,7 @@ enum { MX, MY, MZ };
int health;\
mobjinfo_t *info; /* &mobjinfo[mobj->type] */

/// Base Polyobj elements. Games MUST use this as the basis for Polyobj. @ingroup map
/// Base Polyobj elements. Games MUST use this as the basis for Polyobj. @ingroup world
#define DD_BASE_POLYOBJ_ELEMENTS() \
DD_BASE_DDMOBJ_ELEMENTS() \
\
Expand Down
2 changes: 1 addition & 1 deletion doomsday/api/doomsday.h
Expand Up @@ -113,7 +113,7 @@

/**
* @defgroup polyobj Polygon Objects
* @ingroup map
* @ingroup world
*/

/**
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/render/walledge.h
Expand Up @@ -43,7 +43,7 @@ namespace de {
* Helper/utility class intended to simplify the process of generating
* sections of wall geometry from a map Line segment.
*
* @ingroup map
* @ingroup world
*/
class WallEdge : public WorldEdge
{
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/world/blockmap.h
@@ -1,6 +1,6 @@
/**
* @file blockmap.h
* Blockmap. @ingroup map
* Blockmap. @ingroup world
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/world/blockmapvisual.h
@@ -1,6 +1,6 @@
/**
* @file blockmapvisual.h
* Graphical Blockmap Visual. @ingroup map
* Graphical Blockmap Visual. @ingroup world
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/world/bspbuilder.h
Expand Up @@ -33,7 +33,7 @@ namespace de {
*
* BspBuilder constructs a BSP object object tree for the specified map.
*
* @ingroup map
* @ingroup world
*/
class BspBuilder
{
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/world/entitydatabase.h
@@ -1,6 +1,6 @@
/**
* @file entitydatabase.h
* Entity property value database. @ingroup map
* Entity property value database. @ingroup world
*
* The EntityDatabase is used in the process of transferring mobj spawn spot
* information and stuff like line action specials from the wad map loader
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/world/hedge.h
Expand Up @@ -31,7 +31,7 @@ namespace de {
/**
* Mesh half-edge geometry.
*
* @ingroup map
* @ingroup world
*/
class HEdge : public Mesh::Element
{
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/world/p_maptypes.h
@@ -1,5 +1,5 @@
/** @file world/p_maptypes.h Convenience header for including all map data types.
* @ingroup map
* @ingroup world
*
* @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2013 Daniel Swanson <danij@dengine.net>
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/world/p_maputil.h
@@ -1,6 +1,6 @@
/** @file world/p_maputil.h World Map Utility Routines.
*
* @ingroup map
* @ingroup world
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/include/world/p_particle.h
@@ -1,5 +1,5 @@
/** @file world/p_particle.h World Generator Management (Particles).
* @ingroup map
* @ingroup world
*
* @author Copyright &copy; 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @author Copyright &copy; 2006-2013 Daniel Swanson <danij@dengine.net>
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/src/world/blockmap.cpp
@@ -1,5 +1,5 @@
/** @file blockmap.cpp Blockmap.
* @ingroup map
* @ingroup world
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/src/world/blockmapvisual.cpp
@@ -1,5 +1,5 @@
/** @file blockmapvisual.cpp Graphical Blockmap Visual.
* @ingroup map
* @ingroup world
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/src/world/entitydatabase.cpp
@@ -1,5 +1,5 @@
/** @file entitydatabase.cpp Database of map entity property values.
* @ingroup map
* @ingroup world
*
* @authors Copyright &copy; 2007-2013 Daniel Swanson <danij@dengine.net>
*
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/src/world/generators.cpp
@@ -1,5 +1,5 @@
/** @file generators.cpp Generators.
* @ingroup map
* @ingroup world
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2013 Daniel Swanson <danij@dengine.net>
Expand Down
6 changes: 3 additions & 3 deletions doomsday/libdeng1/include/de/aabox.h
Expand Up @@ -26,7 +26,7 @@

/**
* Axis-aligned bounding box with integer precision.
* Handy POD structure for manipulation of bounding boxes. @ingroup map
* Handy POD structure for manipulation of bounding boxes. @ingroup world
*/
typedef struct aabox_s {
union {
Expand Down Expand Up @@ -71,7 +71,7 @@ typedef struct aabox_s {

/**
* Axis-aligned bounding box with floating-point precision.
* Handy POD structure for manipulation of bounding boxes. @ingroup map
* Handy POD structure for manipulation of bounding boxes. @ingroup world
*/
typedef struct aaboxf_s {
union {
Expand Down Expand Up @@ -116,7 +116,7 @@ typedef struct aaboxf_s {

/**
* Axis-aligned bounding box with double floating-point precision.
* Handy POD structure for manipulation of bounding boxes. @ingroup map
* Handy POD structure for manipulation of bounding boxes. @ingroup world
*/
typedef struct aaboxd_s {
union {
Expand Down

0 comments on commit 05751f9

Please sign in to comment.