diff --git a/Source/objdat.cpp b/Source/objdat.cpp index 712bc0eff..8a6fb1f62 100644 --- a/Source/objdat.cpp +++ b/Source/objdat.cpp @@ -1,3 +1,8 @@ +/** + * @file objdat.cpp + * + * Implementation of all object data. + */ #include "all.h" /** Maps from dun_object_id to object_id. */ diff --git a/Source/objdat.h b/Source/objdat.h index 29c33bc19..eaedca1f9 100644 --- a/Source/objdat.h +++ b/Source/objdat.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file objdat.h + * + * Interface of all object data. + */ #ifndef __OBJDAT_H__ #define __OBJDAT_H__ diff --git a/Source/objects.cpp b/Source/objects.cpp index 302a76906..89ffe152d 100644 --- a/Source/objects.cpp +++ b/Source/objects.cpp @@ -1,3 +1,8 @@ +/** + * @file objects.cpp + * + * Implementation of object functionality, interaction, spawning, loading, etc. + */ #include "all.h" int trapid; diff --git a/Source/objects.h b/Source/objects.h index 10d916648..32f63986e 100644 --- a/Source/objects.h +++ b/Source/objects.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file objects.h + * + * Interface of object functionality, interaction, spawning, loading, etc. + */ #ifndef __OBJECTS_H__ #define __OBJECTS_H__ diff --git a/Source/pack.cpp b/Source/pack.cpp index 25fe66cf2..2fc283160 100644 --- a/Source/pack.cpp +++ b/Source/pack.cpp @@ -1,3 +1,8 @@ +/** + * @file pack.cpp + * + * Implementation of functions for minifying player data structure. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/pack.h b/Source/pack.h index 5b7b6f6f1..42175b2f8 100644 --- a/Source/pack.h +++ b/Source/pack.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file pack.h + * + * Interface of functions for minifying player data structure. + */ #ifndef __PACK_H__ #define __PACK_H__ diff --git a/Source/palette.cpp b/Source/palette.cpp index ec4f7ba04..a3232e79f 100644 --- a/Source/palette.cpp +++ b/Source/palette.cpp @@ -1,3 +1,8 @@ +/** + * @file palette.cpp + * + * Implementation of functions for handling the engines color palette. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/palette.h b/Source/palette.h index 223cf8ae3..1634f9936 100644 --- a/Source/palette.h +++ b/Source/palette.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file palette.h + * + * Interface of functions for handling the engines color palette. + */ #ifndef __PALETTE_H__ #define __PALETTE_H__ diff --git a/Source/pfile.cpp b/Source/pfile.cpp index d6ac5fa02..0697caf80 100644 --- a/Source/pfile.cpp +++ b/Source/pfile.cpp @@ -1,3 +1,8 @@ +/** + * @file pfile.cpp + * + * Implementation of the save game encoding functionality. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" #include "../DiabloUI/diabloui.h" diff --git a/Source/pfile.h b/Source/pfile.h index f619748ec..c86868f01 100644 --- a/Source/pfile.h +++ b/Source/pfile.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file pfile.h + * + * Interface of the save game encoding functionality. + */ #ifndef __PFILE_H__ #define __PFILE_H__ diff --git a/Source/player.cpp b/Source/player.cpp index 796dc0d05..5059e6b52 100644 --- a/Source/player.cpp +++ b/Source/player.cpp @@ -1,3 +1,8 @@ +/** + * @file player.cpp + * + * Implementation of player functionality, leveling, actions, creation, loading, etc. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/player.h b/Source/player.h index bc6943b7f..a3b95b80c 100644 --- a/Source/player.h +++ b/Source/player.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file player.h + * + * Interface of player functionality, leveling, actions, creation, loading, etc. + */ #ifndef __PLAYER_H__ #define __PLAYER_H__ diff --git a/Source/plrmsg.cpp b/Source/plrmsg.cpp index d745df869..b333fd2d2 100644 --- a/Source/plrmsg.cpp +++ b/Source/plrmsg.cpp @@ -1,3 +1,8 @@ +/** + * @file plrmsg.cpp + * + * Implementation of functionality for printing the ingame chat messages. + */ #include "all.h" static BYTE plr_msg_slot; diff --git a/Source/plrmsg.h b/Source/plrmsg.h index 10b78b48c..12d723d70 100644 --- a/Source/plrmsg.h +++ b/Source/plrmsg.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file plrmsg.h + * + * Interface of functionality for printing the ingame chat messages. + */ #ifndef __PLRMSG_H__ #define __PLRMSG_H__ diff --git a/Source/portal.cpp b/Source/portal.cpp index b4b1a709d..34ae71f91 100644 --- a/Source/portal.cpp +++ b/Source/portal.cpp @@ -1,3 +1,8 @@ +/** + * @file portal.cpp + * + * Implementation of functionality for handling town portals. + */ #include "all.h" /** In-game state of portals. */ diff --git a/Source/portal.h b/Source/portal.h index 1690180dc..4131d0300 100644 --- a/Source/portal.h +++ b/Source/portal.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file portal.h + * + * Interface of functionality for handling town portals. + */ #ifndef __PORTAL_H__ #define __PORTAL_H__ diff --git a/Source/quests.cpp b/Source/quests.cpp index 678a06090..774cf4ac0 100644 --- a/Source/quests.cpp +++ b/Source/quests.cpp @@ -1,3 +1,8 @@ +/** + * @file quests.cpp + * + * Implementation of functionality for handling quests. + */ #include "all.h" int qtopline; @@ -11,7 +16,8 @@ int WaterDone; int ReturnLvlX; int ReturnLvlY; int ReturnLvlT; -int ALLQUESTS; /** current frame # for the pentagram selector */ +/** current frame # for the pentagram selector */ +int ALLQUESTS; int ReturnLvl; QuestData questlist[MAXQUESTS] = { diff --git a/Source/quests.h b/Source/quests.h index cf52fb578..35b2dfc9e 100644 --- a/Source/quests.h +++ b/Source/quests.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file quests.cpp + * + * Interface of functionality for handling quests. + */ #ifndef __QUESTS_H__ #define __QUESTS_H__ diff --git a/Source/render.cpp b/Source/render.cpp index 7d1327f9e..98a05d58b 100644 --- a/Source/render.cpp +++ b/Source/render.cpp @@ -1,3 +1,8 @@ +/** + * @file render.cpp + * + * Implementation of functionality for rendering the level tiles. + */ #include "all.h" #include "_asm.cpp" diff --git a/Source/render.h b/Source/render.h index f872fb7aa..541e2c326 100644 --- a/Source/render.h +++ b/Source/render.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file render.h + * + * Interface of functionality for rendering the level tiles. + */ #ifndef __RENDER_H__ #define __RENDER_H__ diff --git a/Source/restrict.cpp b/Source/restrict.cpp index 0522480c6..4f4fed25f 100644 --- a/Source/restrict.cpp +++ b/Source/restrict.cpp @@ -1,3 +1,8 @@ +/** + * @file restrict.cpp + * + * Implementation of functionality for checking if the game will be able run on the system. + */ #include "all.h" BOOL SystemSupported() diff --git a/Source/restrict.h b/Source/restrict.h index 8a87a4641..9e7fee7a4 100644 --- a/Source/restrict.h +++ b/Source/restrict.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file restrict.h + * + * Interface of functionality for checking if the game will be able run on the system. + */ #ifndef __RESTRICT_H__ #define __RESTRICT_H__ diff --git a/Source/scrollrt.cpp b/Source/scrollrt.cpp index 65fd463cc..6134bf935 100644 --- a/Source/scrollrt.cpp +++ b/Source/scrollrt.cpp @@ -1,3 +1,8 @@ +/** + * @file plrmsg.cpp + * + * Implementation of functionality for rendering the dungeons, monsters and calling other render routines. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/scrollrt.h b/Source/scrollrt.h index 4d265c806..c9845bd16 100644 --- a/Source/scrollrt.h +++ b/Source/scrollrt.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file scrollrt.h + * + * Interface of functionality for rendering the dungeons, monsters and calling other render routines. + */ #ifndef __SCROLLRT_H__ #define __SCROLLRT_H__ diff --git a/Source/setmaps.cpp b/Source/setmaps.cpp index 2c6baf629..86645de2e 100644 --- a/Source/setmaps.cpp +++ b/Source/setmaps.cpp @@ -1,3 +1,8 @@ +/** + * @file setmaps.cpp + * + * Implementation of functionality the special quest dungeons. + */ #include "all.h" // BUGFIX: constant data should be const diff --git a/Source/setmaps.h b/Source/setmaps.h index e5a3a0338..b9499670a 100644 --- a/Source/setmaps.h +++ b/Source/setmaps.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file setmaps.cpp + * + * Interface of functionality the special quest dungeons. + */ #ifndef __SETMAPS_H__ #define __SETMAPS_H__ diff --git a/Source/sha.cpp b/Source/sha.cpp index 14ac71337..38d84f91a 100644 --- a/Source/sha.cpp +++ b/Source/sha.cpp @@ -1,3 +1,8 @@ +/** + * @file sha.cpp + * + * Implementation of functionality for calculating X-SHA-1 (a flawed implementation of SHA-1). + */ #include "all.h" SHA1Context sgSHA1[3]; diff --git a/Source/sha.h b/Source/sha.h index e4902e1e2..7dc287743 100644 --- a/Source/sha.h +++ b/Source/sha.h @@ -1,8 +1,12 @@ -//HEADER_GOES_HERE +/** + * @file sha.cpp + * + * Interface of functionality for calculating X-SHA-1 (a flawed implementation of SHA-1). + */ #ifndef __SHA_H__ #define __SHA_H__ -/* +/** * Define the SHA1 circular left shift macro */ #define SHA1CircularShift(bits, word) \ diff --git a/Source/sound.cpp b/Source/sound.cpp index 829148044..7a50e0b50 100644 --- a/Source/sound.cpp +++ b/Source/sound.cpp @@ -1,3 +1,8 @@ +/** + * @file sound.cpp + * + * Implementation of functions setting up the audio pipeline. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/sound.h b/Source/sound.h index bd14be411..45444eb0d 100644 --- a/Source/sound.h +++ b/Source/sound.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file sound.h + * + * Interface of functions setting up the audio pipeline. + */ #ifndef __SOUND_H__ #define __SOUND_H__ diff --git a/Source/spelldat.cpp b/Source/spelldat.cpp index 95b074ade..081528476 100644 --- a/Source/spelldat.cpp +++ b/Source/spelldat.cpp @@ -1,3 +1,8 @@ +/** + * @file spelldat.cpp + * + * Implementation of all spell data. + */ #include "all.h" /** Data related to each spell ID. */ diff --git a/Source/spelldat.h b/Source/spelldat.h index 2c894f3b9..d46546830 100644 --- a/Source/spelldat.h +++ b/Source/spelldat.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file spelldat.h + * + * Interface of all spell data. + */ #ifndef __SPELLDAT_H__ #define __SPELLDAT_H__ diff --git a/Source/spells.cpp b/Source/spells.cpp index 710928998..9f1e18a2c 100644 --- a/Source/spells.cpp +++ b/Source/spells.cpp @@ -1,3 +1,8 @@ +/** + * @file spells.cpp + * + * Implementation of functionality for casting player spells. + */ #include "all.h" int GetManaAmount(int id, int sn) diff --git a/Source/spells.h b/Source/spells.h index 9eb299e4f..a75dd69c0 100644 --- a/Source/spells.h +++ b/Source/spells.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file spells.h + * + * Interface of functionality for casting player spells. + */ #ifndef __SPELLS_H__ #define __SPELLS_H__ diff --git a/Source/stores.cpp b/Source/stores.cpp index 7bb2f12eb..19425da30 100644 --- a/Source/stores.cpp +++ b/Source/stores.cpp @@ -1,3 +1,8 @@ +/** + * @file stores.cpp + * + * Implementation of functionality for stores and towner dialogs. + */ #include "all.h" int stextup; diff --git a/Source/stores.h b/Source/stores.h index b4887d515..63c1fb37f 100644 --- a/Source/stores.h +++ b/Source/stores.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file stores.h + * + * Interface of functionality for stores and towner dialogs. + */ #ifndef __STORES_H__ #define __STORES_H__ diff --git a/Source/sync.cpp b/Source/sync.cpp index a630ff74c..f6b5422cd 100644 --- a/Source/sync.cpp +++ b/Source/sync.cpp @@ -1,3 +1,8 @@ +/** + * @file sync.cpp + * + * Implementation of functionality for syncing game state with other players. + */ #include "all.h" WORD sync_word_6AA708[MAXMONSTERS]; diff --git a/Source/sync.h b/Source/sync.h index b65f9b194..0ebccaea7 100644 --- a/Source/sync.h +++ b/Source/sync.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file sync.h + * + * Interface of functionality for syncing game state with other players. + */ #ifndef __SYNC_H__ #define __SYNC_H__ diff --git a/Source/textdat.cpp b/Source/textdat.cpp index 0eeff858d..f76bcbd75 100644 --- a/Source/textdat.cpp +++ b/Source/textdat.cpp @@ -1,3 +1,8 @@ +/** + * @file textdat.cpp + * + * Implementation of all dialog texts. + */ #include "all.h" /* todo: move text out of struct */ diff --git a/Source/textdat.h b/Source/textdat.h index 2edb4f4ad..df8b60997 100644 --- a/Source/textdat.h +++ b/Source/textdat.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file textdat.h + * + * Interface of all dialog texts. + */ #ifndef __TEXTDAT_H__ #define __TEXTDAT_H__ diff --git a/Source/tmsg.cpp b/Source/tmsg.cpp index e2d6683c1..4fb5ded02 100644 --- a/Source/tmsg.cpp +++ b/Source/tmsg.cpp @@ -1,3 +1,8 @@ +/** + * @file tmsg.cpp + * + * Implementation of functionality transmitting chat messages. + */ #include "all.h" static TMsg *sgpTimedMsgHead; diff --git a/Source/tmsg.h b/Source/tmsg.h index 7e23e31e5..2afac4be8 100644 --- a/Source/tmsg.h +++ b/Source/tmsg.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file tmsg.h + * + * Interface of functionality transmitting chat messages. + */ #ifndef __TMSG_H__ #define __TMSG_H__ diff --git a/Source/town.cpp b/Source/town.cpp index 15a866f00..76f78c380 100644 --- a/Source/town.cpp +++ b/Source/town.cpp @@ -1,3 +1,8 @@ +/** + * @file town.h + * + * Implementation of functionality for rendering the town, towners and calling other render routines. + */ #include "all.h" /** diff --git a/Source/town.h b/Source/town.h index 5327894d1..458571e95 100644 --- a/Source/town.h +++ b/Source/town.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file town.h + * + * Interface of functionality for rendering the town, towners and calling other render routines. + */ #ifndef __TOWN_H__ #define __TOWN_H__ diff --git a/Source/towners.cpp b/Source/towners.cpp index 6e3ca8d27..177788ec7 100644 --- a/Source/towners.cpp +++ b/Source/towners.cpp @@ -1,3 +1,8 @@ +/** + * @file towners.cpp + * + * Implementation of functionality for loading and spawning towners. + */ #include "all.h" BOOL storeflag; diff --git a/Source/towners.h b/Source/towners.h index ea01d016f..218456c0b 100644 --- a/Source/towners.h +++ b/Source/towners.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file towners.h + * + * Interface of functionality for loading and spawning towners. + */ #ifndef __TOWNERS_H__ #define __TOWNERS_H__ diff --git a/Source/track.cpp b/Source/track.cpp index c3bab984b..6ec54d7fa 100644 --- a/Source/track.cpp +++ b/Source/track.cpp @@ -1,3 +1,8 @@ +/** + * @file track.cpp + * + * Implementation of functionality tracking what the mouse cursor is pointing at. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/track.h b/Source/track.h index a2a2506c9..f22e02700 100644 --- a/Source/track.h +++ b/Source/track.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file track.h + * + * Interface of functionality tracking what the mouse cursor is pointing at. + */ #ifndef __TRACK_H__ #define __TRACK_H__ diff --git a/Source/trigs.cpp b/Source/trigs.cpp index af827651f..c5b84cf14 100644 --- a/Source/trigs.cpp +++ b/Source/trigs.cpp @@ -1,3 +1,8 @@ +/** + * @file trigs.cpp + * + * Implementation of functionality for triggering events when the player enters an area. + */ #include "all.h" BOOL townwarps[3]; diff --git a/Source/trigs.h b/Source/trigs.h index fe7243bbd..051615217 100644 --- a/Source/trigs.h +++ b/Source/trigs.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file trigs.h + * + * Interface of functionality for triggering events when the player enters an area. + */ #ifndef __TRIGS_H__ #define __TRIGS_H__ diff --git a/Source/wave.cpp b/Source/wave.cpp index e0fc8128e..642d5652f 100644 --- a/Source/wave.cpp +++ b/Source/wave.cpp @@ -1,3 +1,8 @@ +/** + * @file wave.cpp + * + * Implementation of functionality for loading fies and processing wave files. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/wave.h b/Source/wave.h index 7a608f688..c499576bb 100644 --- a/Source/wave.h +++ b/Source/wave.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file wave.h + * + * Interface of functionality for loading fies and processing wave files. + */ #ifndef __WAVE_H__ #define __WAVE_H__