diff --git a/doomsday/engine/portable/include/abstractfile.h b/doomsday/engine/portable/include/abstractfile.h index 45cb1fdfee..67875a42a7 100644 --- a/doomsday/engine/portable/include/abstractfile.h +++ b/doomsday/engine/portable/include/abstractfile.h @@ -70,27 +70,39 @@ typedef struct abstractfile_s { /** * Initialize this resource. * + * @param af AbstractFile instance. * @param type File type identifier. * @param path Path to this file in the virtual file system. * @param file Handle to the file. AbstractFile takes ownership of the handle. * @param info Lump info descriptor for the file. A copy is made. - * @return Same as @a af for convenience (chaining). + * + * @return @a af for convenience (chaining). */ abstractfile_t* AbstractFile_Init(abstractfile_t* af, filetype_t type, const char* path, DFile* file, const LumpInfo* info); /** * Release all memory acquired for objects linked with this resource. + * @param af AbstractFile instance. */ void AbstractFile_Destroy(abstractfile_t* af); -/// @return Type of this resource @see filetype_t +/** + * @param af AbstractFile instance. + * @return Type of this resource @see filetype_t + */ filetype_t AbstractFile_Type(const abstractfile_t* af); -/// @return Immutable copy of the info descriptor for this resource. +/** + * @param af AbstractFile instance. + * @return Immutable copy of the info descriptor for this resource. + */ const LumpInfo* AbstractFile_Info(abstractfile_t* af); -/// @return Owning package else @c NULL if not contained. +/** + * @param af AbstractFile instance. + * @return Owning package else @c NULL if not contained. + */ abstractfile_t* AbstractFile_Container(const abstractfile_t* af); /** diff --git a/doomsday/engine/portable/include/abstractresource.h b/doomsday/engine/portable/include/abstractresource.h index d672919548..311575b98b 100644 --- a/doomsday/engine/portable/include/abstractresource.h +++ b/doomsday/engine/portable/include/abstractresource.h @@ -42,6 +42,7 @@ void AbstractResource_Delete(AbstractResource* resource); /** * Add a new symbolic name to the list of names for this. * + * @param resource AbstractResource instance. * @param name New name for this resource. Newer names have precedence. */ void AbstractResource_AddName(AbstractResource* resource, const ddstring_t* name); @@ -49,12 +50,14 @@ void AbstractResource_AddName(AbstractResource* resource, const ddstring_t* name /** * Add a new sub-resource identity key to the list for this. * + * @param resource AbstractResource instance. * @param identityKey New identity key (e.g., a lump/file name). */ void AbstractResource_AddIdentityKey(AbstractResource* resource, const ddstring_t* identityKey); /** * Attempt to resolve a path to this resource. + * @param resource AbstractResource instance. * * @return Found path. */ diff --git a/doomsday/engine/portable/include/filedirectory.h b/doomsday/engine/portable/include/filedirectory.h index 509b0840dd..cf239f21ae 100644 --- a/doomsday/engine/portable/include/filedirectory.h +++ b/doomsday/engine/portable/include/filedirectory.h @@ -84,6 +84,7 @@ void FileDirectory_Clear(FileDirectory* fd); /** * Resolve and collate all paths in the directory into a list. * + * @param fd FileDirectory instance. * @param type If a valid type, only paths of this type will be visited. * @param count Number of visited paths is written back here. * @@ -95,6 +96,7 @@ ddstring_t* FileDirectory_AllPaths(FileDirectory* fd, pathdirectorynode_type_t t /** * Add a new set of paths. Duplicates are automatically pruned. * + * @param fd FileDirectory instance. * @param flags @see searchPathFlags * @param paths One or more paths. * @param pathsCount Number of elements in @a paths. @@ -110,6 +112,7 @@ void FileDirectory_AddPaths(FileDirectory* fd, int flags, const Uri* const* pat /** * Add a new set of paths from a path list. Duplicates are automatically pruned. * + * @param fd FileDirectory instance. * @param flags @see searchPathFlags * @param pathList One or more paths separated by semicolons. * @param callback Callback function ptr. @@ -124,6 +127,7 @@ void FileDirectory_AddPathList(FileDirectory* fd, int flags, const char* pathLis /** * Find a path in the directory. * + * @param fd FileDirectory instance. * @param type If a valid path type only consider nodes of this type. * @param searchPath Relative or absolute path. * @param searchDelimiter Fragments of @a searchPath are delimited by this character. @@ -139,6 +143,7 @@ boolean FileDirectory_Find(FileDirectory* fd, pathdirectorynode_type_t type, * Iterate over nodes in the directory making a callback for each. * Iteration ends when all nodes have been visited or a callback returns non-zero. * + * @param fd FileDirectory instance. * @param type If a valid path type only process nodes of this type. * @param parent If not @c NULL, only process child nodes of this node. * @param callback Callback function ptr. diff --git a/doomsday/engine/portable/include/filelist.h b/doomsday/engine/portable/include/filelist.h index b2b79b75e2..348721dfc7 100644 --- a/doomsday/engine/portable/include/filelist.h +++ b/doomsday/engine/portable/include/filelist.h @@ -118,7 +118,7 @@ DFile* FileList_RemoveFront(FileList* fl); DFile* FileList_RemoveBack(FileList* fl); /** - * Remove file reference at position @idx. + * Remove file reference at position @a idx. * * @param idx Index of the reference to be removed. Negative indexes allowed. * @return Ptr to file referenced by the removed node if successful else @c NULL. diff --git a/doomsday/engine/portable/include/fs_util.h b/doomsday/engine/portable/include/fs_util.h index 3c33262563..f26f46e05e 100644 --- a/doomsday/engine/portable/include/fs_util.h +++ b/doomsday/engine/portable/include/fs_util.h @@ -157,7 +157,7 @@ boolean F_MakeAbsolute(ddstring_t* dst, const ddstring_t* src); boolean F_TranslatePath(ddstring_t* dst, const ddstring_t* src); /** - * @important Not thread-safe! + * @warning Not thread-safe! * @return A prettier copy of the original path. */ const char* F_PrettyPath(const char* path); diff --git a/doomsday/engine/portable/include/gl_tex.h b/doomsday/engine/portable/include/gl_tex.h index 7c010f59ca..f82846207c 100644 --- a/doomsday/engine/portable/include/gl_tex.h +++ b/doomsday/engine/portable/include/gl_tex.h @@ -96,7 +96,7 @@ void ColorOutlinesIdx(uint8_t* pixels, int width, int height); void Desaturate(uint8_t* pixels, int width, int height, int pixelSize); /** - * @important Does not conform to any standard technique and adjustments + * @note Does not conform to any standard technique and adjustments * are applied symmetrically for all color components. * * @param pixels RGB(a) image to be enhanced. @@ -110,7 +110,8 @@ void EnhanceContrast(uint8_t* pixels, int width, int height, int pixelSize); * Equalize the specified luminance map such that the minimum and maximum * brightness covers the whole [0...255] range. * - * @algorithm Calculates shift deltas for bright and dark-side pixels by + * @par Algorithm + * Calculates shift deltas for bright and dark-side pixels by * averaging the luminosity of all pixels in the original image. * * @param pixels Luminance image to equalize. @@ -183,7 +184,9 @@ void FindAverageAlphaIdx(const uint8_t* pixels, int width, int height, /** * Calculates a clip region for the image that excludes alpha pixels. - * @algorithm: Cross spread from bottom > top, right > left (inside out). + * + * @par Algorithm + * Cross spread from bottom > top, right > left (inside out). * * @param pixels Image data to be processed. * @param width Width of the image in pixels. diff --git a/doomsday/engine/portable/include/p_maputil.h b/doomsday/engine/portable/include/p_maputil.h index e3e8b33ec5..17a01e1ae8 100644 --- a/doomsday/engine/portable/include/p_maputil.h +++ b/doomsday/engine/portable/include/p_maputil.h @@ -127,7 +127,7 @@ void P_MobjLink(mobj_t* mo, byte flags); int P_MobjUnlink(mobj_t* mo); /** - * @important Caller must ensure that the mobj is currently unlinked. + * @note Caller must ensure that the mobj is currently unlinked. */ void P_LinkMobjToLineDefs(mobj_t* mo); diff --git a/doomsday/engine/portable/include/r_lumobjs.h b/doomsday/engine/portable/include/r_lumobjs.h index e0be250246..9fe50674aa 100644 --- a/doomsday/engine/portable/include/r_lumobjs.h +++ b/doomsday/engine/portable/include/r_lumobjs.h @@ -198,7 +198,7 @@ int LO_LumobjsRadiusIterator(BspLeaf* bspLeaf, coord_t x, coord_t y, coord_t rad * Project all lights affecting the given quad (world space), calculate * coordinates (in texture space) then store into a new list of projections. * - * @assume The coordinates of the given quad must be contained wholly within + * @pre The coordinates of the given quad must be contained wholly within * the BSP leaf specified. This is due to an optimization within the lumobj * management which separates them according to their position in the BSP. * diff --git a/doomsday/engine/portable/include/r_shadow.h b/doomsday/engine/portable/include/r_shadow.h index d1039f3e6b..8fc591a81e 100644 --- a/doomsday/engine/portable/include/r_shadow.h +++ b/doomsday/engine/portable/include/r_shadow.h @@ -58,7 +58,7 @@ float R_ShadowAttenuationFactor(coord_t distance); * Project all mobj shadows affecting the given quad (world space), calculate * coordinates (in texture space) then store into a new list of projections. * - * @assume The coordinates of the given quad must be contained wholly within + * @pre The coordinates of the given quad must be contained wholly within * the BSP leaf specified. This is due to an optimization within the mobj * management which separates them according to their position in the BSP. * diff --git a/doomsday/engine/portable/include/rend_list.h b/doomsday/engine/portable/include/rend_list.h index d3c4791294..b6c6a762a4 100644 --- a/doomsday/engine/portable/include/rend_list.h +++ b/doomsday/engine/portable/include/rend_list.h @@ -110,7 +110,7 @@ void RL_LoadDefaultRtus(void); void RL_MapRtu(uint idx, const rtexmapunit_t* rtu); /** - * Copy the configuration for the identified @idx texture unit of + * Copy the configuration for the identified @a idx texture unit of * the primitive writer's internal state from @a rtu. * * @param idx Logical index of the texture unit being configured. @@ -134,7 +134,7 @@ void RL_Rtu_SetOffsetv(uint idx, float const st[2]); void RL_Rtu_TranslateOffset(uint idx, float s, float t); void RL_Rtu_TranslateOffsetv(uint idx, float const st[2]); -/// Change the texture assigned to the identified @idx texture unit. +/// Change the texture assigned to the identified @a idx texture unit. void RL_Rtu_SetTextureUnmanaged(uint idx, DGLuint glName); /** diff --git a/doomsday/engine/portable/include/sv_pool.h b/doomsday/engine/portable/include/sv_pool.h index 035e2903cd..166a3587b2 100644 --- a/doomsday/engine/portable/include/sv_pool.h +++ b/doomsday/engine/portable/include/sv_pool.h @@ -411,8 +411,8 @@ uint Sv_CountUnackedDeltas(uint clientNumber); * sound is in itself a 'delta-like' event, there is no need for comparing or * to have a register. * - * @important: Assumes no two sounds with the same ID play at the same time - * from the same origin at once. + * @note Assumes no two sounds with the same ID play at the same time + * from the same origin at once. * * @param volume Volume at which to play the sound, or zero for stop-sound. * @param clientsMask -1= all clients. diff --git a/doomsday/engine/portable/include/sys_direc.h b/doomsday/engine/portable/include/sys_direc.h index 01132423a8..af92543326 100644 --- a/doomsday/engine/portable/include/sys_direc.h +++ b/doomsday/engine/portable/include/sys_direc.h @@ -85,7 +85,7 @@ void Dir_CleanPathStr(ddstring_t* str); char* Dir_CurrentPath(void); /** - * Extract just the file name including any extension from @path. + * Extract just the file name including any extension from @a path. */ void Dir_FileName(char* name, const char* path, size_t len); diff --git a/doomsday/engine/portable/src/cbuffer.c b/doomsday/engine/portable/src/cbuffer.c index 542dd1234c..a883df22b1 100644 --- a/doomsday/engine/portable/src/cbuffer.c +++ b/doomsday/engine/portable/src/cbuffer.c @@ -78,7 +78,7 @@ static void lock(CBuffer* cb, boolean yes) Sys_Unlock(cb->mutex); } -/// \notes Also destroys the data object. +/// @note Also destroys the data object. static void destroyNode(cbnode_t* node) { assert(node); diff --git a/doomsday/engine/portable/src/cl_mobj.c b/doomsday/engine/portable/src/cl_mobj.c index 94aefb1485..d244dacb16 100644 --- a/doomsday/engine/portable/src/cl_mobj.c +++ b/doomsday/engine/portable/src/cl_mobj.c @@ -88,7 +88,7 @@ void checkMobjHash(void) */ static void ClMobj_LinkInHash(mobj_t* mo, thid_t id) { - /// @fixme Do not assume the CURRENT map. + /// @todo Do not assume the CURRENT map. cmhash_t* hash = GameMap_ClMobjHash(theMap, id); clmoinfo_t* info = ClMobj_GetInfo(mo); diff --git a/doomsday/engine/portable/src/cl_world.c b/doomsday/engine/portable/src/cl_world.c index 7217b459a1..d6bb82544a 100644 --- a/doomsday/engine/portable/src/cl_world.c +++ b/doomsday/engine/portable/src/cl_world.c @@ -314,7 +314,7 @@ void GameMap_DeleteClPolyobj(GameMap* map, clpolyobj_t* mover) */ void Cl_MoverThinker(clplane_t* mover) { - GameMap* map = theMap; /// @fixme Do not assume mover is from the CURRENT map. + GameMap* map = theMap; /// @todo Do not assume mover is from the CURRENT map. coord_t original; boolean remove = false; boolean freeMove; @@ -516,7 +516,7 @@ void Cl_PolyMoverThinker(clpolyobj_t* mover) // Can we get rid of this mover? if(!mover->move && !mover->rotate) { - /// @fixme Do not assume the move is from the CURRENT map. + /// @todo Do not assume the move is from the CURRENT map. GameMap_DeleteClPolyobj(theMap, mover); } } @@ -536,7 +536,7 @@ clpolyobj_t* GameMap_ClPolyobjByPolyobjIndex(GameMap* map, uint index) } /** - * @important Assumes there is no existing ClPolyobj for Polyobj @a index. + * @note Assumes there is no existing ClPolyobj for Polyobj @a index. */ clpolyobj_t* GameMap_NewClPolyobj(GameMap* map, uint polyobjIndex) { @@ -614,7 +614,7 @@ void Cl_ReadSectorDelta2(int deltaType, boolean skip) static Plane* dummyPlaneArray[2]; static Plane dummyPlanes[2]; - GameMap* map = theMap; /// @fixme Do not assume the CURRENT map. + GameMap* map = theMap; /// @todo Do not assume the CURRENT map. unsigned short num; Sector* sec; int df; diff --git a/doomsday/engine/portable/src/dd_main.c b/doomsday/engine/portable/src/dd_main.c index ebf2c3b910..84a57016af 100644 --- a/doomsday/engine/portable/src/dd_main.c +++ b/doomsday/engine/portable/src/dd_main.c @@ -1149,7 +1149,7 @@ boolean DD_ChangeGame2(Game* game, boolean allowReload) Sfx_InitLogical(); - /// @fixme Why is this being done here? + /// @todo Why is this being done here? if(theMap) { GameMap_InitThinkerLists(theMap, 0x1|0x2); @@ -1173,7 +1173,7 @@ boolean DD_ChangeGame2(Game* game, boolean allowReload) R_InitSvgs(); R_InitViewWindow(); - /// @fixme Assumes we only cache lumps from non-startup wads. + /// @todo Assumes we only cache lumps from non-startup wads. Z_FreeTags(PU_CACHE, PU_CACHE); F_Reset(); @@ -1183,7 +1183,7 @@ boolean DD_ChangeGame2(Game* game, boolean allowReload) FI_Shutdown(); titleFinale = 0; // If the title finale was in progress it isn't now. - /// @fixme Materials database should not be shutdown during a reload. + /// @todo Materials database should not be shutdown during a reload. Materials_Shutdown(); VERBOSE( @@ -2138,7 +2138,7 @@ void* DD_GetVariable(int ddvalue) return &valueU; case DD_TRACE_ADDRESS: - /// @fixme Do not cast away const. + /// @todo Do not cast away const. return (void*)P_TraceLOS(); case DD_TRANSLATIONTABLES_ADDRESS: diff --git a/doomsday/engine/portable/src/def_main.c b/doomsday/engine/portable/src/def_main.c index be5b9b7da2..b66ba2770f 100644 --- a/doomsday/engine/portable/src/def_main.c +++ b/doomsday/engine/portable/src/def_main.c @@ -650,7 +650,7 @@ int Def_GetTextNumForName(const char* name) } /** - * Escape sequences are un-escaped (\n, \r, \t, \s, \_). + * Escape sequences are un-escaped (\\n, \\r, \\t, \\s, \\_). */ void Def_InitTextDef(ddtext_t* txt, char* str) { diff --git a/doomsday/engine/portable/src/edit_map.c b/doomsday/engine/portable/src/edit_map.c index 24ef337d12..26c1fb2858 100644 --- a/doomsday/engine/portable/src/edit_map.c +++ b/doomsday/engine/portable/src/edit_map.c @@ -438,7 +438,7 @@ static void pruneUnusedSectors(editmap_t* map) #endif /** - * @important Order here is critical! + * @warning Order here is critical! */ void MPE_PruneRedundantMapData(editmap_t* map, int flags) { @@ -1251,8 +1251,9 @@ static void hardenPolyobjs(GameMap* dest, editmap_t* src) } /** - * @algorithm Cast a line horizontally or vertically and see what we hit. - * (OUCH, we have to iterate over all linedefs!). + * @par Algorithm + * Cast a line horizontally or vertically and see what we hit. + * (OUCH, we have to iterate over all linedefs!). */ static void testForWindowEffect(editmap_t* map, LineDef* l) { @@ -1401,7 +1402,8 @@ static void countVertexLineOwners(Vertex* vtx, uint* oneSided, uint* twoSided) } /** - * @algorithm Scan the linedef list looking for possible candidates, checking for + * @par Algorithm + * Scan the linedef list looking for possible candidates, checking for * an odd number of one-sided linedefs connected to a single vertex. This idea * courtesy of Graham Jackson. */ diff --git a/doomsday/engine/portable/src/finaleinterpreter.c b/doomsday/engine/portable/src/finaleinterpreter.c index e3e60cbaef..62470a4649 100644 --- a/doomsday/engine/portable/src/finaleinterpreter.c +++ b/doomsday/engine/portable/src/finaleinterpreter.c @@ -413,7 +413,7 @@ static fi_object_t* addObjectToNamespace(fi_namespace_t* names, const char* name } /** - * \assume There is at most one reference to the object in this scope. + * @pre There is at most one reference to the object in this scope. */ static fi_object_t* removeObjectInNamespace(fi_namespace_t* names, fi_object_t* obj) { diff --git a/doomsday/engine/portable/src/fonts.c b/doomsday/engine/portable/src/fonts.c index 19de2c8794..79f625ff92 100644 --- a/doomsday/engine/portable/src/fonts.c +++ b/doomsday/engine/portable/src/fonts.c @@ -157,7 +157,7 @@ static Uri* composeUriForDirectoryNode(const PathDirectoryNode* node) return uri; } -/// \assume fontIdMap has been initialized and is large enough! +/// @pre fontIdMap has been initialized and is large enough! static void unlinkDirectoryNodeFromBindIdMap(const PathDirectoryNode* node) { fontid_t id = findBindIdForDirectoryNode(node); @@ -165,7 +165,7 @@ static void unlinkDirectoryNodeFromBindIdMap(const PathDirectoryNode* node) fontIdMap[id - 1/*1-based index*/] = NULL; } -/// \assume uniqueIdMap has been initialized and is large enough! +/// @pre uniqueIdMap has been initialized and is large enough! static int linkRecordInUniqueIdMap(PathDirectoryNode* node, void* paramaters) { const fontrecord_t* record = (fontrecord_t*)PathDirectoryNode_UserData(node); @@ -175,7 +175,7 @@ static int linkRecordInUniqueIdMap(PathDirectoryNode* node, void* paramaters) return 0; // Continue iteration. } -/// \assume uniqueIdMap is large enough if initialized! +/// @pre uniqueIdMap is large enough if initialized! static int unlinkRecordInUniqueIdMap(PathDirectoryNode* node, void* paramaters) { const fontrecord_t* record = (fontrecord_t*)PathDirectoryNode_UserData(node); @@ -262,7 +262,7 @@ static PathDirectoryNode* findDirectoryNodeForPath(PathDirectory* directory, con return PathDirectory_Find(directory, PCF_NO_BRANCH|PCF_MATCH_FULL, path, FONTS_PATH_DELIMITER); } -/// \assume @a uri has already been validated and is well-formed. +/// @pre @a uri has already been validated and is well-formed. static PathDirectoryNode* findDirectoryNodeForUri(const Uri* uri) { fontnamespaceid_t namespaceId; diff --git a/doomsday/engine/portable/src/fs_main.c b/doomsday/engine/portable/src/fs_main.c index 4e3189232f..54565ff8db 100644 --- a/doomsday/engine/portable/src/fs_main.c +++ b/doomsday/engine/portable/src/fs_main.c @@ -1589,7 +1589,7 @@ static DFile* openAsLumpFile(abstractfile_t* container, int lumpIdx, } // Get a handle to the lump we intend to open. - /// @fixme The way this buffering works is nonsensical it should not be done here + /// @todo The way this buffering works is nonsensical it should not be done here /// but should instead be deferred until the content of the lump is read. hndl = DFileBuilder_NewFromAbstractFileLump(container, lumpIdx, false/*dontBuffer*/); @@ -2085,9 +2085,9 @@ static boolean parseLDMapping(lumpname_t lumpName, ddstring_t* path, const char* } /** - * LUMPNAM0 \Path\In\The\Base.ext + * 
LUMPNAM0 \Path\In\The\Base.ext
  * LUMPNAM1 Path\In\The\RuntimeDir.ext
- *  :
+ *  :
*/ static boolean parseLDMappingList(const char* buffer) { diff --git a/doomsday/engine/portable/src/gl_drawvectorgraphic.c b/doomsday/engine/portable/src/gl_drawvectorgraphic.c index f56dcb4a8f..a7893b5d9f 100644 --- a/doomsday/engine/portable/src/gl_drawvectorgraphic.c +++ b/doomsday/engine/portable/src/gl_drawvectorgraphic.c @@ -66,7 +66,7 @@ static uint indexForSvg(Svg* svg) /** * Link @a svg into the global collection. - * \assume Not presently linked. + * @pre Not presently linked. */ static Svg* insertSvg(Svg* svg) { diff --git a/doomsday/engine/portable/src/gl_tex.c b/doomsday/engine/portable/src/gl_tex.c index c7f76da6ac..7c7e9c4c4c 100644 --- a/doomsday/engine/portable/src/gl_tex.c +++ b/doomsday/engine/portable/src/gl_tex.c @@ -317,7 +317,7 @@ static void* packImage(int components, const float* tempOut, GLint typeOut, /** * Originally from the Mesa 3-D graphics library version 3.4 - * \license GNU Library General Public License (or later) + * @note License: GNU Library General Public License (or later) * Copyright (C) 1995-2000 Brian Paul. */ void* GL_ScaleBufferEx(const void* dataIn, int widthIn, int heightIn, int bpp, diff --git a/doomsday/engine/portable/src/gl_texmanager.c b/doomsday/engine/portable/src/gl_texmanager.c index e40b603143..9656c1657e 100644 --- a/doomsday/engine/portable/src/gl_texmanager.c +++ b/doomsday/engine/portable/src/gl_texmanager.c @@ -1587,7 +1587,7 @@ static int BytesPerPixelFmt(dgltexformat_t format) /** * Given a pixel format return the number of bytes to store one pixel. - * \assume Input data is of GL_UNSIGNED_BYTE type. + * @pre Input data is of GL_UNSIGNED_BYTE type. */ static int BytesPerPixel(GLint format) { @@ -1850,7 +1850,7 @@ boolean GL_UploadTexture(int glFormat, int loadFormat, const uint8_t* pixels, return true; } -/// \important Texture parameters will NOT be set here! +/// @note Texture parameters will NOT be set here! void GL_UploadTextureContent(const texturecontent_t* content) { assert(content); @@ -2224,7 +2224,7 @@ static boolean validPatch(const uint8_t* buffer, size_t len) } /** - * \important: The buffer must have room for the new alpha data! + * @note The buffer must have room for the new alpha data! * * @param dstBuf The destination buffer the patch will be drawn to. * @param texwidth Width of the dst buffer in pixels. @@ -3017,7 +3017,7 @@ static int setVariantMinFilterWorker(Texture* tex, void* paramaters) void GL_SetAllTexturesMinFilter(int minFilter) { int localMinFilter = minFilter; - /// @fixme This is no longer correct logic. Changing the global minification + /// @todo This is no longer correct logic. Changing the global minification /// filter should not modify the uploaded texture content. #if 0 Textures_Iterate2(TN_ANY, setVariantMinFilterWorker, (void*)&localMinFilter); diff --git a/doomsday/engine/portable/src/linedef.c b/doomsday/engine/portable/src/linedef.c index c26ea9b2b7..c5dc3950b5 100644 --- a/doomsday/engine/portable/src/linedef.c +++ b/doomsday/engine/portable/src/linedef.c @@ -348,7 +348,7 @@ int LineDef_MiddleMaterialCoords(const LineDef* lineDef, int side, } /** - * @fixme No need to do this each frame. Set a flag in SideDef->flags to + * @todo No need to do this each frame. Set a flag in SideDef->flags to * denote this. Is sensitive to plane heights, surface properties * (e.g. alpha) and surface texture properties. */ diff --git a/doomsday/engine/portable/src/lumpdirectory.c b/doomsday/engine/portable/src/lumpdirectory.c index 4415c18968..356bbd9751 100644 --- a/doomsday/engine/portable/src/lumpdirectory.c +++ b/doomsday/engine/portable/src/lumpdirectory.c @@ -121,7 +121,7 @@ int LumpDirectory_Size(LumpDirectory* ld) /** * Moves @a count lumps starting beginning at @a from. - * \assume LumpDirectory::records is large enough for this operation! + * @pre LumpDirectory::records is large enough for this operation! */ static void LumpDirectory_Move(LumpDirectory* ld, uint from, uint count, int offset) { diff --git a/doomsday/engine/portable/src/map/bsp/partitioner.cpp b/doomsday/engine/portable/src/map/bsp/partitioner.cpp index 37ecd32817..8943e4955d 100644 --- a/doomsday/engine/portable/src/map/bsp/partitioner.cpp +++ b/doomsday/engine/portable/src/map/bsp/partitioner.cpp @@ -1371,7 +1371,8 @@ struct Partitioner::Instance { Q_ASSERT(point); - /// @algorithm "double bubble" + /// @par Algorithm + /// "double bubble" bool done = false; while(begin != end && !done) { @@ -1544,9 +1545,9 @@ struct Partitioner::Instance * Traverse the BSP tree and sort all half-edges in each BSP leaf into a * clockwise order. * - * @important This cannot be done during Partitioner::buildNodes() as - * splitting a half-edge with a twin will result in another half-edge being - * inserted into that twin's leaf (usually in the wrong place order-wise). + * @note This cannot be done during Partitioner::buildNodes() as splitting + * a half-edge with a twin will result in another half-edge being inserted + * into that twin's leaf (usually in the wrong place order-wise). */ void windLeafs() { diff --git a/doomsday/engine/portable/src/materials.c b/doomsday/engine/portable/src/materials.c index 8acbf4d6c0..02cb1e422b 100644 --- a/doomsday/engine/portable/src/materials.c +++ b/doomsday/engine/portable/src/materials.c @@ -531,7 +531,7 @@ static material_t* allocMaterial(void) /** * Link the material into the global list of materials. - * \assume material is NOT already present in the global list. + * @pre material is NOT already present in the global list. */ static material_t* linkMaterialToGlobalList(material_t* mat) { @@ -839,7 +839,7 @@ static materialbind_t* findMaterialBindForPath(PathDirectory* matDirectory, cons return NULL; // Not found. } -/// \assume @a uri has already been validated and is well-formed. +/// @pre @a uri has already been validated and is well-formed. static materialbind_t* findMaterialBindForUri(const Uri* uri) { materialnamespaceid_t namespaceId = Materials_ParseNamespace(Str_Text(Uri_Scheme(uri))); diff --git a/doomsday/engine/portable/src/materialvariant.c b/doomsday/engine/portable/src/materialvariant.c index 3b005f1954..0c7c3efea5 100644 --- a/doomsday/engine/portable/src/materialvariant.c +++ b/doomsday/engine/portable/src/materialvariant.c @@ -146,7 +146,7 @@ void MaterialVariant_Ticker(materialvariant_t* mat, timespan_t time) } else { - /// @fixme Should reset this to the non-stage animated texture here. + /// @todo Should reset this to the non-stage animated texture here. //layer->tex = 0; //generalCase->inter = 0; }}*/ diff --git a/doomsday/engine/portable/src/p_dmu.c b/doomsday/engine/portable/src/p_dmu.c index 6c71b96d3b..d6f09b3c53 100644 --- a/doomsday/engine/portable/src/p_dmu.c +++ b/doomsday/engine/portable/src/p_dmu.c @@ -962,19 +962,17 @@ static int setProperty(void* obj, void* context) // BspLeaf* updateBspLeaf = NULL; /** - * \algorithm: - * + * @par Algorithm * When setting a property, reference resolution is done hierarchically so * that we can update all owner's of the objects being manipulated should * the DMU object's Set routine suggest that a change occured (which other * DMU objects may wish/need to respond to). - * - * 1) Collect references to all current owners of the object. - * 2) Pass the change delta on to the object. - * 3) Object responds: - * @c true = update owners, ELSE @c false. - * 4) If num collected references > 0 - * recurse, Object = owners[n] + *
    + *
  1. Collect references to all current owners of the object. + *
  2. Pass the change delta on to the object. + *
  3. Object responds: @c true = update owners, ELSE @c false. + *
  4. If num collected references > 0: recurse, Object = owners[n] + *
*/ // Dereference where necessary. Note the order, these cascade. diff --git a/doomsday/engine/portable/src/p_maputil.c b/doomsday/engine/portable/src/p_maputil.c index a31d0eb947..96c3fcf40d 100644 --- a/doomsday/engine/portable/src/p_maputil.c +++ b/doomsday/engine/portable/src/p_maputil.c @@ -98,7 +98,7 @@ void P_SetTraceOpening(LineDef* lineDef) DEBUG_Message(("Warning: P_SetTraceOpening() attempted with no current map, ignoring.")); return; } - /// @fixme Do not assume linedef is from the CURRENT map. + /// @todo Do not assume linedef is from the CURRENT map. GameMap_SetTraceOpening(theMap, lineDef); } @@ -152,7 +152,7 @@ boolean P_IsPointXYInSector(coord_t x, coord_t y, const Sector* sector) BspLeaf* bspLeaf; if(!sector) return false; // I guess? - /// @fixme Do not assume @a sector is from the current map. + /// @todo Do not assume @a sector is from the current map. bspLeaf = GameMap_BspLeafAtPointXY(theMap, x, y); if(bspLeaf->sector != sector) return false; @@ -242,7 +242,7 @@ boolean GameMap_UnlinkMobjFromLineDefs(GameMap* map, mobj_t* mo) } /** - * @important Caller must ensure a mobj is linked only once to any given linedef. + * @note Caller must ensure a mobj is linked only once to any given linedef. * * @param map GameMap instance. * @param mo Mobj to be linked. @@ -301,7 +301,7 @@ int PIT_LinkToLines(LineDef* ld, void* parameters) } /** - * @important Caller must ensure that the mobj is currently unlinked. + * @note Caller must ensure that the mobj is currently unlinked. */ void GameMap_LinkMobjToLineDefs(GameMap* map, mobj_t* mo) { @@ -554,7 +554,7 @@ int GameMap_SectorTouchingMobjsIterator(GameMap* map, Sector* sector, */ int PIT_AddLineDefIntercepts(LineDef* lineDef, void* parameters) { - /// @fixme Do not assume lineDef is from the current map. + /// @todo Do not assume lineDef is from the current map. const divline_t* traceLOS = GameMap_TraceLOS(theMap); float distance; divline_t dl; @@ -600,7 +600,7 @@ int PIT_AddMobjIntercepts(mobj_t* mo, void* paramaters) return false; // $democam: ssshh, keep going, we're not here... // Check a corner to corner crossection for hit. - /// @fixme Do not assume mobj is from the current map. + /// @todo Do not assume mobj is from the current map. traceLOS = GameMap_TraceLOS(theMap); if((traceLOS->direction[VX] ^ traceLOS->direction[VY]) > 0) { @@ -641,28 +641,28 @@ int PIT_AddMobjIntercepts(mobj_t* mo, void* paramaters) void P_LinkMobjInBlockmap(mobj_t* mo) { - /// @fixme Do not assume mobj is from the current map. + /// @todo Do not assume mobj is from the current map. if(!theMap) return; GameMap_LinkMobj(theMap, mo); } boolean P_UnlinkMobjFromBlockmap(mobj_t* mo) { - /// @fixme Do not assume mobj is from the current map. + /// @todo Do not assume mobj is from the current map. if(!theMap) return false; return GameMap_UnlinkMobj(theMap, mo); } void P_LinkMobjToLineDefs(mobj_t* mo) { - /// @fixme Do not assume mobj is from the current map. + /// @todo Do not assume mobj is from the current map. if(!theMap) return; GameMap_LinkMobjToLineDefs(theMap, mo); } boolean P_UnlinkMobjFromLineDefs(mobj_t* mo) { - /// @fixme Do not assume mobj is from the current map. + /// @todo Do not assume mobj is from the current map. if(!theMap) return false; return GameMap_UnlinkMobjFromLineDefs(theMap, mo); } @@ -673,7 +673,7 @@ boolean P_UnlinkMobjFromLineDefs(mobj_t* mo) */ int P_MobjLinesIterator(mobj_t* mo, int (*callback) (LineDef*, void*), void* parameters) { - /// @fixme Do not assume mobj is in the current map. + /// @todo Do not assume mobj is in the current map. if(!theMap) return false; // Continue iteration. return GameMap_MobjLinesIterator(theMap, mo, callback, parameters); } @@ -686,14 +686,14 @@ int P_MobjLinesIterator(mobj_t* mo, int (*callback) (LineDef*, void*), void* par */ int P_MobjSectorsIterator(mobj_t* mo, int (*callback) (Sector*, void*), void* parameters) { - /// @fixme Do not assume mobj is in the current map. + /// @todo Do not assume mobj is in the current map. if(!theMap) return false; // Continue iteration. return GameMap_MobjSectorsIterator(theMap, mo, callback, parameters); } int P_LineMobjsIterator(LineDef* lineDef, int (*callback) (mobj_t*, void*), void* parameters) { - /// @fixme Do not assume lineDef is in the current map. + /// @todo Do not assume lineDef is in the current map. if(!theMap) return false; // Continue iteration. return GameMap_LineMobjsIterator(theMap, lineDef, callback, parameters); } @@ -708,7 +708,7 @@ int P_LineMobjsIterator(LineDef* lineDef, int (*callback) (mobj_t*, void*), void */ int P_SectorTouchingMobjsIterator(Sector* sector, int (*callback) (mobj_t*, void*), void* parameters) { - /// @fixme Do not assume sector is in the current map. + /// @todo Do not assume sector is in the current map. if(!theMap) return false; // Continue iteration. return GameMap_SectorTouchingMobjsIterator(theMap, sector, callback, parameters); } diff --git a/doomsday/engine/portable/src/p_mobj.c b/doomsday/engine/portable/src/p_mobj.c index 600c2c207d..04875bc665 100644 --- a/doomsday/engine/portable/src/p_mobj.c +++ b/doomsday/engine/portable/src/p_mobj.c @@ -234,7 +234,7 @@ void Mobj_OriginSmoothed(mobj_t* mo, coord_t origin[3]) if(mo->dPlayer) { - /// @fixme What about splitscreen? We have smoothed coords for all local players. + /// @todo What about splitscreen? We have smoothed coords for all local players. if(P_GetDDPlayerIdx(mo->dPlayer) == consolePlayer) { const viewdata_t* vd = R_ViewData(consolePlayer); @@ -254,7 +254,7 @@ angle_t Mobj_AngleSmoothed(mobj_t* mo) if(mo->dPlayer) { - /// @fixme What about splitscreen? We have smoothed angles for all local players. + /// @todo What about splitscreen? We have smoothed angles for all local players. if(P_GetDDPlayerIdx(mo->dPlayer) == consolePlayer) { const viewdata_t* vd = R_ViewData(consolePlayer); diff --git a/doomsday/engine/portable/src/p_objlink.c b/doomsday/engine/portable/src/p_objlink.c index f6ee0ee226..199444ac6b 100644 --- a/doomsday/engine/portable/src/p_objlink.c +++ b/doomsday/engine/portable/src/p_objlink.c @@ -557,7 +557,7 @@ BEGIN_PROF( PROF_OBJLINK_SPREAD ); END_PROF( PROF_OBJLINK_SPREAD ); } -/// @assume Coordinates held by @a blockXY are within valid range. +/// @pre Coordinates held by @a blockXY are within valid range. static void linkObjlinkInBlockmap(objlinkblockmap_t* obm, objlink_t* link, uint blockXY[2]) { objlinkblock_t* block; diff --git a/doomsday/engine/portable/src/p_particle.c b/doomsday/engine/portable/src/p_particle.c index 0804aa3837..93149fa2cb 100644 --- a/doomsday/engine/portable/src/p_particle.c +++ b/doomsday/engine/portable/src/p_particle.c @@ -78,7 +78,7 @@ void PtcGen_Delete(ptcgen_t* gen) static int destroyGenerator(ptcgen_t* gen, void* parameters) { - GameMap* map = theMap; /// @fixme Do not assume generator is from the CURRENT map. + GameMap* map = theMap; /// @todo Do not assume generator is from the CURRENT map. Generators_Unlink(GameMap_Generators(map), gen); GameMap_ThinkerRemove(map, &gen->thinker); @@ -300,7 +300,7 @@ void P_SpawnMobjParticleGen(const ded_ptcgen_t* def, mobj_t* source) if(isDedicated || !useParticles)return; - /// @fixme Do not assume the source mobj is from the CURRENT map. + /// @todo Do not assume the source mobj is from the CURRENT map. gen = P_NewGenerator(); if(!gen) return; @@ -346,7 +346,7 @@ static int generatorByPlaneIterator(ptcgen_t* gen, void* parameters) static ptcgen_t* generatorByPlane(Plane* plane) { - GameMap* map = theMap; /// @fixme Do not assume plane is from the CURRENT map. + GameMap* map = theMap; /// @todo Do not assume plane is from the CURRENT map. Generators* gens = GameMap_Generators(map); generatorbyplaneiterator_params_t parm; parm.plane = plane; @@ -641,7 +641,7 @@ static void P_NewParticle(ptcgen_t* gen) * Choosing the XY spot is a bit more difficult. * But we must be fast and only sufficiently accurate. * - * @fixme Nothing prevents spawning on the wrong side (or inside) + * @todo Nothing prevents spawning on the wrong side (or inside) * of one-sided walls (large diagonal BSP leafs!). */ for(i = 0; i < 5; ++i) // Try a couple of times (max). @@ -875,7 +875,7 @@ static void P_SpinParticle(ptcgen_t* gen, particle_t* pt) static const int yawSigns[4] = { 1, 1, -1, -1 }; static const int pitchSigns[4] = { 1, -1, 1, -1 }; - Generators* gens = GameMap_Generators(theMap); /// @fixme Do not assume generator is from the CURRENT map. + Generators* gens = GameMap_Generators(theMap); /// @todo Do not assume generator is from the CURRENT map. ded_ptcstage_t* stDef = &gen->def->stages[pt->stage]; uint index = pt - &gen->ptcs[Generators_GeneratorId(gens, gen) / 8]; int yawSign, pitchSign; @@ -914,7 +914,7 @@ static void P_MoveParticle(ptcgen_t* gen, particle_t* pt) P_SpinParticle(gen, pt); // Changes to momentum. - /// @fixme Do not assume generator is from the CURRENT map. + /// @todo Do not assume generator is from the CURRENT map. pt->mov[VZ] -= FixedMul(FLT2FIX(GameMap_Gravity(theMap)), st->gravity); // Vector force. @@ -1086,7 +1086,7 @@ static void P_MoveParticle(ptcgen_t* gen, particle_t* pt) coord_t pz = P_GetParticleZ(pt); coord_t fz, cz; - /// @fixme $nplanes + /// @todo $nplanes if(front->SP_floorheight > back->SP_floorheight) fz = front->SP_floorheight; else diff --git a/doomsday/engine/portable/src/p_polyobjs.c b/doomsday/engine/portable/src/p_polyobjs.c index 11e25a8379..11716c2716 100644 --- a/doomsday/engine/portable/src/p_polyobjs.c +++ b/doomsday/engine/portable/src/p_polyobjs.c @@ -58,13 +58,13 @@ void P_PolyobjChanged(Polyobj* po) void P_PolyobjUnlink(Polyobj* po) { - GameMap* map = theMap; /// @fixme Do not assume polyobj is from the CURRENT map. + GameMap* map = theMap; /// @todo Do not assume polyobj is from the CURRENT map. GameMap_UnlinkPolyobj(map, po); } void P_PolyobjLink(Polyobj* po) { - GameMap* map = theMap; /// @fixme Do not assume polyobj is from the CURRENT map. + GameMap* map = theMap; /// @todo Do not assume polyobj is from the CURRENT map. GameMap_LinkPolyobj(map, po); } diff --git a/doomsday/engine/portable/src/p_think.c b/doomsday/engine/portable/src/p_think.c index e4125976fe..08bb009745 100644 --- a/doomsday/engine/portable/src/p_think.c +++ b/doomsday/engine/portable/src/p_think.c @@ -36,7 +36,7 @@ static thid_t newMobjID(GameMap* map) { assert(map); // Increment the ID dealer until a free ID is found. - // @fixme What if all IDs are in use? 65535 thinkers!? + // @todo What if all IDs are in use? 65535 thinkers!? while(GameMap_IsUsedMobjID(map, ++map->thinkers.iddealer)); // Mark this ID as used. GameMap_SetMobjID(map, map->thinkers.iddealer, true); diff --git a/doomsday/engine/portable/src/r_lumobjs.c b/doomsday/engine/portable/src/r_lumobjs.c index 139c03044a..b434f4ef7f 100644 --- a/doomsday/engine/portable/src/r_lumobjs.c +++ b/doomsday/engine/portable/src/r_lumobjs.c @@ -590,7 +590,7 @@ static lumobj_t* allocLumobj(void) lumobj_t* lum; // Only allocate memory when it's needed. - /// @fixme No upper limit? + /// @todo No upper limit? if(++numLuminous > maxLuminous) { uint i, newMax = maxLuminous + LUMOBJ_BATCH_SIZE; @@ -1108,7 +1108,7 @@ boolean LOIT_ClipLumObj(void* data, void* context) luminousClipped[lumIdx] = 0; - /// @fixme Determine the exact centerpoint of the light in addLuminous! + /// @todo Determine the exact centerpoint of the light in addLuminous! V3d_Set(origin, lum->origin[VX], lum->origin[VY], lum->origin[VZ] + LUM_OMNI(lum)->zOff); /** diff --git a/doomsday/engine/portable/src/r_things.c b/doomsday/engine/portable/src/r_things.c index 8815323150..1e9297945a 100644 --- a/doomsday/engine/portable/src/r_things.c +++ b/doomsday/engine/portable/src/r_things.c @@ -1265,7 +1265,7 @@ void R_ProjectSprite(mobj_t* mo) align = true; // Perform visibility checking. - /// @fixme R_VisualRadius() does not consider sprite rotation. + /// @todo R_VisualRadius() does not consider sprite rotation. { coord_t center[2], v1[2], v2[2]; coord_t width = R_VisualRadius(mo)*2, offset = 0; @@ -1601,7 +1601,7 @@ int RIT_AddSprite(void* ptr, void* paramaters) mobj_t* mo = (mobj_t*) ptr; addspriteparams_t* params = (addspriteparams_t*)paramaters; Sector* sec = params->bspLeaf->sector; - GameMap* map = theMap; /// @fixme Do not assume mobj is from the CURRENT map. + GameMap* map = theMap; /// @todo Do not assume mobj is from the CURRENT map. if(mo->addFrameCount != frameCount) { @@ -1811,7 +1811,7 @@ int RIT_VisSpriteLightIterator(const lumobj_t* lum, coord_t xyDist, void* parama * Calculate the normalized direction vector, pointing out of * the vissprite. * - * @fixme Project the nearest point on the surface to determine + * @todo Project the nearest point on the surface to determine * the real direction vector. */ vlight->vector[VX] = LUM_PLANE(lum)->normal[VX]; diff --git a/doomsday/engine/portable/src/r_world.c b/doomsday/engine/portable/src/r_world.c index eb5964e6aa..da724fd96b 100644 --- a/doomsday/engine/portable/src/r_world.c +++ b/doomsday/engine/portable/src/r_world.c @@ -272,7 +272,7 @@ boolean resetSurfaceScroll(Surface* suf, void* context) suf->oldOffset[1][0] = suf->oldOffset[1][1] = suf->offset[1]; Surface_Update(suf); - /// @fixme Do not assume surface is from the CURRENT map. + /// @todo Do not assume surface is from the CURRENT map. R_SurfaceListRemove(GameMap_ScrollingSurfaces(theMap), suf); return true; @@ -299,7 +299,7 @@ boolean interpSurfaceScroll(Surface* suf, void* context) // Has this material reached its destination? if(suf->visOffset[0] == suf->offset[0] && suf->visOffset[1] == suf->offset[1]) { - /// @fixme Do not assume surface is from the CURRENT map. + /// @todo Do not assume surface is from the CURRENT map. R_SurfaceListRemove(GameMap_ScrollingSurfaces(theMap), suf); } @@ -1439,7 +1439,7 @@ void R_SetupMap(int mode, int flags) { BspLeaf* bspLeaf = P_BspLeafAtPoint(ddpl->mo->origin); - /// @fixme $nplanes + /// @todo $nplanes if(bspLeaf && ddpl->mo->origin[VZ] >= bspLeaf->sector->SP_floorvisheight && ddpl->mo->origin[VZ] < bspLeaf->sector->SP_ceilvisheight - 4) ddpl->inVoid = false; } @@ -1739,7 +1739,7 @@ boolean R_UpdatePlane(Plane* pln, boolean forceUpdate) if(!ddpl->inGame || !ddpl->mo || !ddpl->mo->bspLeaf) continue; - /// @fixme $nplanes + /// @todo $nplanes if((ddpl->flags & DDPF_CAMERA) && ddpl->mo->bspLeaf->sector == sec && (ddpl->mo->origin[VZ] > sec->SP_ceilheight - 4 || ddpl->mo->origin[VZ] < sec->SP_floorheight)) { diff --git a/doomsday/engine/portable/src/rect.c b/doomsday/engine/portable/src/rect.c index 3aeed48301..c25b7699d1 100644 --- a/doomsday/engine/portable/src/rect.c +++ b/doomsday/engine/portable/src/rect.c @@ -284,7 +284,7 @@ RectRaw* Rect_Normalized(const Rect* rect, RectRaw* normalized) return normalized; } -/// \assume This and @a other have been normalized. +/// @pre This and @a other have been normalized. static Rect* Rect_UniteRaw2(Rect* r, const RectRaw* other) { Point2Raw oldOrigin; @@ -607,7 +607,7 @@ RectRawf* Rectf_Normalized(const Rectf* rect, RectRawf* normalized) return normalized; } -/// \assume This and @a other have been normalized. +/// @pre This and @a other have been normalized. static Rectf* Rectf_UniteRaw2(Rectf* r, const RectRawf* other) { Point2Rawf oldOrigin; diff --git a/doomsday/engine/portable/src/rend_bias.c b/doomsday/engine/portable/src/rend_bias.c index ef46aa7e2f..89a245ad73 100644 --- a/doomsday/engine/portable/src/rend_bias.c +++ b/doomsday/engine/portable/src/rend_bias.c @@ -636,7 +636,7 @@ static void updateAffected2(biassurface_t* bsuf, const struct rvertex_s* rvertic continue; // Calculate minimum 2D distance to the BSP leaf. - /// @fixme This is probably too accurate an estimate. + /// @todo This is probably too accurate an estimate. for(k = 0; k < bsuf->size; ++k) { V2d_Set(delta, rvertices[k].pos[VX] - src->origin[VX], @@ -1103,7 +1103,7 @@ void SB_AmbientLight(coord_t const* point, float* light) * point have changed. This is needed when there has been world geometry * changes. 'illum' is allowed to be NULL. * - * @fixme Only recalculate the changed lights. The colors contributed + * @todo Only recalculate the changed lights. The colors contributed * by the others can be saved with the 'affected' array. */ void SB_EvalPoint(float light[4], vertexillum_t* illum, diff --git a/doomsday/engine/portable/src/rend_clip.cpp b/doomsday/engine/portable/src/rend_clip.cpp index 42ac78aa5c..add74d261e 100644 --- a/doomsday/engine/portable/src/rend_clip.cpp +++ b/doomsday/engine/portable/src/rend_clip.cpp @@ -108,7 +108,7 @@ static uint anglistSize = 0; static binangle_t *anglist; /** - * @important The point should be view-relative! + * @note The point should be view-relative! */ static binangle_t C_PointToAngle(coord_t* point) { @@ -536,7 +536,7 @@ static int C_TryMergeOccludes(OccNode* orange, OccNode* other) if(crossAngle >= orange->start && crossAngle <= orange->end) return 0; // Inside the range, can't do a thing. - /// @fixme Isn't it possible to consistently determine which direction + /// @todo Isn't it possible to consistently determine which direction /// the cross vector is pointing to? crossAngle += BANG_180; if(crossAngle >= orange->start && crossAngle <= orange->end) @@ -1047,7 +1047,7 @@ static boolean C_IsSegOccluded(coord_t relv1[3], coord_t relv2[3], coord_t relto // Remember, side2 has a smaller angle. - /// @fixme What about trueStart/trueEnd!!! and isSafe! it must have + /// @todo What about trueStart/trueEnd!!! and isSafe! it must have /// an effect on this... if(side2) diff --git a/doomsday/engine/portable/src/rend_decor.c b/doomsday/engine/portable/src/rend_decor.c index 3a3ddbd2ff..e71ee21017 100644 --- a/doomsday/engine/portable/src/rend_decor.c +++ b/doomsday/engine/portable/src/rend_decor.c @@ -135,7 +135,7 @@ static void projectDecoration(decorsource_t* src) if(distance > src->maxDistance) return; - /// @fixme dj: Why is LO_GetLuminous returning NULL given a supposedly valid index? + /// @todo dj: Why is LO_GetLuminous returning NULL given a supposedly valid index? if(!LO_GetLuminous(src->lumIdx)) return; diff --git a/doomsday/engine/portable/src/rend_fakeradio.c b/doomsday/engine/portable/src/rend_fakeradio.c index 474bc823d6..76c48e5299 100644 --- a/doomsday/engine/portable/src/rend_fakeradio.c +++ b/doomsday/engine/portable/src/rend_fakeradio.c @@ -1481,7 +1481,7 @@ static void radioBspLeafEdges(const BspLeaf* bspLeaf) return; // No point drawing shadows in a PITCH black sector. // Determine the shadow properties. - /// @fixme Make cvars out of constants. + /// @todo Make cvars out of constants. shadowWallSize = 2 * (8 + 16 - sectorlight * 16); shadowDark = Rend_RadioCalcShadowDarkness(sectorlight); diff --git a/doomsday/engine/portable/src/rend_font.c b/doomsday/engine/portable/src/rend_font.c index f9f6d3ee9f..c647dbba36 100644 --- a/doomsday/engine/portable/src/rend_font.c +++ b/doomsday/engine/portable/src/rend_font.c @@ -172,7 +172,7 @@ void FR_Ticker(timespan_t ticLength) return; // Restricted to fixed 35 Hz ticks. - /// @fixme We should not be synced to the games' fixed "sharp" timing. + /// @todo We should not be synced to the games' fixed "sharp" timing. /// This font renderer is used by the engine's UI also. if(!DD_IsSharpTick()) return; // It's too soon. @@ -820,8 +820,8 @@ static void drawChar(unsigned char ch, int posX, int posY, font_t* font, switch(Font_Type(font)) { case FT_BITMAP: - /// @fixme Filtering should be determined at a higher level. - /// @fixme We should not need to re-bind this texture here. + /// @todo Filtering should be determined at a higher level. + /// @todo We should not need to re-bind this texture here. GL_BindTextureUnmanaged(BitmapFont_GLTextureName(font), filterUI? GL_LINEAR : GL_NEAREST); memcpy(&geometry, BitmapFont_CharGeometry(font, ch), sizeof(geometry)); diff --git a/doomsday/engine/portable/src/rend_list.c b/doomsday/engine/portable/src/rend_list.c index c26ca684bd..c4ec289906 100644 --- a/doomsday/engine/portable/src/rend_list.c +++ b/doomsday/engine/portable/src/rend_list.c @@ -886,7 +886,7 @@ static void writePrimitive(const rendlist_t* list, uint base, /** * Adds one or more polys the render lists depending on configuration. - * \assume Caller knows what they are doing. Arguments are not validity checked. + * @pre Caller knows what they are doing. Arguments are not validity checked. */ static void writePoly2(primtype_t type, rendpolytype_t polyType, int flags, uint numElements, const rvertex_t* vertices, const ColorRawf* colors, @@ -1047,7 +1047,7 @@ static __inline boolean isWriteStateRTU(const rtexmapunit_t* ptr) } /** - * If the identified @idx texture unit of the primitive writer has been + * If the identified @a idx texture unit of the primitive writer has been * mapped to an external address, insert a copy of it into our internal * write state. * diff --git a/doomsday/engine/portable/src/rend_main.c b/doomsday/engine/portable/src/rend_main.c index aadd239e7f..f8a2bde8d1 100644 --- a/doomsday/engine/portable/src/rend_main.c +++ b/doomsday/engine/portable/src/rend_main.c @@ -531,7 +531,7 @@ void Rend_AddMaskedPoly(const rvertex_t* rvertices, const ColorRawf* rcolors, } // Choose an appropriate variant. - /// @fixme Can result in multiple variants being prepared. + /// @todo Can result in multiple variants being prepared. /// This decision should be made earlier (in rendHEdgeSection()). material = Materials_ChooseVariant(MaterialVariant_GeneralCase(material), mapSurfaceMaterialSpec(wrapS, wrapT), true, true); @@ -553,7 +553,7 @@ void Rend_AddMaskedPoly(const rvertex_t* rvertices, const ColorRawf* rcolors, } } - /// @fixme Semitransparent masked polys arn't lit atm + /// @todo Semitransparent masked polys arn't lit atm if(glow < 1 && lightListIdx && numTexUnits > 1 && envModAdd && !(rcolors[0].rgba[CA] < 1)) { @@ -1381,7 +1381,7 @@ static boolean doRenderHEdge(HEdge* hedge, const pvec3f_t normal, if(ll > 0) { // Determine the shadow properties. - /// @fixme Make cvars out of constants. + /// @todo Make cvars out of constants. radioParams.shadowSize = 2 * (8 + 16 - ll * 16); radioParams.shadowDark = Rend_RadioCalcShadowDarkness(ll); @@ -2396,11 +2396,11 @@ static void Rend_WriteBspLeafSkyFixGeometry(BspLeaf* leaf, int skyFix) * We are assured by the node build process that BspLeaf->hedges has been ordered * by angle, clockwise starting from the smallest angle. * - * @algorithm: - * For each vertex + * @par Algorithm + * 
For each vertex
  *    For each triangle
  *        if area is not greater than minimum bound, move to next vertex
- *    Vertex is suitable
+ *    Vertex is suitable
* * If a vertex exists which results in no zero-area triangles it is suitable for * use as the center of our trifan. If a suitable vertex is not found then the @@ -3104,7 +3104,7 @@ static void drawSoundOrigin(coord_t const origin[3], const char* label, coord_t static int drawSideDefSoundOrigins(SideDef* side, void* parameters) { - uint idx = GameMap_SideDefIndex(theMap, side); /// @fixme Do not assume current map. + uint idx = GameMap_SideDefIndex(theMap, side); /// @todo Do not assume current map. char buf[80]; dd_snprintf(buf, 80, "Side #%i (middle)", idx); @@ -3120,7 +3120,7 @@ static int drawSideDefSoundOrigins(SideDef* side, void* parameters) static int drawSectorSoundOrigins(Sector* sec, void* parameters) { - uint idx = GameMap_SectorIndex(theMap, sec); /// @fixme Do not assume current map. + uint idx = GameMap_SectorIndex(theMap, sec); /// @todo Do not assume current map. char buf[80]; if(devSoundOrigins & SOF_PLANE) diff --git a/doomsday/engine/portable/src/rend_particle.c b/doomsday/engine/portable/src/rend_particle.c index 766d0e43cf..64fbf90a44 100644 --- a/doomsday/engine/portable/src/rend_particle.c +++ b/doomsday/engine/portable/src/rend_particle.c @@ -205,7 +205,7 @@ void Rend_ParticleMarkInSectorVisible(Sector* sector) { if(!useParticles || !theMap || !sector) return; - /// @fixme Do the assume sector is from the CURRENT map. + /// @todo Do the assume sector is from the CURRENT map. gens = GameMap_Generators(theMap); if(!gens) return; diff --git a/doomsday/engine/portable/src/rend_sprite.c b/doomsday/engine/portable/src/rend_sprite.c index 11420fc4f6..3fbebeeb75 100644 --- a/doomsday/engine/portable/src/rend_sprite.c +++ b/doomsday/engine/portable/src/rend_sprite.c @@ -614,7 +614,7 @@ void Rend_RenderMaskedWall(const rendmaskedwallparams_t* p) // The dynamic light. glActiveTexture(IS_MUL ? GL_TEXTURE0 : GL_TEXTURE1); - /// @fixme modTex may be the name of a "managed" texture. + /// @todo modTex may be the name of a "managed" texture. GL_BindTextureUnmanaged(renderTextures ? p->modTex : 0, GL_LINEAR); glTexEnvfv(GL_TEXTURE_ENV, GL_TEXTURE_ENV_COLOR, p->modColor); diff --git a/doomsday/engine/portable/src/s_sfx.c b/doomsday/engine/portable/src/s_sfx.c index 09bbd4e1c0..d9853ae889 100644 --- a/doomsday/engine/portable/src/s_sfx.c +++ b/doomsday/engine/portable/src/s_sfx.c @@ -386,7 +386,7 @@ void Sfx_GetListenerXYZ(float* origin) { if(!listener) return; - /// @fixme Make it exactly eye-level! (viewheight). + /// @todo Make it exactly eye-level! (viewheight). origin[VX] = listener->origin[VX]; origin[VY] = listener->origin[VY]; origin[VZ] = listener->origin[VZ] + listener->height - 5; diff --git a/doomsday/engine/portable/src/surface.c b/doomsday/engine/portable/src/surface.c index 917c1cd76a..379c63887e 100644 --- a/doomsday/engine/portable/src/surface.c +++ b/doomsday/engine/portable/src/surface.c @@ -65,7 +65,7 @@ boolean Surface_SetMaterial(Surface* suf, material_t* mat) if(!ddMapSetup) { - GameMap* map = theMap; /// @fixme Do not assume surface is from the CURRENT map. + GameMap* map = theMap; /// @todo Do not assume surface is from the CURRENT map. // If this plane's surface is in the decorated list, remove it. R_SurfaceListRemove(GameMap_DecoratedSurfaces(map), suf); @@ -107,7 +107,7 @@ boolean Surface_SetMaterialOriginX(Surface* suf, float x) suf->inFlags |= SUIF_UPDATE_DECORATIONS; if(!ddMapSetup) { - /// @fixme Do not assume surface is from the CURRENT map. + /// @todo Do not assume surface is from the CURRENT map. R_SurfaceListAdd(GameMap_ScrollingSurfaces(theMap), suf); } } @@ -126,7 +126,7 @@ boolean Surface_SetMaterialOriginY(Surface* suf, float y) suf->inFlags |= SUIF_UPDATE_DECORATIONS; if(!ddMapSetup) { - /// @fixme Do not assume surface is from the CURRENT map. + /// @todo Do not assume surface is from the CURRENT map. R_SurfaceListAdd(GameMap_ScrollingSurfaces(theMap), suf); } } @@ -146,7 +146,7 @@ boolean Surface_SetMaterialOrigin(Surface* suf, float x, float y) suf->inFlags |= SUIF_UPDATE_DECORATIONS; if(!ddMapSetup) { - /// @fixme Do not assume surface is from the CURRENT map. + /// @todo Do not assume surface is from the CURRENT map. R_SurfaceListAdd(GameMap_ScrollingSurfaces(theMap), suf); } } diff --git a/doomsday/engine/portable/src/sv_pool.c b/doomsday/engine/portable/src/sv_pool.c index 19e1db528d..0da010ee05 100644 --- a/doomsday/engine/portable/src/sv_pool.c +++ b/doomsday/engine/portable/src/sv_pool.c @@ -1494,7 +1494,7 @@ coord_t Sv_MobjDistance(const mobj_t* mo, const ownerinfo_t* info, boolean isRea { coord_t z; - /// @fixme Do not assume mobj is from the CURRENT map. + /// @todo Do not assume mobj is from the CURRENT map. if(isReal && !GameMap_IsUsedMobjID(theMap, mo->thinker.id)) { // This mobj does not exist any more! @@ -2058,7 +2058,7 @@ void Sv_NewNullDeltas(cregister_t* reg, boolean doUpdate, pool_t** targets) // This reg_mobj_t might be removed. next = obj->next; - /// @fixme Do not assume mobj is from the CURRENT map. + /// @todo Do not assume mobj is from the CURRENT map. if(!GameMap_IsUsedMobjID(theMap, obj->mo.thinker.id)) { // This object no longer exists! @@ -2710,7 +2710,7 @@ boolean Sv_RateDelta(void* deltaPtr, ownerinfo_t* info) // Deltas become more important with age (milliseconds). score *= 1 + age / (ageScoreDouble * 1000.0f); - /// @fixme Consider viewpoint speed and angle. + /// @todo Consider viewpoint speed and angle. // Priority bonuses based on the contents of the delta. if(delta->type == DT_MOBJ) diff --git a/doomsday/engine/portable/src/textures.c b/doomsday/engine/portable/src/textures.c index d4b8abf209..20829ddced 100644 --- a/doomsday/engine/portable/src/textures.c +++ b/doomsday/engine/portable/src/textures.c @@ -164,7 +164,7 @@ static Uri* composeUriForDirectoryNode(const PathDirectoryNode* node) return uri; } -/// \assume textureIdMap has been initialized and is large enough! +/// @pre textureIdMap has been initialized and is large enough! static void unlinkDirectoryNodeFromBindIdMap(const PathDirectoryNode* node) { textureid_t id = findBindIdForDirectoryNode(node); @@ -172,7 +172,7 @@ static void unlinkDirectoryNodeFromBindIdMap(const PathDirectoryNode* node) textureIdMap[id - 1/*1-based index*/] = NULL; } -/// \assume uniqueIdMap has been initialized and is large enough! +/// @pre uniqueIdMap has been initialized and is large enough! static int linkRecordInUniqueIdMap(PathDirectoryNode* node, void* paramaters) { const texturerecord_t* record = (texturerecord_t*)PathDirectoryNode_UserData(node); @@ -183,7 +183,7 @@ static int linkRecordInUniqueIdMap(PathDirectoryNode* node, void* paramaters) return 0; // Continue iteration. } -/// \assume uniqueIdMap is large enough if initialized! +/// @pre uniqueIdMap is large enough if initialized! static int unlinkRecordInUniqueIdMap(PathDirectoryNode* node, void* paramaters) { const texturerecord_t* record = (texturerecord_t*)PathDirectoryNode_UserData(node); @@ -273,7 +273,7 @@ static PathDirectoryNode* findDirectoryNodeForPath(PathDirectory* texDirectory, return PathDirectory_Find(texDirectory, PCF_NO_BRANCH|PCF_MATCH_FULL, path, TEXTURES_PATH_DELIMITER); } -/// \assume @a uri has already been validated and is well-formed. +/// @pre @a uri has already been validated and is well-formed. static PathDirectoryNode* findDirectoryNodeForUri(const Uri* uri) { texturenamespaceid_t namespaceId; diff --git a/doomsday/engine/portable/src/ui2_main.c b/doomsday/engine/portable/src/ui2_main.c index 57af4c014e..f579d88bfa 100644 --- a/doomsday/engine/portable/src/ui2_main.c +++ b/doomsday/engine/portable/src/ui2_main.c @@ -195,7 +195,7 @@ static fi_object_t* objectsAdd(fi_object_collection_t* c, fi_object_t* obj) } /** - * \assume There is at most one reference to the object in this collection. + * @pre There is at most one reference to the object in this collection. */ static fi_object_t* objectsRemove(fi_object_collection_t* c, fi_object_t* obj) { @@ -1095,7 +1095,7 @@ static void drawPicFrame(fidata_pic_t* p, uint frame, const float _origin[3], } // If we've not chosen a texture by now set some defaults. - /// @fixme This is some seriously funky logic... refactor or remove. + /// @todo This is some seriously funky logic... refactor or remove. if(!textureEnabled) { V3f_Copy(dimensions, scale); diff --git a/doomsday/engine/win32/include/directinput.h b/doomsday/engine/win32/include/directinput.h index 88bdacd547..dba5d47602 100644 --- a/doomsday/engine/win32/include/directinput.h +++ b/doomsday/engine/win32/include/directinput.h @@ -20,8 +20,8 @@ extern "C" { * the version 8 interface (if available on the host system) and if unsuccessful, * then the older version 3 interface. * - * @important The caller must ensure that COM has been initialized else this - * will fail and false will be returned. + * @note The caller must ensure that COM has been initialized else this will + * fail and false will be returned. * * @return @c true if an interface was initialized successfully. */ diff --git a/doomsday/plugins/common/include/p_iterlist.h b/doomsday/plugins/common/include/p_iterlist.h index 4080821a4e..57120bb114 100644 --- a/doomsday/plugins/common/include/p_iterlist.h +++ b/doomsday/plugins/common/include/p_iterlist.h @@ -35,7 +35,7 @@ typedef enum { * IterList. A LIFO stack of pointers with facilities for bidirectional * iteration through the use of an integral iterator (thus scopeless). * - * \important Not thread safe! + * @warning Not thread safe! */ typedef struct iterlist_s { /// Direction of traversal. diff --git a/doomsday/plugins/common/src/d_netcl.c b/doomsday/plugins/common/src/d_netcl.c index 2aa721c422..4c2b96597b 100644 --- a/doomsday/plugins/common/src/d_netcl.c +++ b/doomsday/plugins/common/src/d_netcl.c @@ -140,7 +140,7 @@ void NetCl_UpdateGameState(Reader* msg) } // Set gravity. - /// @fixme This is a map-property, not a global property. + /// @todo This is a map-property, not a global property. DD_SetVariable(DD_GRAVITY, &gsGravity); // Camera init included? @@ -675,7 +675,7 @@ void NetCl_Intermission(Reader* msg) SN_StopAllSequences(); #endif - // @fixme jHeretic does not transmit the intermission info! + // @todo jHeretic does not transmit the intermission info! #if __JDOOM__ || __JDOOM64__ wmInfo.maxKills = Reader_ReadUInt16(msg); wmInfo.maxItems = Reader_ReadUInt16(msg); diff --git a/doomsday/plugins/common/src/d_netsv.c b/doomsday/plugins/common/src/d_netsv.c index 9ea5279b52..89181a47ad 100644 --- a/doomsday/plugins/common/src/d_netsv.c +++ b/doomsday/plugins/common/src/d_netsv.c @@ -650,7 +650,7 @@ void NetSv_NewPlayerEnters(int plrNum) P_SpawnPlayer(plrNum, pClass, 0, 0, 0, 0, MSF_Z_FLOOR, true, true); } - /// @fixme Spawn a telefog in front of the player. + /// @todo Spawn a telefog in front of the player. } // Get rid of anybody at the starting spot. diff --git a/doomsday/plugins/common/src/g_game.c b/doomsday/plugins/common/src/g_game.c index 8ab8386499..da9b4d429f 100644 --- a/doomsday/plugins/common/src/g_game.c +++ b/doomsday/plugins/common/src/g_game.c @@ -2243,7 +2243,7 @@ void G_DoMapCompleted(void) Con_Busy(BUSYF_TRANSITION, NULL, prepareIntermission, NULL); #if __JHERETIC__ - // @fixme is this necessary at this time? + // @todo is this necessary at this time? NetSv_SendGameState(0, DDSP_ALL_PLAYERS); #endif @@ -3333,7 +3333,7 @@ void G_DoScreenShot(void) static void openLoadMenu(void) { Hu_MenuCommand(MCMD_OPEN); - /// @fixme This should be called automatically when opening the page + /// @todo This should be called automatically when opening the page /// thus making this function redundant. Hu_MenuUpdateGameSaveWidgets(); Hu_MenuSetActivePage(Hu_MenuFindPageByName("LoadGame")); @@ -3342,7 +3342,7 @@ static void openLoadMenu(void) static void openSaveMenu(void) { Hu_MenuCommand(MCMD_OPEN); - /// @fixme This should be called automatically when opening the page + /// @todo This should be called automatically when opening the page /// thus making this function redundant. Hu_MenuUpdateGameSaveWidgets(); Hu_MenuSetActivePage(Hu_MenuFindPageByName("SaveGame")); diff --git a/doomsday/plugins/common/src/hu_lib.c b/doomsday/plugins/common/src/hu_lib.c index c946f68d34..3ee6d557c0 100644 --- a/doomsday/plugins/common/src/hu_lib.c +++ b/doomsday/plugins/common/src/hu_lib.c @@ -1173,7 +1173,7 @@ static mn_object_t* MNPage_ObjectByIndex(mn_page_t* page, int idx) return page->objects + idx; } -/// @assume @a ob is a child of @a page. +/// @pre @a ob is a child of @a page. static void MNPage_GiveChildFocus(mn_page_t* page, mn_object_t* ob, boolean allowRefocus) { assert(page && ob); @@ -1580,7 +1580,7 @@ int MNObject_ExecAction(mn_object_t* ob, mn_actionid_t id, void* paramaters) #if _DEBUG Con_Error("MNObject::ExecAction: Attempt to execute non-existent action #%i on object %p.", (int) id, ob); #endif - /// @fixme Need an error handling mechanic. + /// @todo Need an error handling mechanic. return -1; // NOP } @@ -1748,7 +1748,7 @@ void MNText_UpdateGeometry(mn_object_t* obj, mn_page_t* page) mndata_text_t* txt = (mndata_text_t*)obj->_typedata; Size2Raw size; assert(obj->_type == MN_TEXT); - /// @fixme What if patch replacement is disabled? + /// @todo What if patch replacement is disabled? if(txt->patch != 0) { patchinfo_t info; @@ -2047,7 +2047,7 @@ int MNEdit_Responder(mn_object_t* obj, event_t* ev) void MNEdit_UpdateGeometry(mn_object_t* obj, mn_page_t* page) { - // @fixme calculate visible dimensions properly. + // @todo calculate visible dimensions properly. assert(obj); Rect_SetWidthHeight(obj->_geometry, 170, 14); } @@ -2553,7 +2553,7 @@ void MNButton_UpdateGeometry(mn_object_t* obj, mn_page_t* page) const char* text = btn->text; Size2Raw size; - // @fixme What if patch replacement is disabled? + // @todo What if patch replacement is disabled? if(btn->patch) { if(!(btn->flags & MNBUTTON_NO_ALTTEXT)) @@ -3479,7 +3479,7 @@ void MNMobjPreview_Drawer(mn_object_t* ob, const Point2Raw* offset) void MNMobjPreview_UpdateGeometry(mn_object_t* ob, mn_page_t* page) { - // @fixme calculate visible dimensions properly! + // @todo calculate visible dimensions properly! assert(ob && ob->_type == MN_MOBJPREVIEW); Rect_SetWidthHeight(ob->_geometry, MNDATA_MOBJPREVIEW_WIDTH, MNDATA_MOBJPREVIEW_HEIGHT); } diff --git a/doomsday/plugins/common/src/hu_menu.c b/doomsday/plugins/common/src/hu_menu.c index 4d771fcc3f..87c2cc0f0a 100644 --- a/doomsday/plugins/common/src/hu_menu.c +++ b/doomsday/plugins/common/src/hu_menu.c @@ -2292,7 +2292,7 @@ static void initPageObjects(mn_page_t* page) if(btn->text && (PTR2INT(btn->text) > 0 && PTR2INT(btn->text) < NUMTEXT)) { btn->text = GET_TXT(PTR2INT(btn->text)); - /// @fixme Should not be done here. + /// @todo Should not be done here. MNObject_SetShortcut(ob, btn->text[0]); } break; } @@ -3150,7 +3150,7 @@ void Hu_MenuPlayerClassBackgroundTicker(mn_object_t* ob) assert(ob); // Determine our selection according to the current focus object. - /// @fixme Do not search for the focus object, flag the "random" + /// @todo Do not search for the focus object, flag the "random" /// state through a focus action. mop = MNPage_FocusObject(MNObject_Page(ob)); if(mop) @@ -3163,7 +3163,7 @@ void Hu_MenuPlayerClassBackgroundTicker(mn_object_t* ob) pClass = (menuTime / 5); } - /// @fixme Only change here if in the "random" state. + /// @todo Only change here if in the "random" state. pClass %= 3; // Number of user-selectable classes. MNRect_SetBackgroundPatch(ob, pPlayerClassBG[pClass]); @@ -3183,7 +3183,7 @@ void Hu_MenuPlayerClassPreviewTicker(mn_object_t* ob) assert(ob); // Determine our selection according to the current focus object. - /// @fixme Do not search for the focus object, flag the "random" + /// @todo Do not search for the focus object, flag the "random" /// state through a focus action. mop = MNPage_FocusObject(MNObject_Page(ob)); if(mop) diff --git a/doomsday/plugins/common/src/m_ctrl.c b/doomsday/plugins/common/src/m_ctrl.c index 8e4dc4d1ef..123a2b1fd4 100644 --- a/doomsday/plugins/common/src/m_ctrl.c +++ b/doomsday/plugins/common/src/m_ctrl.c @@ -641,7 +641,7 @@ int MNBindings_CommandResponder(mn_object_t* obj, menucommand_e cmd) void MNBindings_UpdateGeometry(mn_object_t* obj, mn_page_t* page) { - // @fixme calculate visible dimensions properly! + // @todo calculate visible dimensions properly! assert(obj); Rect_SetWidthHeight(obj->_geometry, 60, 10 * SMALL_SCALE); } diff --git a/doomsday/plugins/common/src/p_floor.c b/doomsday/plugins/common/src/p_floor.c index d18e5fb195..5ab8088e28 100644 --- a/doomsday/plugins/common/src/p_floor.c +++ b/doomsday/plugins/common/src/p_floor.c @@ -517,7 +517,7 @@ LineDef* P_FindLineInSectorSmallestBottomMaterial(Sector *sec, int *val) * DOOM.exe In addition, this algorithm was further broken in Heretic as the * test which compares floor heights was removed. * - * @important DO NOT USE THIS ANYWHERE ELSE! + * @warning DO NOT USE THIS ANYWHERE ELSE! */ typedef struct findfirstneighbouratfloorheightparams_s { @@ -991,7 +991,7 @@ static int findSectorNeighborsForStairBuild(void* ptr, void* context) * DOOM.exe In addition, this algorithm was further broken in Heretic as the * test which compares floor heights was removed. * - * @important DO NOT USE THIS ANYWHERE ELSE! + * @warning DO NOT USE THIS ANYWHERE ELSE! */ typedef struct spreadsectorparams_s { Sector* baseSec; diff --git a/doomsday/plugins/common/src/p_map.c b/doomsday/plugins/common/src/p_map.c index 3da4173fda..37ac61be67 100644 --- a/doomsday/plugins/common/src/p_map.c +++ b/doomsday/plugins/common/src/p_map.c @@ -1456,7 +1456,7 @@ static boolean P_TryMove2(mobj_t* thing, coord_t x, coord_t y, boolean dropoff) #endif #if __JDOOM64__ - /// @fixme D64 Mother demon fire attack. + /// @todo D64 Mother demon fire attack. if(!(thing->flags & MF_TELEPORT) /*&& thing->type != MT_SPAWNFIRE*/ && !isRemotePlayer && tmFloorZ - thing->origin[VZ] > 24) @@ -1650,7 +1650,7 @@ boolean P_TryMoveXYZ(mobj_t* thing, coord_t x, coord_t y, coord_t z) } /** - * @fixme This routine has gotten way too big, split if(in->isaline) + * @todo This routine has gotten way too big, split if(in->isaline) * to a seperate routine? */ int PTR_ShootTraverse(const intercept_t* in, void* parameters) @@ -2968,7 +2968,7 @@ mobj_t* P_CheckOnMobj(mobj_t* thing) return NULL; } - /// @fixme Do this properly! Consolidate with how jDoom/jHeretic do on-mobj checks? + /// @todo Do this properly! Consolidate with how jDoom/jHeretic do on-mobj checks? tmThing = thing; oldMo = *thing; // Save the old mobj before the fake z movement. diff --git a/doomsday/plugins/common/src/p_saveg.c b/doomsday/plugins/common/src/p_saveg.c index c840a2f20a..fa99f3b112 100644 --- a/doomsday/plugins/common/src/p_saveg.c +++ b/doomsday/plugins/common/src/p_saveg.c @@ -2450,7 +2450,7 @@ static int SV_ReadPolyObj(void) deltaY = FIX2FLT(SV_ReadLong()) - po->origin[VY]; P_PolyobjMoveXY(po, deltaX, deltaY); - /// @fixme What about speed? It isn't saved at all? + /// @todo What about speed? It isn't saved at all? return true; } @@ -5028,7 +5028,7 @@ void SV_LoadClient(uint gameId) /** * Create and populate the MaterialArchive. * - * @fixme Does this really need to be done at all as a client? + * @todo Does this really need to be done at all as a client? * When the client connects to the server it should send a copy * of the map upon joining, so why are we reading it here? */ diff --git a/doomsday/plugins/common/src/p_sound.c b/doomsday/plugins/common/src/p_sound.c index 97d752ff88..2c81aa956d 100644 --- a/doomsday/plugins/common/src/p_sound.c +++ b/doomsday/plugins/common/src/p_sound.c @@ -147,7 +147,7 @@ void S_ParseSndInfoLump(void) for(i = 0; i < Get(DD_NUMSOUNDS); ++i) { /// @kludge This uses a kludge to traverse the entire sound list. - /// @fixme Implement a mechanism for walking the Def databases. + /// @todo Implement a mechanism for walking the Def databases. Def_Get(DD_DEF_SOUND_LUMPNAME, (char*) &i, buf); if(!strcmp(buf, "")) Def_Set(DD_DEF_SOUND, i, DD_LUMP, "default"); diff --git a/doomsday/plugins/common/src/p_start.c b/doomsday/plugins/common/src/p_start.c index a42f3a19b1..93f569fe94 100644 --- a/doomsday/plugins/common/src/p_start.c +++ b/doomsday/plugins/common/src/p_start.c @@ -480,7 +480,7 @@ void P_SpawnPlayer(int plrNum, playerclass_t pClass, coord_t x, coord_t y, coord if(p->playerState == PST_REBORN) G_PlayerReborn(plrNum); - /// @fixme Should this not occur before the reborn? + /// @todo Should this not occur before the reborn? p->class_ = pClass; // On clients, mark the remote players. diff --git a/doomsday/plugins/common/src/p_xgsec.c b/doomsday/plugins/common/src/p_xgsec.c index 3e57582a00..c48d2a4c15 100644 --- a/doomsday/plugins/common/src/p_xgsec.c +++ b/doomsday/plugins/common/src/p_xgsec.c @@ -205,12 +205,11 @@ void XF_Init(Sector *sec, function_t *fn, char *func, int min, int max, if(func[0] == '+') { /** - * \important - * The original value ranges must be maintained due to the cross linking + * @note The original value ranges must be maintained due to the cross linking * between sector function types i.e: - * RGB = 0 > 254 - * light = 0 > 254 - * planeheight = -32768 > 32768 + * - RGB = 0 > 254 + * - light = 0 > 254 + * - planeheight = -32768 > 32768 */ switch(func[1]) { diff --git a/doomsday/plugins/jdoom/include/st_stuff.h b/doomsday/plugins/jdoom/include/st_stuff.h index 5ec1c5b634..d454fecdff 100644 --- a/doomsday/plugins/jdoom/include/st_stuff.h +++ b/doomsday/plugins/jdoom/include/st_stuff.h @@ -108,7 +108,7 @@ float ST_AutomapOpacity(int player); /** * Does the player's automap obscure this region completely? - * \assume: Window dimensions use the fixed coordinate space {x} 0 - 320, {y} 0 - 200. + * @pre Window dimensions use the fixed coordinate space {x} 0 - 320, {y} 0 - 200. * * @param player Local player number whose automap to check. * @param region Window region. diff --git a/doomsday/plugins/jdoom/src/p_mobj.c b/doomsday/plugins/jdoom/src/p_mobj.c index 1150da5f1d..677a4e200f 100644 --- a/doomsday/plugins/jdoom/src/p_mobj.c +++ b/doomsday/plugins/jdoom/src/p_mobj.c @@ -615,7 +615,7 @@ void P_MobjThinker(mobj_t* mo) { P_MobjMoveXY(mo); - /// @fixme decent NOP/NULL/Nil function pointer please. + /// @todo decent NOP/NULL/Nil function pointer please. if(mo->thinker.function == NOPFUNC) return; // Mobj was removed. } diff --git a/doomsday/plugins/jdoom64/include/st_stuff.h b/doomsday/plugins/jdoom64/include/st_stuff.h index fdfbf1a905..02d997f231 100644 --- a/doomsday/plugins/jdoom64/include/st_stuff.h +++ b/doomsday/plugins/jdoom64/include/st_stuff.h @@ -116,7 +116,7 @@ float ST_AutomapOpacity(int player); /** * Does the player's automap obscure this region completely? - * \assume: Window dimensions use the fixed coordinate space {x} 0 - 320, {y} 0 - 200. + * @pre Window dimensions use the fixed coordinate space {x} 0 - 320, {y} 0 - 200. * * @param player Local player number whose automap to check. * @param region Window region. diff --git a/doomsday/plugins/jheretic/include/st_stuff.h b/doomsday/plugins/jheretic/include/st_stuff.h index fac45c2391..d579eae2cb 100644 --- a/doomsday/plugins/jheretic/include/st_stuff.h +++ b/doomsday/plugins/jheretic/include/st_stuff.h @@ -107,7 +107,7 @@ float ST_AutomapOpacity(int player); /** * Does the player's automap obscure this region completely? - * \assume: Window dimensions use the fixed coordinate space {x} 0 - 320, {y} 0 - 200. + * @pre Window dimensions use the fixed coordinate space {x} 0 - 320, {y} 0 - 200. * * @param player Local player number whose automap to check. * @param region Window region. diff --git a/doomsday/plugins/jhexen/include/st_stuff.h b/doomsday/plugins/jhexen/include/st_stuff.h index 7f11e65456..392c2e83ab 100644 --- a/doomsday/plugins/jhexen/include/st_stuff.h +++ b/doomsday/plugins/jhexen/include/st_stuff.h @@ -106,7 +106,7 @@ float ST_AutomapOpacity(int player); /** * Does the player's automap obscure this region completely? - * \assume: Window dimensions use the fixed coordinate space {x} 0 - 320, {y} 0 - 200. + * @pre Window dimensions use the fixed coordinate space {x} 0 - 320, {y} 0 - 200. * * @param player Local player number whose automap to check. * @param region Window region. diff --git a/doomsday/plugins/jhexen/src/a_action.c b/doomsday/plugins/jhexen/src/a_action.c index 59a6ae853c..a5af7b7589 100644 --- a/doomsday/plugins/jhexen/src/a_action.c +++ b/doomsday/plugins/jhexen/src/a_action.c @@ -227,7 +227,7 @@ void C_DECL A_LeafSpawn(mobj_t* actor) pos[VY] += FIX2FLT((P_Random() - P_Random()) << 14); pos[VZ] += FIX2FLT(P_Random() << 14); - /// @fixme We should not be using the original indices to determine + /// @todo We should not be using the original indices to determine /// the mobjtype. Use a local table instead. if((mo = P_SpawnMobj(MT_LEAF1 + (P_Random() & 1), pos, actor->angle, 0))) diff --git a/doomsday/plugins/jhexen/src/p_enemy.c b/doomsday/plugins/jhexen/src/p_enemy.c index 82f4b50e51..ba3fba5b5b 100644 --- a/doomsday/plugins/jhexen/src/p_enemy.c +++ b/doomsday/plugins/jhexen/src/p_enemy.c @@ -753,7 +753,7 @@ boolean P_UpdateMorphedMonster(mobj_t* actor, int tics) } memcpy(pos, actor->origin, sizeof(pos)); - /// @fixme Do this properly! + /// @todo Do this properly! oldMonster = *actor; // Save pig vars. P_MobjRemoveFromTIDList(actor); @@ -3155,7 +3155,7 @@ void C_DECL A_IceGuyLook(mobj_t* mo) an = angle >> ANGLETOFINESHIFT; /** - * @fixme We should not be selecting mobj types by their original + * @todo We should not be selecting mobj types by their original * indices! Instead, use a fixed table here. */ P_SpawnMobjXYZ(MT_ICEGUY_WISP1 + (P_Random() & 1), @@ -3180,7 +3180,7 @@ void C_DECL A_IceGuyChase(mobj_t* actor) an = angle >> ANGLETOFINESHIFT; /** - * @fixme We should not be selecting mobj types by their original + * @todo We should not be selecting mobj types by their original * indices! Instead, use a fixed table here. */ if((mo = P_SpawnMobjXYZ(MT_ICEGUY_WISP1 + (P_Random() & 1), diff --git a/doomsday/plugins/jhexen/src/p_inter.c b/doomsday/plugins/jhexen/src/p_inter.c index b0637e876f..81f66702df 100644 --- a/doomsday/plugins/jhexen/src/p_inter.c +++ b/doomsday/plugins/jhexen/src/p_inter.c @@ -1713,7 +1713,7 @@ boolean P_MorphMonster(mobj_t* actor) break; } - /// @fixme Do this properly! + /// @todo Do this properly! oldMonster = *actor; pos[VX] = actor->origin[VX]; diff --git a/doomsday/plugins/openal/src/driver_openal.cpp b/doomsday/plugins/openal/src/driver_openal.cpp index 7807ac7a5c..31dc0836f0 100644 --- a/doomsday/plugins/openal/src/driver_openal.cpp +++ b/doomsday/plugins/openal/src/driver_openal.cpp @@ -269,7 +269,7 @@ void DS_SFX_Load(sfxbuffer_t* buf, struct sfxsample_s* sample) if(DSOPENAL_ERRCHECK(alGetError())) { - /// @fixme What to do? + /// @todo What to do? } buf->sample = sample; }