From 47c3b7afb46bdd85d158126b03b0de96fc7be617 Mon Sep 17 00:00:00 2001 From: skyjake Date: Wed, 2 May 2012 07:19:36 +0300 Subject: [PATCH] Documentation: Fixed a bunch of Doxygen warnings --- doomsday/engine/api/dd_fontrenderer.h | 3 +-- doomsday/engine/api/dd_string.h | 4 ++-- doomsday/engine/api/reader.h | 2 +- doomsday/engine/api/stringpool.h | 4 ++-- doomsday/engine/api/uri.h | 20 +++++++++++-------- doomsday/engine/api/writer.h | 2 +- .../portable/include/abstractresource.h | 2 +- .../engine/portable/include/concurrency.h | 4 ++++ doomsday/engine/portable/include/def_data.h | 2 +- doomsday/engine/portable/include/lumpfile.h | 2 +- .../engine/portable/include/masterserver.h | 2 +- doomsday/engine/portable/include/p_particle.h | 2 +- doomsday/engine/portable/src/bspleaf.cpp | 2 +- doomsday/engine/portable/src/con_busy.c | 2 +- doomsday/engine/portable/src/con_main.c | 2 +- doomsday/engine/portable/src/def_data.c | 2 +- doomsday/engine/portable/src/def_main.c | 2 +- doomsday/engine/portable/src/dfile.c | 2 +- doomsday/engine/portable/src/edit_bsp.cpp | 2 +- doomsday/engine/portable/src/edit_map.c | 2 +- doomsday/engine/portable/src/fs_main.c | 2 +- doomsday/engine/portable/src/fs_util.c | 4 ++-- doomsday/engine/portable/src/game.c | 2 +- doomsday/engine/portable/src/gl_main.c | 4 ++-- doomsday/engine/portable/src/gl_pcx.c | 2 +- doomsday/engine/portable/src/gl_png.c | 4 ++-- doomsday/engine/portable/src/gl_tex.c | 2 +- doomsday/engine/portable/src/gl_texmanager.c | 8 ++++---- doomsday/engine/portable/src/gl_tga.c | 2 +- doomsday/engine/portable/src/material.c | 2 +- doomsday/engine/portable/src/materials.c | 2 +- doomsday/engine/portable/src/p_data.c | 2 +- doomsday/engine/portable/src/p_particle.c | 2 +- doomsday/engine/portable/src/r_data.c | 6 +++--- doomsday/engine/portable/src/r_model.c | 4 ++-- doomsday/engine/portable/src/r_world.c | 4 ++-- doomsday/engine/portable/src/rend_font.c | 2 +- doomsday/engine/portable/src/rend_list.c | 4 ++-- doomsday/engine/portable/src/rend_model.c | 2 +- doomsday/engine/portable/src/rend_sprite.c | 4 ++-- doomsday/engine/portable/src/s_cache.c | 2 +- doomsday/engine/portable/src/s_sfx.c | 4 ++-- doomsday/engine/portable/src/sv_pool.c | 2 +- doomsday/engine/portable/src/sys_network.c | 2 +- doomsday/engine/portable/src/texture.c | 8 ++++---- doomsday/engine/portable/src/textures.c | 4 ++-- doomsday/engine/portable/src/ui2_main.c | 6 +++--- doomsday/engine/portable/src/zipfile.c | 2 +- doomsday/engine/unix/src/sys_path.c | 4 ++-- doomsday/engine/win32/src/dd_winit.c | 2 +- doomsday/libdeng2/include/de/c_wrapper.h | 13 +++++++----- doomsday/libdeng2/include/de/data/info.h | 3 ++- .../libdeng2/include/de/legacy/legacycore.h | 4 ++-- doomsday/libdeng2/include/de/net/socket.h | 2 +- doomsday/plugins/common/src/g_controls.c | 2 +- doomsday/plugins/common/src/hu_automap.c | 2 +- doomsday/plugins/common/src/hu_log.c | 4 ++-- doomsday/plugins/common/src/p_map.c | 2 +- doomsday/plugins/common/src/p_mapsetup.c | 2 +- doomsday/plugins/common/src/p_player.c | 8 ++++---- doomsday/plugins/common/src/p_saveg.c | 6 +++--- doomsday/plugins/common/src/p_start.c | 4 ++-- doomsday/plugins/common/src/p_user.c | 4 ++-- doomsday/plugins/common/src/p_xgline.c | 4 ++-- doomsday/plugins/jdoom/include/d_englsh.h | 2 +- doomsday/plugins/jdoom/src/d_main.c | 2 +- doomsday/plugins/jdoom/src/p_mobj.c | 2 +- doomsday/plugins/jdoom64/include/d_englsh.h | 2 +- doomsday/plugins/jdoom64/src/p_mobj.c | 2 +- doomsday/plugins/jdoom64/src/p_telept.c | 2 +- doomsday/plugins/jheretic/src/h_main.c | 2 +- doomsday/plugins/jheretic/src/p_mobj.c | 2 +- doomsday/plugins/jheretic/src/st_stuff.c | 12 +++++------ doomsday/plugins/jhexen/src/p_inter.c | 4 ++-- doomsday/plugins/jhexen/src/st_stuff.c | 2 +- 75 files changed, 135 insertions(+), 124 deletions(-) diff --git a/doomsday/engine/api/dd_fontrenderer.h b/doomsday/engine/api/dd_fontrenderer.h index 2dbd9317ab..39827dbe5b 100644 --- a/doomsday/engine/api/dd_fontrenderer.h +++ b/doomsday/engine/api/dd_fontrenderer.h @@ -188,8 +188,7 @@ int FR_TextHeight(const char* text); * Draw a character. * * @param ch Character to be drawn. - * @param x X origin/offset at which to begin drawing. - * @param y Y origin/offset at which to begin drawing. + * @param origin Origin/offset at which to begin drawing. * @param alignFlags @ref alignmentFlags * @param flags @ref drawTextFlags */ diff --git a/doomsday/engine/api/dd_string.h b/doomsday/engine/api/dd_string.h index a303e38cae..e6733fd65f 100644 --- a/doomsday/engine/api/dd_string.h +++ b/doomsday/engine/api/dd_string.h @@ -253,7 +253,7 @@ const char* Str_GetLine(ddstring_t* ds, const char* src); * @param dest Destination string. * @param src Source string. * @param delimiter Delimiter character. - * @param flags @ref copyDelimiterFlags + * @param cdflags @ref copyDelimiterFlags * * @return Pointer to the character within @a src where copy stopped * else @c NULL if the end was reached. @@ -311,7 +311,7 @@ ddstring_t* Str_PercentEncode(ddstring_t* str); * @a excludeChars). @c 0 terminated. * @return Same as @a str. */ -ddstring_t* Str_PercentEncode2(ddstring_t* str, const char* excludeChars, const char* includeCars); +ddstring_t* Str_PercentEncode2(ddstring_t* str, const char* excludeChars, const char* includeChars); /** * Decode the percent-encoded string. Will match codes for the unicode diff --git a/doomsday/engine/api/reader.h b/doomsday/engine/api/reader.h index afe7fee2b9..a2880feff3 100644 --- a/doomsday/engine/api/reader.h +++ b/doomsday/engine/api/reader.h @@ -1,5 +1,5 @@ /** - * @file reader.h + * @file api/reader.h * Deserializer for reading values and data from a byte array. * * @ingroup base diff --git a/doomsday/engine/api/stringpool.h b/doomsday/engine/api/stringpool.h index ba3d0a245c..5b93ecf797 100644 --- a/doomsday/engine/api/stringpool.h +++ b/doomsday/engine/api/stringpool.h @@ -218,9 +218,9 @@ boolean StringPool_RemoveById(StringPool* pool, StringPoolId id); * Iterate over all strings in the pool making a callback for each. Iteration * ends when all strings have been processed or a callback returns non-zero. * - * @param pool StringPool instance. + * @param pool StringPool instance. * @param callback Callback to make for each iteration. - * @param parameters User data to be passed to the callback. + * @param data User data to be passed to the callback. * * @return @c 0 iff iteration completed wholly. Otherwise the non-zero value returned * by @a callback. diff --git a/doomsday/engine/api/uri.h b/doomsday/engine/api/uri.h index 95d3b1e989..b9aae8d8dd 100644 --- a/doomsday/engine/api/uri.h +++ b/doomsday/engine/api/uri.h @@ -75,9 +75,9 @@ Uri* Uri_New(void); * Constructs a Uri instance from @a path. The uri should be destroyed with * Uri_Delete() once it is no longer needed. * - * @param path Path to be parsed. Assumed to be in percent-encoded representation. - * @param resourceClass If no scheme is defined in @a path and this is not @c RC_NULL, - * look for an appropriate default scheme for this class of resource. + * @param path Path to be parsed. Assumed to be in percent-encoded representation. + * @param defaultResourceClass If no scheme is defined in @a path and this is not @c RC_NULL, + * look for an appropriate default scheme for this class of resource. */ Uri* Uri_NewWithPath2(const char* path, resourceclass_t defaultResourceClass); Uri* Uri_NewWithPath(const char* path); @@ -151,12 +151,14 @@ const ddstring_t* Uri_Scheme(const Uri* uri); const ddstring_t* Uri_Path(const Uri* uri); /** - * @param path New scheme to be parsed. + * @param uri Uri instance. + * @param scheme New scheme to be parsed. * @return Same as @a uri, for caller convenience. */ Uri* Uri_SetScheme(Uri* uri, const char* scheme); /** + * @param uri Uri instance. * @param path New path to be parsed. * @return Same as @a uri, for caller convenience. */ @@ -165,10 +167,11 @@ Uri* Uri_SetPath(Uri* uri, const char* path); /** * Update uri by parsing new values from the specified arguments. * - * @param uri Uri instance. - * @param path Path to be parsed. Assumed to be in percent-encoded representation. - * @param resourceClass If no scheme is defined in @a path and this is not @c RC_NULL, - * look for an appropriate default scheme for this class of resource. + * @param uri Uri instance. + * @param path Path to be parsed. Assumed to be in percent-encoded representation. + * @param defaultResourceClass If no scheme is defined in @a path and this is not + * @c RC_NULL, look for an appropriate default scheme for this class + * of resource. * * @return Same as @a uri, for caller convenience. */ @@ -215,6 +218,7 @@ boolean Uri_Equality(const Uri* uri, const Uri* other); * @note Scheme should only be omitted when it can be unambiguously deduced from context. * * @param uri Uri instance. + * @param writer Writer instance. * @param omitComponents @ref uriComponentFlags */ void Uri_Write2(const Uri* uri, Writer* writer, int omitComponents); diff --git a/doomsday/engine/api/writer.h b/doomsday/engine/api/writer.h index d04b4fc11b..80acec8809 100644 --- a/doomsday/engine/api/writer.h +++ b/doomsday/engine/api/writer.h @@ -1,5 +1,5 @@ /** - * @file writer.h + * @file api/writer.h * Serializer for writing values and data into a byte array. * * @ingroup base diff --git a/doomsday/engine/portable/include/abstractresource.h b/doomsday/engine/portable/include/abstractresource.h index 8a02de7c28..d672919548 100644 --- a/doomsday/engine/portable/include/abstractresource.h +++ b/doomsday/engine/portable/include/abstractresource.h @@ -1,4 +1,4 @@ -/**\file resourceresourceord.h +/**\file abstractresource.h *\section License * License: GPL * Online License Link: http://www.gnu.org/licenses/gpl.html diff --git a/doomsday/engine/portable/include/concurrency.h b/doomsday/engine/portable/include/concurrency.h index 7c72821b65..732e196b68 100644 --- a/doomsday/engine/portable/include/concurrency.h +++ b/doomsday/engine/portable/include/concurrency.h @@ -36,6 +36,10 @@ typedef void* sem_t; #include +/** + * Thread that runs a user-specified callback function. Exceptions from the callback + * function are caught. + */ class CallbackThread : public QThread { Q_OBJECT diff --git a/doomsday/engine/portable/include/def_data.h b/doomsday/engine/portable/include/def_data.h index 02f2d81122..3239bff17e 100644 --- a/doomsday/engine/portable/include/def_data.h +++ b/doomsday/engine/portable/include/def_data.h @@ -25,7 +25,7 @@ /** * Engine Definition Files * - * \fixme Needs to be redesigned. + * @todo Needs to be redesigned. */ #ifndef LIBDENG_DEFINITION_FILE_H diff --git a/doomsday/engine/portable/include/lumpfile.h b/doomsday/engine/portable/include/lumpfile.h index 3cf1d83990..f847bae738 100644 --- a/doomsday/engine/portable/include/lumpfile.h +++ b/doomsday/engine/portable/include/lumpfile.h @@ -1,4 +1,4 @@ -/**\file lumpfile_h +/**\file lumpfile.h *\section License * License: GPL * Online License Link: http://www.gnu.org/licenses/gpl.html diff --git a/doomsday/engine/portable/include/masterserver.h b/doomsday/engine/portable/include/masterserver.h index 75313f0915..875c99cfe2 100644 --- a/doomsday/engine/portable/include/masterserver.h +++ b/doomsday/engine/portable/include/masterserver.h @@ -102,7 +102,7 @@ void N_MasterAnnounceServer(boolean isOpen); void N_MasterRequestList(void); /** - * Returns information about the server #N. + * Returns information about the server @em N. * * @return @c 0, if communication with the master is currently in progress. If * param info is @c NULL, will return the number of known servers ELSE, will diff --git a/doomsday/engine/portable/include/p_particle.h b/doomsday/engine/portable/include/p_particle.h index f3329bb31e..31a1c45e14 100644 --- a/doomsday/engine/portable/include/p_particle.h +++ b/doomsday/engine/portable/include/p_particle.h @@ -1,5 +1,5 @@ /** - * @file particle.h + * @file p_particle.h * Generator (particles) management. @ingroup map * * @authors Copyright © 2003-2012 Jaakko Keränen diff --git a/doomsday/engine/portable/src/bspleaf.cpp b/doomsday/engine/portable/src/bspleaf.cpp index 2c6acc48b5..a8c1f5fd3b 100644 --- a/doomsday/engine/portable/src/bspleaf.cpp +++ b/doomsday/engine/portable/src/bspleaf.cpp @@ -1,5 +1,5 @@ /** - * @file bspleaf.c + * @file bspleaf.cpp * BspLeaf implementation. @ingroup map * * @authors Copyright © 2003-2012 Jaakko Keränen diff --git a/doomsday/engine/portable/src/con_busy.c b/doomsday/engine/portable/src/con_busy.c index f58bb14ed6..fe46cb2a9f 100644 --- a/doomsday/engine/portable/src/con_busy.c +++ b/doomsday/engine/portable/src/con_busy.c @@ -670,7 +670,7 @@ lineIsNotNew:; /** * Draws a number of console output to the bottom of the screen. - * \fixme: Wow. I had some weird time hacking the smooth scrolling. Cleanup would be + * @todo: Wow. I had some weird time hacking the smooth scrolling. Cleanup would be * good some day. -jk */ void Con_BusyDrawConsoleOutput(void) diff --git a/doomsday/engine/portable/src/con_main.c b/doomsday/engine/portable/src/con_main.c index 25678e2927..f0b1f36d53 100644 --- a/doomsday/engine/portable/src/con_main.c +++ b/doomsday/engine/portable/src/con_main.c @@ -992,7 +992,7 @@ static int executeSubCmd(const char *subCmd, byte src, boolean isNetCmd) CVar_SetString(cvar, argptr); break; case CVT_URIPTR: { - /// \fixme Sanitize and validate against known schemas. + /// @todo Sanitize and validate against known schemas. Uri* uri = Uri_NewWithPath2(argptr, RC_NULL); CVar_SetUri(cvar, uri); Uri_Delete(uri); diff --git a/doomsday/engine/portable/src/def_data.c b/doomsday/engine/portable/src/def_data.c index 205e7a22c5..4c5d30bfee 100644 --- a/doomsday/engine/portable/src/def_data.c +++ b/doomsday/engine/portable/src/def_data.c @@ -25,7 +25,7 @@ /** * Doomsday Engine Definition Files * - * \fixme Needs to be redesigned. + * @todo Needs to be redesigned. */ #include diff --git a/doomsday/engine/portable/src/def_main.c b/doomsday/engine/portable/src/def_main.c index 7b7fa5504c..7ab341e5a1 100644 --- a/doomsday/engine/portable/src/def_main.c +++ b/doomsday/engine/portable/src/def_main.c @@ -1981,7 +1981,7 @@ StringArray* Def_ListStateIDs(void) /** * Prints a list of all the registered mobjs to the console. - * \fixme Does this belong here? + * @todo Does this belong here? */ D_CMD(ListMobjs) { diff --git a/doomsday/engine/portable/src/dfile.c b/doomsday/engine/portable/src/dfile.c index f604024e1e..ab11270b91 100644 --- a/doomsday/engine/portable/src/dfile.c +++ b/doomsday/engine/portable/src/dfile.c @@ -1,4 +1,4 @@ -/**\file filehandle.c +/**\file dfile.c *\section License * License: GPL * Online License Link: http://www.gnu.org/licenses/gpl.html diff --git a/doomsday/engine/portable/src/edit_bsp.cpp b/doomsday/engine/portable/src/edit_bsp.cpp index 1e4d8fdd70..8dcb343909 100644 --- a/doomsday/engine/portable/src/edit_bsp.cpp +++ b/doomsday/engine/portable/src/edit_bsp.cpp @@ -1,5 +1,5 @@ /** - * @file bsp_map.c + * @file bsp_map.cpp * BSP Builder. @ingroup map * * @authors Copyright © 2006-2012 Daniel Swanson diff --git a/doomsday/engine/portable/src/edit_map.c b/doomsday/engine/portable/src/edit_map.c index ab86c2ae96..8cc156b6c0 100644 --- a/doomsday/engine/portable/src/edit_map.c +++ b/doomsday/engine/portable/src/edit_map.c @@ -444,7 +444,7 @@ void MPE_PruneRedundantMapData(editmap_t* map, int flags) { #if 0 /** - * \fixme Pruning cannot be done as game map data object properties + * @todo Pruning cannot be done as game map data object properties * are currently indexed by their original indices as determined by the * position in the map data. The same problem occurs within ACS scripts * and XG line/sector references. diff --git a/doomsday/engine/portable/src/fs_main.c b/doomsday/engine/portable/src/fs_main.c index ab4673229f..c9e196bbe6 100644 --- a/doomsday/engine/portable/src/fs_main.c +++ b/doomsday/engine/portable/src/fs_main.c @@ -595,7 +595,7 @@ int F_Reset(void) #endif // Reset file IDs so previously seen files can be processed again. - /// \fixme this releases the ID of startup files too but given the + /// @todo this releases the ID of startup files too but given the /// only startup file is doomsday.pk3 which we never attempt to load /// again post engine startup, this isn't an immediate problem. F_ResetFileIds(); diff --git a/doomsday/engine/portable/src/fs_util.c b/doomsday/engine/portable/src/fs_util.c index a28da36740..94bad644c4 100644 --- a/doomsday/engine/portable/src/fs_util.c +++ b/doomsday/engine/portable/src/fs_util.c @@ -46,7 +46,7 @@ void F_FileDir(ddstring_t* dst, const ddstring_t* src) { - /// \fixme Potentially truncates @a src to FILENAME_T_MAXLEN + /// @todo Potentially truncates @a src to FILENAME_T_MAXLEN directory_t* dir = Dir_ConstructFromPathDir(Str_Text(src)); Str_Set(dst, Dir_Path(dir)); Dir_Delete(dir); @@ -568,7 +568,7 @@ const char* F_PrettyPath(const char* path) { #define NUM_BUFS 8 - static ddstring_t buffers[NUM_BUFS]; // \fixme: never free'd! + static ddstring_t buffers[NUM_BUFS]; // @todo: never free'd! static uint index = 0; ddstring_t* buf = NULL; int len; diff --git a/doomsday/engine/portable/src/game.c b/doomsday/engine/portable/src/game.c index af7817ec13..82d0b35da2 100644 --- a/doomsday/engine/portable/src/game.c +++ b/doomsday/engine/portable/src/game.c @@ -1,4 +1,4 @@ -/**\file gameinfo.c +/**\file game.c *\section License * License: GPL * Online License Link: http://www.gnu.org/licenses/gpl.html diff --git a/doomsday/engine/portable/src/gl_main.c b/doomsday/engine/portable/src/gl_main.c index e9af5cb817..8d40bbe08f 100644 --- a/doomsday/engine/portable/src/gl_main.c +++ b/doomsday/engine/portable/src/gl_main.c @@ -878,7 +878,7 @@ void GL_SetMaterialUI2(material_t* mat, int wrapS, int wrapT) const materialvariantspecification_t* spec; const materialsnapshot_t* ms; - if(!mat) return; // \fixme we need a "NULL material". + if(!mat) return; // @todo we need a "NULL material". spec = Materials_VariantSpecificationForContext(MC_UI, 0, 1, 0, 0, wrapS, wrapT, 0, 1, 0, false, false, false, false); @@ -896,7 +896,7 @@ void GL_SetPSprite(material_t* mat, int tClass, int tMap) const materialvariantspecification_t* spec; const materialsnapshot_t* ms; - if(!mat) return; // \fixme we need a "NULL material". + if(!mat) return; // @todo we need a "NULL material". spec = Materials_VariantSpecificationForContext(MC_PSPRITE, 0, 1, tClass, tMap, GL_CLAMP_TO_EDGE, GL_CLAMP_TO_EDGE, 0, 1, 0, false, true, true, false); diff --git a/doomsday/engine/portable/src/gl_pcx.c b/doomsday/engine/portable/src/gl_pcx.c index 52d2feaad8..783f48c0e1 100644 --- a/doomsday/engine/portable/src/gl_pcx.c +++ b/doomsday/engine/portable/src/gl_pcx.c @@ -48,7 +48,7 @@ typedef struct { } header_t; #pragma pack() -static char* lastErrorMsg = 0; /// \fixme potentially never free'd +static char* lastErrorMsg = 0; /// @todo potentially never free'd static void setLastError(const char* msg) { diff --git a/doomsday/engine/portable/src/gl_png.c b/doomsday/engine/portable/src/gl_png.c index 2a47d92db7..4c6915abbd 100644 --- a/doomsday/engine/portable/src/gl_png.c +++ b/doomsday/engine/portable/src/gl_png.c @@ -31,7 +31,7 @@ #include "de_graphics.h" #include "m_misc.h" -static char* lastErrorMsg = 0; /// \fixme potentially never free'd +static char* lastErrorMsg = 0; /// @todo potentially never free'd static void setLastError(const char* msg) { @@ -152,7 +152,7 @@ uint8_t* PNG_Load(DFile* file, int* width, int* height, int* pixelSize) *pixelSize = 4; // With alpha channel. // OK, let's copy it into Doomsday's buffer. - // \fixme Why not load directly into it? + // @todo Why not load directly into it? retbuf = M_Malloc(4 * png_get_image_width(png_ptr, png_info) * png_get_image_height(png_ptr, png_info)); rows = png_get_rows(png_ptr, png_info); diff --git a/doomsday/engine/portable/src/gl_tex.c b/doomsday/engine/portable/src/gl_tex.c index b0eaf8e75f..5f8d006c81 100644 --- a/doomsday/engine/portable/src/gl_tex.c +++ b/doomsday/engine/portable/src/gl_tex.c @@ -55,7 +55,7 @@ static uint8_t* GetScratchBuffer(size_t size) * pixel, or rather the number of bytes per pixel (3 or 4). The strides must * be byte-aligned anyway, though; not in pixels. * - * \fixme Probably could be optimized. + * @todo Probably could be optimized. */ static void scaleLine(const uint8_t* in, int inStride, uint8_t* out, int outStride, int outLen, int inLen, int comps) diff --git a/doomsday/engine/portable/src/gl_texmanager.c b/doomsday/engine/portable/src/gl_texmanager.c index facbcc8d6f..3bae4a22a6 100644 --- a/doomsday/engine/portable/src/gl_texmanager.c +++ b/doomsday/engine/portable/src/gl_texmanager.c @@ -1015,7 +1015,7 @@ static uploadcontentmethod_t prepareVariantFromImage(TextureVariant* tex, image_ * coordinates are calculated as width/CeilPow2(width), or 1 if larger * than the maximum texture size. * - * \fixme Image dimensions may not be the same as the final uploaded texture! + * @todo Image dimensions may not be the same as the final uploaded texture! */ if((flags & TXCF_UPLOAD_ARG_NOSTRETCH) && (!GL_state.features.texNonPowTwo || spec->mipmapped)) @@ -2276,7 +2276,7 @@ static void loadDoomPatch(uint8_t* buffer, int texwidth, int texheight, if(trans >= 0) { - /// \fixme Check bounds! + /// @todo Check bounds! palidx = *(translationTables + trans + palidx); } @@ -2333,7 +2333,7 @@ TexSource GL_LoadDetailTextureLump(image_t* image, DFile* file) GL_InitImage(image); /** - * \fixme Do not fatal error here if the not a known format! + * @todo Do not fatal error here if the not a known format! * Perform this check much earlier, when the definitions are * read and mark which are valid. */ @@ -2383,7 +2383,7 @@ TexSource GL_LoadFlatLump(image_t* image, DFile* file) GL_InitImage(image); - /// \fixme not all flats are 64x64! + /// @todo not all flats are 64x64! image->size.width = FLAT_WIDTH; image->size.height = FLAT_HEIGHT; image->pixelSize = 1; diff --git a/doomsday/engine/portable/src/gl_tga.c b/doomsday/engine/portable/src/gl_tga.c index f45b27488e..d877efe015 100644 --- a/doomsday/engine/portable/src/gl_tga.c +++ b/doomsday/engine/portable/src/gl_tga.c @@ -78,7 +78,7 @@ typedef struct { } tga_imagespec_t; #pragma pack() -static char* lastErrorMsg = 0; /// \fixme potentially never free'd +static char* lastErrorMsg = 0; /// @todo potentially never free'd #ifdef __BIG_ENDIAN__ static int16_t shortSwap(int16_t n) diff --git a/doomsday/engine/portable/src/material.c b/doomsday/engine/portable/src/material.c index 9e64ce9eea..2bc00e07dd 100644 --- a/doomsday/engine/portable/src/material.c +++ b/doomsday/engine/portable/src/material.c @@ -213,7 +213,7 @@ boolean Material_HasGlow(material_t* mat) if(novideo) return false; { - /// \fixme We should not need to prepare to determine this. + /// @todo We should not need to prepare to determine this. const materialvariantspecification_t* spec = Materials_VariantSpecificationForContext( MC_MAPSURFACE, 0, 0, 0, 0, GL_REPEAT, GL_REPEAT, -1, -1, -1, true, true, false, false); const materialsnapshot_t* ms = Materials_Prepare(mat, spec, true); diff --git a/doomsday/engine/portable/src/materials.c b/doomsday/engine/portable/src/materials.c index 2ac0d022e4..8acbf4d6c0 100644 --- a/doomsday/engine/portable/src/materials.c +++ b/doomsday/engine/portable/src/materials.c @@ -1718,7 +1718,7 @@ boolean Materials_HasDecorations(material_t* mat) if(novideo) return false; assert(mat); - /// \fixme We should not need to prepare to determine this. + /// @todo We should not need to prepare to determine this. /// Nor should we need to process the group each time. Cache this decision. if(Materials_DecorationDef(mat)) return true; if(Material_IsGroupAnimated(mat)) diff --git a/doomsday/engine/portable/src/p_data.c b/doomsday/engine/portable/src/p_data.c index 68c0dd410d..45c8b7e1d6 100644 --- a/doomsday/engine/portable/src/p_data.c +++ b/doomsday/engine/portable/src/p_data.c @@ -1,5 +1,5 @@ /** - * @file p_data.h + * @file p_data.c * Playsim Data Structures. @ingroup play * * @authors Copyright © 2003-2012 Jaakko Keränen diff --git a/doomsday/engine/portable/src/p_particle.c b/doomsday/engine/portable/src/p_particle.c index 6e3e57b4b8..0804aa3837 100644 --- a/doomsday/engine/portable/src/p_particle.c +++ b/doomsday/engine/portable/src/p_particle.c @@ -1,5 +1,5 @@ /** - * @file particle.c + * @file p_particle.c * Generator (particles) management. @ingroup map * * @authors Copyright © 2003-2012 Jaakko Keränen diff --git a/doomsday/engine/portable/src/r_data.c b/doomsday/engine/portable/src/r_data.c index c655640e95..ec53bcafaa 100644 --- a/doomsday/engine/portable/src/r_data.c +++ b/doomsday/engine/portable/src/r_data.c @@ -1177,7 +1177,7 @@ patchid_t R_DeclarePatch(const char* name) if(upscaleAndSharpenPatches) p->flags |= PF_UPSCALE_AND_SHARPEN; /** - * \fixme: Cannot be sure this is in Patch format until a load attempt + * @todo: Cannot be sure this is in Patch format until a load attempt * is made. We should not read this info here! */ fsObject = F_FindFileForLumpNum2(lumpNum, &lumpIdx); @@ -1423,7 +1423,7 @@ static patchname_t* loadPatchNames(lumpnum_t lumpNum, int* num) name = names; for(i = 0; i < numNames; ++i) { - /// \fixme Some filtering of invalid characters wouldn't go amiss... + /// @todo Some filtering of invalid characters wouldn't go amiss... strncpy(*name, (const char*) (lump + 4 + i * 8), 8); name++; } @@ -2330,7 +2330,7 @@ void R_InitSpriteTextures(void) stack = Stack_New(); numLumps = F_LumpCount(); - /// \fixme Order here does not respect id tech1 logic. + /// @todo Order here does not respect id tech1 logic. for(i = 0; i < numLumps; ++i) { const char* lumpName = F_LumpName((lumpnum_t)i); diff --git a/doomsday/engine/portable/src/r_model.c b/doomsday/engine/portable/src/r_model.c index f771f331d5..2225c07aeb 100644 --- a/doomsday/engine/portable/src/r_model.c +++ b/doomsday/engine/portable/src/r_model.c @@ -731,7 +731,7 @@ float R_CheckModelFor(mobj_t* mo, modeldef_t** modef, modeldef_t** nextmodef) if(max-- <= 0) stopScan = true; } - // \fixme What about max == -1? What should 'it' be then? + // @todo What about max == -1? What should 'it' be then? } if(!foundNext) @@ -1292,7 +1292,7 @@ if(closest) /** * Frees all memory allocated for models. - * \fixme Why only centralized memory deallocation? Bad design... + * @todo Why only centralized memory deallocation? Bad design... */ void R_ShutdownModels(void) { diff --git a/doomsday/engine/portable/src/r_world.c b/doomsday/engine/portable/src/r_world.c index a0e619366a..c0302cef45 100644 --- a/doomsday/engine/portable/src/r_world.c +++ b/doomsday/engine/portable/src/r_world.c @@ -1371,7 +1371,7 @@ void R_ClearSectorFlags(void) boolean R_IsGlowingPlane(const Plane* pln) { - /// \fixme We should not need to prepare to determine this. + /// @todo We should not need to prepare to determine this. material_t* mat = pln->surface.material; const materialvariantspecification_t* spec = Materials_VariantSpecificationForContext( MC_MAPSURFACE, 0, 0, 0, 0, GL_REPEAT, GL_REPEAT, -1, -1, -1, true, true, false, false); @@ -1387,7 +1387,7 @@ float R_GlowStrength(const Plane* pln) { if(Material_IsDrawable(mat) && !Surface_IsSkyMasked(&pln->surface)) { - /// \fixme We should not need to prepare to determine this. + /// @todo We should not need to prepare to determine this. const materialvariantspecification_t* spec = Materials_VariantSpecificationForContext( MC_MAPSURFACE, 0, 0, 0, 0, GL_REPEAT, GL_REPEAT, -1, -1, -1, true, true, false, false); const materialsnapshot_t* ms = Materials_Prepare(mat, spec, true); diff --git a/doomsday/engine/portable/src/rend_font.c b/doomsday/engine/portable/src/rend_font.c index db57b98e5c..384d4be7bf 100644 --- a/doomsday/engine/portable/src/rend_font.c +++ b/doomsday/engine/portable/src/rend_font.c @@ -1,4 +1,4 @@ -/**\file gl_font.c +/**\file rend_font.c *\section License * License: GPL * Online License Link: http://www.gnu.org/licenses/gpl.html diff --git a/doomsday/engine/portable/src/rend_list.c b/doomsday/engine/portable/src/rend_list.c index cc90e7b361..c26ca684bd 100644 --- a/doomsday/engine/portable/src/rend_list.c +++ b/doomsday/engine/portable/src/rend_list.c @@ -67,7 +67,7 @@ END_PROF_TIMERS() // Number of extra bytes to keep allocated in the end of each rendering list. #define LIST_DATA_PADDING 16 -// \fixme Rlist allocation could be dynamic. +// @todo Rlist allocation could be dynamic. #define MAX_RLISTS 1024 #define MTEX_DETAILS_ENABLED (r_detail && useMultiTexDetails && \ @@ -612,7 +612,7 @@ void RL_ClearLists(void) // Clear the vertex array. clearVertices(); - // \fixme Does this belong here? + // @todo Does this belong here? rDrawSky = false; } diff --git a/doomsday/engine/portable/src/rend_model.c b/doomsday/engine/portable/src/rend_model.c index 316e0883c9..c52f876e58 100644 --- a/doomsday/engine/portable/src/rend_model.c +++ b/doomsday/engine/portable/src/rend_model.c @@ -48,7 +48,7 @@ #define DOTPROD(a, b) (a[0]*b[0] + a[1]*b[1] + a[2]*b[2]) #define QATAN2(y,x) qatan2(y,x) -#define QASIN(x) asin(x) // \fixme Precalculate arcsin. +#define QASIN(x) asin(x) // @todo Precalculate arcsin. #define MAX_ARRAYS (2 + MAX_TEX_UNITS) diff --git a/doomsday/engine/portable/src/rend_sprite.c b/doomsday/engine/portable/src/rend_sprite.c index 9652f7c308..11420fc4f6 100644 --- a/doomsday/engine/portable/src/rend_sprite.c +++ b/doomsday/engine/portable/src/rend_sprite.c @@ -457,7 +457,7 @@ void Rend_DrawPSprite(const rendpspriteparams_t *params) v4[VY] = params->pos[VY] + params->height; // All psprite vertices are co-plannar, so just copy the view front vector. - // \fixme: Can we do something better here? + // @todo: Can we do something better here? { const float* frontVec = R_ViewData(viewPlayer - ddPlayers)->frontVec; for(i = 0; i < 4; ++i) @@ -1026,7 +1026,7 @@ glEnd(); #endif*/ // All sprite vertices are co-plannar, so just copy the surface normal. - // \fixme: Can we do something better here? + // @todo: Can we do something better here? for(i = 0; i < 4; ++i) { V3f_Copyd(quadNormals[i].xyz, surfaceNormal); diff --git a/doomsday/engine/portable/src/s_cache.c b/doomsday/engine/portable/src/s_cache.c index 57ed6f770f..2106e5c38b 100644 --- a/doomsday/engine/portable/src/s_cache.c +++ b/doomsday/engine/portable/src/s_cache.c @@ -573,7 +573,7 @@ static sfxsample_t* cacheSample(int id, const sfxinfo_t* info) * If the sound has an invalid lumpname, search external anyway. * If the original sound is from a PWAD, we won't look for an * external resource (probably a custom sound). - * \fixme should be a cvar. + * @todo should be a cvar. */ if(info->lumpNum < 0 || !F_LumpIsCustom(info->lumpNum)) { diff --git a/doomsday/engine/portable/src/s_sfx.c b/doomsday/engine/portable/src/s_sfx.c index bb0b4eee8e..8a4fd9b32a 100644 --- a/doomsday/engine/portable/src/s_sfx.c +++ b/doomsday/engine/portable/src/s_sfx.c @@ -105,7 +105,7 @@ void Sfx_UpdateReverb(void) * buffer for each channel, which means the refresh must be done often * enough to keep them filled. * - * \fixme Use a real mutex, will you? + * @todo Use a real mutex, will you? */ int C_DECL Sfx_ChannelRefreshThread(void* parm) { @@ -1112,7 +1112,7 @@ boolean Sfx_Init(void) // This is based on the scientific calculations that if the DOOM marine // is 56 units tall, 60 is about two meters. - //// \fixme Derive from the viewheight. + //// @todo Derive from the viewheight. AudioDriver_SFX()->Listener(SFXLP_UNITS_PER_METER, 30); AudioDriver_SFX()->Listener(SFXLP_DOPPLER, 1.5f); diff --git a/doomsday/engine/portable/src/sv_pool.c b/doomsday/engine/portable/src/sv_pool.c index 2817cefbb3..19e1db528d 100644 --- a/doomsday/engine/portable/src/sv_pool.c +++ b/doomsday/engine/portable/src/sv_pool.c @@ -446,7 +446,7 @@ void Sv_RegisterSector(dt_sector_t* reg, uint number) reg->lightLevel = sec->lightLevel; memcpy(reg->rgb, sec->rgb, sizeof(reg->rgb)); - // \fixme $nplanes + // @todo $nplanes for(i = 0; i < 2; ++i) // number of planes in sector. { // Plane properties diff --git a/doomsday/engine/portable/src/sys_network.c b/doomsday/engine/portable/src/sys_network.c index 1fe5333ca1..1d46a2cdd0 100644 --- a/doomsday/engine/portable/src/sys_network.c +++ b/doomsday/engine/portable/src/sys_network.c @@ -388,7 +388,7 @@ static boolean joinNode(nodeid_t id, int clientProtocol, const char *name) LegacyNetwork_SocketSet_Remove(sockSet, node->sock); LegacyNetwork_SocketSet_Add(joinedSockSet, node->sock); - // \fixme We should use more discretion with the name. It has + // @todo We should use more discretion with the name. It has // been provided by an untrusted source. strncpy(node->name, name, sizeof(node->name) - 1); diff --git a/doomsday/engine/portable/src/texture.c b/doomsday/engine/portable/src/texture.c index fd2d0b45c2..0c2fbbdd52 100644 --- a/doomsday/engine/portable/src/texture.c +++ b/doomsday/engine/portable/src/texture.c @@ -231,7 +231,7 @@ void Texture_SetFlags(Texture* tex, int flags) { assert(tex); tex->flags = flags; - /// \fixme Update any Materials (and thus Surfaces) which reference this. + /// @todo Update any Materials (and thus Surfaces) which reference this. } int Texture_Width(const Texture* tex) @@ -244,7 +244,7 @@ void Texture_SetWidth(Texture* tex, int width) { assert(tex); Size2_SetWidth(tex->size, width); - /// \fixme Update any Materials (and thus Surfaces) which reference this. + /// @todo Update any Materials (and thus Surfaces) which reference this. } int Texture_Height(const Texture* tex) @@ -257,7 +257,7 @@ void Texture_SetHeight(Texture* tex, int height) { assert(tex); Size2_SetHeight(tex->size, height); - /// \fixme Update any Materials (and thus Surfaces) which reference this. + /// @todo Update any Materials (and thus Surfaces) which reference this. } const Size2* Texture_Size(const Texture* tex) @@ -270,7 +270,7 @@ void Texture_SetSize(Texture* tex, const Size2Raw* size) { assert(tex && size); Size2_SetWidthHeight(tex->size, size->width, size->height); - /// \fixme Update any Materials (and thus Surfaces) which reference this. + /// @todo Update any Materials (and thus Surfaces) which reference this. } int Texture_IterateVariants(Texture* tex, diff --git a/doomsday/engine/portable/src/textures.c b/doomsday/engine/portable/src/textures.c index 0d0af19334..d4b8abf209 100644 --- a/doomsday/engine/portable/src/textures.c +++ b/doomsday/engine/portable/src/textures.c @@ -629,7 +629,7 @@ void Textures_Release(Texture* tex) { /// Stub. GL_ReleaseGLTexturesByTexture(tex); - /// \fixme Update any Materials (and thus Surfaces) which reference this. + /// @todo Update any Materials (and thus Surfaces) which reference this. } Texture* Textures_ToTexture(textureid_t id) @@ -925,7 +925,7 @@ Texture* Textures_CreateWithSize(textureid_t id, int flags, const Size2Raw* size Texture_SetFlags(tex, flags); Texture_SetSize(tex, size); Texture_AttachUserData(tex, userData); - /// \fixme Materials and Surfaces should be notified of this! + /// @todo Materials and Surfaces should be notified of this! return tex; } diff --git a/doomsday/engine/portable/src/ui2_main.c b/doomsday/engine/portable/src/ui2_main.c index d92ecc9654..57af4c014e 100644 --- a/doomsday/engine/portable/src/ui2_main.c +++ b/doomsday/engine/portable/src/ui2_main.c @@ -822,7 +822,7 @@ static void setupModelParamsForFIObject(rendmodelparams_t* params, const char* m params->origin[VX] = worldOffset[VX] + pos[VX]; params->origin[VY] = worldOffset[VZ] + pos[VZ]; params->origin[VZ] = worldOffset[VY] + pos[VY]; - params->distance = -10; /// \fixme inherit depth. + params->distance = -10; /// @todo inherit depth. params->yawAngleOffset = (SCREENWIDTH/2 - pos[VX]) * weaponOffsetScale + 90; params->pitchAngleOffset = (SCREENHEIGHT/2 - pos[VY]) * weaponOffsetScale * weaponOffsetScaleY / 1000.0f; params->yaw = params->yawAngleOffset + 180; @@ -833,7 +833,7 @@ static void setupModelParamsForFIObject(rendmodelparams_t* params, const char* m params->ambientColor[CR] = params->ambientColor[CG] = params->ambientColor[CB] = 1; params->ambientColor[CA] = 1; /** - * \fixme This additional scale multiplier is necessary for the model + * @todo This additional scale multiplier is necessary for the model * to be drawn at a scale consistent with the other object types * (e.g., Model compared to Pic). * @@ -860,7 +860,7 @@ void UI2_Drawer(void) return; } - /// \fixme need to refactor. + /// @todo need to refactor. /*bordered = (FI_ScriptActive() && FI_ScriptCmdExecuted()); if(bordered) { // Draw using the special bordered projection. diff --git a/doomsday/engine/portable/src/zipfile.c b/doomsday/engine/portable/src/zipfile.c index fe4205fb3b..396da60b51 100644 --- a/doomsday/engine/portable/src/zipfile.c +++ b/doomsday/engine/portable/src/zipfile.c @@ -1,4 +1,4 @@ -/**\file dd_zip.c +/**\file zipfile.c *\section License * License: GPL * Online License Link: http://www.gnu.org/licenses/gpl.html diff --git a/doomsday/engine/unix/src/sys_path.c b/doomsday/engine/unix/src/sys_path.c index fbdf8bb78f..715712100a 100644 --- a/doomsday/engine/unix/src/sys_path.c +++ b/doomsday/engine/unix/src/sys_path.c @@ -68,11 +68,11 @@ char* _fullpath(char* full, const char* original, int maxLen) { char* cwd, *buf; - // \fixme Check for '~'. + // @todo Check for '~'. if(original[0] != DIR_SEP_CHAR) // A relative path? { - /// \fixme Check for ERANGE. + /// @todo Check for ERANGE. cwd = getcwd(NULL, 0); if(NULL == cwd) { diff --git a/doomsday/engine/win32/src/dd_winit.c b/doomsday/engine/win32/src/dd_winit.c index 58f4675605..acb56f1566 100644 --- a/doomsday/engine/win32/src/dd_winit.c +++ b/doomsday/engine/win32/src/dd_winit.c @@ -123,7 +123,7 @@ LPCSTR ToAnsiString(const wchar_t* wstr) */ const char* DD_Win32_GetLastErrorMessage(void) { - static char* buffer = 0; /// \fixme Never free'd! + static char* buffer = 0; /// @todo Never free'd! static size_t currentBufferSize = 0; LPVOID lpMsgBuf; diff --git a/doomsday/libdeng2/include/de/c_wrapper.h b/doomsday/libdeng2/include/de/c_wrapper.h index bc178d6a45..1169199cc8 100644 --- a/doomsday/libdeng2/include/de/c_wrapper.h +++ b/doomsday/libdeng2/include/de/c_wrapper.h @@ -23,12 +23,15 @@ #include "libdeng2.h" /** - * @file Defines the C wrapper API for libdeng2 classes. Legacy code can use - * this wrapper API to access libdeng2 functionality. Note that the identifiers - * in this file are not in the de namespace. + * @file c_wrapper.h + * libdeng2 C wrapper. * - * @note The basic de data types (e.g., dint32) are not available for the C API; - * instead, only the standard C data types should be used. + * Defines a C wrapper API for (some of the) libdeng2 classes. Legacy code + * can use this wrapper API to access libdeng2 functionality. Note that the + * identifiers in this file are not in the de namespace. + * + * @note The basic de data types (e.g., dint32) are not available for the C + * API; instead, only the standard C data types should be used. */ #ifdef __cplusplus diff --git a/doomsday/libdeng2/include/de/data/info.h b/doomsday/libdeng2/include/de/data/info.h index 933a07eef4..89fd7ffaf6 100644 --- a/doomsday/libdeng2/include/de/data/info.h +++ b/doomsday/libdeng2/include/de/data/info.h @@ -50,7 +50,8 @@ class Info }; /** - * @param name Case-independent name of the element. + * @param t Type of the element. + * @param n Case-independent name of the element. */ Element(Type t = None, const String& n = "") : _type(t) { setName(n); } virtual ~Element() {} diff --git a/doomsday/libdeng2/include/de/legacy/legacycore.h b/doomsday/libdeng2/include/de/legacy/legacycore.h index dede49257e..d24f53320f 100644 --- a/doomsday/libdeng2/include/de/legacy/legacycore.h +++ b/doomsday/libdeng2/include/de/legacy/legacycore.h @@ -103,8 +103,8 @@ class LegacyCore : public QObject /** * Registers a new single-shot timer that will do a callback. * - * @param milliseconds Time to wait. - * @param timerCallback Callback to call. + * @param milliseconds Time to wait. + * @param func Callback to call. */ void timer(duint32 milliseconds, void (*func)(void)); diff --git a/doomsday/libdeng2/include/de/net/socket.h b/doomsday/libdeng2/include/de/net/socket.h index f9019c0e16..b40b10b851 100644 --- a/doomsday/libdeng2/include/de/net/socket.h +++ b/doomsday/libdeng2/include/de/net/socket.h @@ -108,7 +108,7 @@ class DENG2_PUBLIC Socket : public QObject, public Transmitter * a temporary buffer before sending. The data is sent on the current * sending channel. * - * @param data Data to send. + * @param packet Data to send. */ void send(const IByteArray &packet); diff --git a/doomsday/plugins/common/src/g_controls.c b/doomsday/plugins/common/src/g_controls.c index 40b091efe2..3f48f0eff7 100644 --- a/doomsday/plugins/common/src/g_controls.c +++ b/doomsday/plugins/common/src/g_controls.c @@ -751,7 +751,7 @@ static void G_UpdateCmdControls(ticcmd_t *cmd, int pnum, lspeed = 2; // Return the max speed for the player's class. - //// \fixme the Turbo movement multiplier should happen server-side! + //// @todo the Turbo movement multiplier should happen server-side! sideMoveSpeed = pClassInfo->sidemove[speed] * turboMul; fwdMoveSpeed = pClassInfo->forwardmove[speed] * turboMul; turnSpeed = pClassInfo->turnSpeed[(cstate->turnheld < SLOWTURNTICS ? 2 : speed)]; diff --git a/doomsday/plugins/common/src/hu_automap.c b/doomsday/plugins/common/src/hu_automap.c index 15d9728172..1358e48975 100644 --- a/doomsday/plugins/common/src/hu_automap.c +++ b/doomsday/plugins/common/src/hu_automap.c @@ -1398,7 +1398,7 @@ void UIAutomap_Rebuild(uiwidget_t* obj) */ void UIAutomap_Drawer(uiwidget_t* obj, const Point2Raw* offset) { - static int updateWait = 0; /// \fixme should be an instance var of UIAutomap + static int updateWait = 0; /// @todo should be an instance var of UIAutomap guidata_automap_t* am = (guidata_automap_t*)obj->typedata; const float alpha = uiRendState->pageAlpha; diff --git a/doomsday/plugins/common/src/hu_log.c b/doomsday/plugins/common/src/hu_log.c index 1e4981e862..a7c58db4ab 100644 --- a/doomsday/plugins/common/src/hu_log.c +++ b/doomsday/plugins/common/src/hu_log.c @@ -332,7 +332,7 @@ void UILog_Drawer(uiwidget_t* obj, const Point2Raw* offset) } FR_SetFont(obj->font); - /// \fixme Query line height from the font. + /// @todo Query line height from the font. lineHeight = FR_CharHeight('Q')+1; // Scroll offset is calculated using the timeout of the first visible message. @@ -461,7 +461,7 @@ void UILog_UpdateGeometry(uiwidget_t* obj) } FR_SetFont(FID(GF_FONTA)); - /// \fixme Query line height from the font. + /// @todo Query line height from the font. lineHeight = FR_CharHeight('Q')+1; // Scroll offset is calculated using the timeout of the first visible message. diff --git a/doomsday/plugins/common/src/p_map.c b/doomsday/plugins/common/src/p_map.c index 5f0a39441f..3da4173fda 100644 --- a/doomsday/plugins/common/src/p_map.c +++ b/doomsday/plugins/common/src/p_map.c @@ -2553,7 +2553,7 @@ int PTR_SlideTraverse(const intercept_t* in, void* paramaters) } /** - * \fixme The momx / momy move is bad, so try to slide along a wall. + * @todo The momx / momy move is bad, so try to slide along a wall. * Find the first line hit, move flush to it, and slide along it * * This is a kludgy mess. diff --git a/doomsday/plugins/common/src/p_mapsetup.c b/doomsday/plugins/common/src/p_mapsetup.c index 943983ff7b..5fdcd11d2a 100644 --- a/doomsday/plugins/common/src/p_mapsetup.c +++ b/doomsday/plugins/common/src/p_mapsetup.c @@ -779,7 +779,7 @@ int P_SetupMapWorker(void* paramaters) { lumpname_t mapId; G_MapId(param->episode, param->map, mapId); Con_Message("Load ACS scripts\n"); - // \fixme Should be interpreted by the map converter. + // @todo Should be interpreted by the map converter. P_LoadACScripts(W_GetLumpNumForName(mapId) + 11 /*ML_BEHAVIOR*/); // ACS object code } #endif diff --git a/doomsday/plugins/common/src/p_player.c b/doomsday/plugins/common/src/p_player.c index 0652f83e87..e2d21ea6cd 100644 --- a/doomsday/plugins/common/src/p_player.c +++ b/doomsday/plugins/common/src/p_player.c @@ -559,7 +559,7 @@ weapontype_t P_MaybeChangeWeapon(player_t *player, weapontype_t weapon, continue; /** - * \fixme Have we got enough of ALL used ammo types? + * @todo Have we got enough of ALL used ammo types? * Problem, since the ammo has not been given yet (could * be an object that gives several ammo types eg backpack) * we can't test for this with what we know! @@ -850,7 +850,7 @@ void P_SetYellowMessage(player_t* pl, const char* msg, boolean noHide) Con_FPrintf(CPF_CYAN, "%s\n", msg); // Servers are responsible for sending these messages to the clients. - /// \fixme We shouldn't need to send the format string along with every + /// @todo We shouldn't need to send the format string along with every /// important game message. Instead flag a bit in the packet and then /// reconstruct on the other end. NetSv_SendMessage(pl - players, Str_Text(&buf)); @@ -1080,7 +1080,7 @@ int P_PlayerGiveArmorBonus(player_t* plr, armortype_t type, int points) oldPoints = *current; if(points > 0) { - delta = points; /// \fixme No upper limit? + delta = points; /// @todo No upper limit? } else { @@ -1217,7 +1217,7 @@ D_CMD(PrintPlayerCoords) D_CMD(CycleSpy) { - //// \fixme The engine should do this. + //// @todo The engine should do this. Con_Printf("Spying not allowed.\n"); #if 0 if(G_GameState() == GS_MAP && !deathmatch) diff --git a/doomsday/plugins/common/src/p_saveg.c b/doomsday/plugins/common/src/p_saveg.c index b3aea3dd96..c840a2f20a 100644 --- a/doomsday/plugins/common/src/p_saveg.c +++ b/doomsday/plugins/common/src/p_saveg.c @@ -5468,8 +5468,8 @@ void SV_MapTeleport(uint map, uint position) players[i].weapons[j].owned = true; } } - players[i].ammo[AT_BLUEMANA].owned = 25; //// \fixme values.ded - players[i].ammo[AT_GREENMANA].owned = 25; //// \fixme values.ded + players[i].ammo[AT_BLUEMANA].owned = 25; //// @todo values.ded + players[i].ammo[AT_GREENMANA].owned = 25; //// @todo values.ded if(bestWeapon) { // Bring up the best weapon players[i].pendingWeapon = bestWeapon; @@ -5483,7 +5483,7 @@ void SV_MapTeleport(uint map, uint position) } randomClassParm = rClass; - //// \fixme Redirect anything targeting a player mobj + //// @todo Redirect anything targeting a player mobj //// FIXME! This only supports single player games!! if(targetPlayerAddrs) { diff --git a/doomsday/plugins/common/src/p_start.c b/doomsday/plugins/common/src/p_start.c index f669d7745e..117ba6806d 100644 --- a/doomsday/plugins/common/src/p_start.c +++ b/doomsday/plugins/common/src/p_start.c @@ -918,8 +918,8 @@ void P_RebornPlayer(int plrNum) } } - p->ammo[AT_BLUEMANA].owned = 25; //// \fixme values.ded - p->ammo[AT_GREENMANA].owned = 25; //// \fixme values.ded + p->ammo[AT_BLUEMANA].owned = 25; //// @todo values.ded + p->ammo[AT_GREENMANA].owned = 25; //// @todo values.ded if(bestWeapon) { // Bring up the best weapon. p->pendingWeapon = bestWeapon; diff --git a/doomsday/plugins/common/src/p_user.c b/doomsday/plugins/common/src/p_user.c index dabb2ca90d..d3f3b34b9c 100644 --- a/doomsday/plugins/common/src/p_user.c +++ b/doomsday/plugins/common/src/p_user.c @@ -1681,7 +1681,7 @@ void P_PlayerThinkLookYaw(player_t* player) int playerNum = player - players; ddplayer_t* plr = player->plr; classinfo_t* pClassInfo = PCLASS_INFO(player->class_); - float offsetSensitivity = 100; /// \fixme Should be done engine-side, mouse sensitivity! + float offsetSensitivity = 100; /// @todo Should be done engine-side, mouse sensitivity! float vel, off, turnSpeedPerTic; if(!plr->mo || player->playerState == PST_DEAD || player->viewLock) @@ -1721,7 +1721,7 @@ void P_PlayerThinkLookPitch(player_t* player, timespan_t ticLength) int playerNum = player - players; ddplayer_t* plr = player->plr; float vel, off; - float offsetSensitivity = 100; /// \fixme Should be done engine-side, mouse sensitivity! + float offsetSensitivity = 100; /// @todo Should be done engine-side, mouse sensitivity! if(!plr->mo || player->playerState == PST_DEAD || player->viewLock) return; // Nothing to control. diff --git a/doomsday/plugins/common/src/p_xgline.c b/doomsday/plugins/common/src/p_xgline.c index 02da0f69dd..169deffa67 100644 --- a/doomsday/plugins/common/src/p_xgline.c +++ b/doomsday/plugins/common/src/p_xgline.c @@ -1552,7 +1552,7 @@ int C_DECL XLTrav_Music(LineDef* line, boolean dummy, void* context, } } - //// \fixme Add code to validate song id here. + //// @todo Add code to validate song id here. if(song) { @@ -2166,7 +2166,7 @@ boolean XL_CheckKeys(mobj_t* mo, int flags2, boolean doMsg, boolean doSfx) boolean* keys = act->keys; int badsound = SFX_PLROOF; #elif __JSTRIFE__ -//// \fixme FIXME!!! +//// @todo FIXME!!! int num = 3; int* keys = (int *) act->keys; int badsound = SFX_NONE; diff --git a/doomsday/plugins/jdoom/include/d_englsh.h b/doomsday/plugins/jdoom/include/d_englsh.h index e027dc6e9e..ebd1ae72d8 100644 --- a/doomsday/plugins/jdoom/include/d_englsh.h +++ b/doomsday/plugins/jdoom/include/d_englsh.h @@ -282,7 +282,7 @@ #define HUSTR_PLRBROWN GET_TXT(TXT_HUSTR_PLRBROWN) #define HUSTR_PLRRED GET_TXT(TXT_HUSTR_PLRRED) -//// \fixme What are these doing here?? +//// @todo What are these doing here?? #define HUSTR_KEYGREEN 'g' #define HUSTR_KEYINDIGO 'i' #define HUSTR_KEYBROWN 'b' diff --git a/doomsday/plugins/jdoom/src/d_main.c b/doomsday/plugins/jdoom/src/d_main.c index 0cf5b11a39..682a7bfc7a 100644 --- a/doomsday/plugins/jdoom/src/d_main.c +++ b/doomsday/plugins/jdoom/src/d_main.c @@ -444,7 +444,7 @@ void D_PostInit(void) int p; /// \kludge Border background is different in DOOM2. - /// \fixme Do this properly! + /// @todo Do this properly! if(gameModeBits & GM_ANY_DOOM2) borderGraphics[0] = "Flats:GRNROCK"; else diff --git a/doomsday/plugins/jdoom/src/p_mobj.c b/doomsday/plugins/jdoom/src/p_mobj.c index 696142eef2..1150da5f1d 100644 --- a/doomsday/plugins/jdoom/src/p_mobj.c +++ b/doomsday/plugins/jdoom/src/p_mobj.c @@ -644,7 +644,7 @@ void P_MobjThinker(mobj_t* mo) { P_MobjMoveZ(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/d_englsh.h b/doomsday/plugins/jdoom64/include/d_englsh.h index e19f1883a1..cb71831d41 100644 --- a/doomsday/plugins/jdoom64/include/d_englsh.h +++ b/doomsday/plugins/jdoom64/include/d_englsh.h @@ -152,7 +152,7 @@ #define HUSTR_PLRBROWN GET_TXT(TXT_HUSTR_PLRBROWN) #define HUSTR_PLRRED GET_TXT(TXT_HUSTR_PLRRED) -//// \fixme What are these doing here?? +//// @todo What are these doing here?? #define HUSTR_KEYGREEN 'g' #define HUSTR_KEYINDIGO 'i' #define HUSTR_KEYBROWN 'b' diff --git a/doomsday/plugins/jdoom64/src/p_mobj.c b/doomsday/plugins/jdoom64/src/p_mobj.c index b65ddbab40..764eda51dc 100644 --- a/doomsday/plugins/jdoom64/src/p_mobj.c +++ b/doomsday/plugins/jdoom64/src/p_mobj.c @@ -638,7 +638,7 @@ void P_MobjThinker(mobj_t *mobj) { P_MobjMoveXY(mobj); - //// \fixme decent NOP/NULL/Nil function pointer please. + //// @todo decent NOP/NULL/Nil function pointer please. if(mobj->thinker.function == NOPFUNC) return; // Mobj was removed. } diff --git a/doomsday/plugins/jdoom64/src/p_telept.c b/doomsday/plugins/jdoom64/src/p_telept.c index 0ecd1ae8a7..b57b874f4b 100644 --- a/doomsday/plugins/jdoom64/src/p_telept.c +++ b/doomsday/plugins/jdoom64/src/p_telept.c @@ -405,7 +405,7 @@ int PIT_ChangeMobjFlags(thinker_t* th, void* context) * kaiser - removes things in tagged sector! * DJS - actually, no it doesn't at least not directly. * - * \fixme: It appears the MF_TELEPORT flag has been hijacked. + * @todo: It appears the MF_TELEPORT flag has been hijacked. */ int EV_FadeAway(LineDef* line, mobj_t* thing) { diff --git a/doomsday/plugins/jheretic/src/h_main.c b/doomsday/plugins/jheretic/src/h_main.c index 90d119610d..4171f1a289 100644 --- a/doomsday/plugins/jheretic/src/h_main.c +++ b/doomsday/plugins/jheretic/src/h_main.c @@ -379,7 +379,7 @@ void H_PostInit(void) int p; /// \kludge Shareware WAD has different border background. - /// \fixme Do this properly! + /// @todo Do this properly! if(gameMode == heretic_shareware) borderGraphics[0] = "Flats:FLOOR04"; else diff --git a/doomsday/plugins/jheretic/src/p_mobj.c b/doomsday/plugins/jheretic/src/p_mobj.c index 11f71025c3..5236097cc0 100644 --- a/doomsday/plugins/jheretic/src/p_mobj.c +++ b/doomsday/plugins/jheretic/src/p_mobj.c @@ -860,7 +860,7 @@ void P_MobjThinker(mobj_t* mobj) //assert(!beforeOk || P_CheckPosition(mobj, mobj->origin)); - //// \fixme decent NOP/NULL/Nil function pointer please. + //// @todo decent NOP/NULL/Nil function pointer please. if(mobj->thinker.function == NOPFUNC) return; // Mobj was removed. } diff --git a/doomsday/plugins/jheretic/src/st_stuff.c b/doomsday/plugins/jheretic/src/st_stuff.c index b18646caea..fa63aae6fc 100644 --- a/doomsday/plugins/jheretic/src/st_stuff.c +++ b/doomsday/plugins/jheretic/src/st_stuff.c @@ -412,7 +412,7 @@ void SBarChain_UpdateGeometry(uiwidget_t* obj) if(ST_AutomapIsActive(obj->player) && cfg.automapHudDisplay == 0) return; if(P_MobjIsCamera(players[obj->player].plr->mo) && Get(DD_PLAYBACK)) return; - /// \fixme Calculate dimensions properly. + /// @todo Calculate dimensions properly. Rect_SetWidthHeight(obj->geometry, (ST_WIDTH - 21 - 28) * cfg.statusbarScale, 8 * cfg.statusbarScale); } @@ -669,7 +669,7 @@ void SBarInventory_UpdateGeometry(uiwidget_t* obj) if(ST_AutomapIsActive(obj->player) && cfg.automapHudDisplay == 0) return; if(P_MobjIsCamera(players[obj->player].plr->mo) && Get(DD_PLAYBACK)) return; - // \fixme calculate dimensions properly! + // @todo calculate dimensions properly! Rect_SetWidthHeight(obj->geometry, (ST_WIDTH-(43*2)) * cfg.statusbarScale, 41 * cfg.statusbarScale); } @@ -1262,7 +1262,7 @@ void SBarReadyItem_UpdateGeometry(uiwidget_t* obj) if(item->patchId == 0) return; if(!R_GetPatchInfo(item->patchId, &info)) return; - // \fixme Calculate dimensions properly! + // @todo Calculate dimensions properly! Rect_SetWidthHeight(obj->geometry, info.geometry.size.width * cfg.statusbarScale, info.geometry.size.height * cfg.statusbarScale); } @@ -1382,7 +1382,7 @@ void Flight_UpdateGeometry(uiwidget_t* obj) if(P_MobjIsCamera(players[obj->player].plr->mo) && Get(DD_PLAYBACK)) return; if(plr->powers[PT_FLIGHT] <= 0) return; - /// \fixme Calculate dimensions properly! + /// @todo Calculate dimensions properly! Rect_SetWidthHeight(obj->geometry, 32 * cfg.hudScale, 32 * cfg.hudScale); } @@ -1491,7 +1491,7 @@ void Tome_UpdateGeometry(uiwidget_t* obj) if(tome->patchId != 0) { - // \fixme Determine the actual center point of the animation at widget creation time. + // @todo Determine the actual center point of the animation at widget creation time. Rect_SetWidthHeight(obj->geometry, 26 * cfg.hudScale, 26 * cfg.hudScale); } else @@ -2027,7 +2027,7 @@ void Inventory_UpdateGeometry(uiwidget_t* obj) if(ST_AutomapIsActive(obj->player) && cfg.automapHudDisplay == 0) return; if(P_MobjIsCamera(players[obj->player].plr->mo) && Get(DD_PLAYBACK)) return; - /// \fixme Calculate the visual dimensions properly! + /// @todo Calculate the visual dimensions properly! Rect_SetWidthHeight(obj->geometry, (31*7+16*2) * EXTRA_SCALE * cfg.hudScale, INVENTORY_HEIGHT * EXTRA_SCALE * cfg.hudScale); diff --git a/doomsday/plugins/jhexen/src/p_inter.c b/doomsday/plugins/jhexen/src/p_inter.c index cb4d13fb04..b0637e876f 100644 --- a/doomsday/plugins/jhexen/src/p_inter.c +++ b/doomsday/plugins/jhexen/src/p_inter.c @@ -338,7 +338,7 @@ boolean P_GiveMana(player_t *plr, ammotype_t ammo, int num) plr->ammo[ammo].owned += num; plr->update |= PSF_AMMO; - //// \fixme - DJS: This shouldn't be actioned from here. + //// @todo - DJS: This shouldn't be actioned from here. if(plr->class_ == PCLASS_FIGHTER && plr->readyWeapon == WT_SECOND && ammo == AT_BLUEMANA && prevMana <= 0) { @@ -2226,7 +2226,7 @@ int P_DamageMobj2(mobj_t* target, mobj_t* inflictor, mobj_t* source, int damageP } else { // "electrocute" the target. - //// \fixme make fullbright for this frame --> + //// @todo make fullbright for this frame --> //target->frame |= FF_FULLBRIGHT; // <-- fixme if((target->flags & MF_COUNTKILL) && P_Random() < 128 && diff --git a/doomsday/plugins/jhexen/src/st_stuff.c b/doomsday/plugins/jhexen/src/st_stuff.c index 381dfbd529..8bac23f234 100644 --- a/doomsday/plugins/jhexen/src/st_stuff.c +++ b/doomsday/plugins/jhexen/src/st_stuff.c @@ -1009,7 +1009,7 @@ void SBarInventory_UpdateGeometry(uiwidget_t* obj) if(ST_AutomapIsActive(obj->player) && cfg.automapHudDisplay == 0) return; if(P_MobjIsCamera(players[obj->player].plr->mo) && Get(DD_PLAYBACK)) return; - // \fixme calculate dimensions properly! + // @todo calculate dimensions properly! Rect_SetWidthHeight(obj->geometry, (ST_WIDTH-(43*2)) * cfg.statusbarScale, 41 * cfg.statusbarScale); }