Add doxygen description to remaining engine files

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. */

Source/objdat.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file objdat.h
+ *
+ * Interface of all object data.
+ */
 #ifndef __OBJDAT_H__
 #define __OBJDAT_H__
 

Source/objects.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file objects.cpp
+ *
+ * Implementation of object functionality, interaction, spawning, loading, etc.
+ */
 #include "all.h"
 
 int trapid;

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__
 

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"
 

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__
 

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"
 

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__
 

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"

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__
 

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"
 

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__
 

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;

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__
 

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. */

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__
 

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] = {

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__
 

Source/render.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file render.cpp
+ *
+ * Implementation of functionality for rendering the level tiles.
+ */
 #include "all.h"
 #include "_asm.cpp"
 

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__
 

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()

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__
 

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"
 

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__
 

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

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__
 

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];

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) \

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"
 

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__
 

Source/spelldat.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file spelldat.cpp
+ *
+ * Implementation of all spell data.
+ */
 #include "all.h"
 
 /** Data related to each spell ID. */

Source/spelldat.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file spelldat.h
+ *
+ * Interface of all spell data.
+ */
 #ifndef __SPELLDAT_H__
 #define __SPELLDAT_H__
 

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)

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__
 

Source/stores.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file stores.cpp
+ *
+ * Implementation of functionality for stores and towner dialogs.
+ */
 #include "all.h"
 
 int stextup;

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__
 

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];

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__
 

Source/textdat.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file textdat.cpp
+ *
+ * Implementation of all dialog texts.
+ */
 #include "all.h"
 
 /* todo: move text out of struct */

Source/textdat.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file textdat.h
+ *
+ * Interface of all dialog texts.
+ */
 #ifndef __TEXTDAT_H__
 #define __TEXTDAT_H__
 

Source/tmsg.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file tmsg.cpp
+ *
+ * Implementation of functionality transmitting chat messages.
+ */
 #include "all.h"
 
 static TMsg *sgpTimedMsgHead;

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__
 

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"
 
 /**

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__
 

Source/towners.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file towners.cpp
+ *
+ * Implementation of functionality for loading and spawning towners.
+ */
 #include "all.h"
 
 BOOL storeflag;

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__
 

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"
 

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__
 

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];

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__
 

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"
 

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__