Add documentation to more files

Source/automap.cpp

@@ -1,7 +1,7 @@
 /**
  * @file automap.cpp
  *
- * Implementation of the ingame map overlay.
+ * Implementation of the in-game map overlay.
  */
 #include "all.h"
 

Source/automap.h

@@ -1,7 +1,7 @@
 /**
  * @file automap.h
  *
- * Interface of the ingame map overlay.
+ * Interface of the in-game map overlay.
  */
 #ifndef __AUTOMAP_H__
 #define __AUTOMAP_H__

Source/gamemenu.cpp

@@ -1,7 +1,7 @@
 /**
  * @file gamemenu.cpp
  *
- * Implementation of the ingame menu functions.
+ * Implementation of the in-game menu functions.
  */
 #include "all.h"
 

Source/gamemenu.h

@@ -1,7 +1,7 @@
 /**
  * @file gamemenu.h
  *
- * Interface of the ingame menu functions.
+ * Interface of the in-game menu functions.
  */
 #ifndef __GAMEMENU_H__
 #define __GAMEMENU_H__

Source/gendung.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file gendung.cpp
+ *
+ * Implementation of general dungeon generation code.
+ */
 #include "all.h"
 
 WORD level_frame_types[MAXTILES];

Source/gendung.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file gendung.h
+ *
+ * Interface of general dungeon generation code.
+ */
 #ifndef __GENDUNG_H__
 #define __GENDUNG_H__
 

Source/gmenu.cpp

@@ -1,7 +1,7 @@
 /**
  * @file gmenu.cpp
  *
- * Implementation of the ingame navigation and interaction.
+ * Implementation of the in-game navigation and interaction.
  */
 #include "all.h"
 

Source/gmenu.h

@@ -1,7 +1,7 @@
 /**
  * @file gmenu.h
  *
- * Interface of the ingame navigation and interaction.
+ * Interface of the in-game navigation and interaction.
  */
 #ifndef __GMENU_H__
 #define __GMENU_H__

Source/help.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file help.cpp
+ *
+ * Implementation of the in-game help text.
+ */
 #include "all.h"
 
 int help_select_line;

Source/help.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file help.h
+ *
+ * Interface of the in-game help text.
+ */
 #ifndef __HELP_H__
 #define __HELP_H__
 

Source/init.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file init.cpp
+ *
+ * Implementation of routines for initializing the environment, disable screen saver, load MPQ.
+ */
 #include "all.h"
 #include "../3rdParty/Storm/Source/storm.h"
 #include "../DiabloUI/diabloui.h"

Source/init.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file init.h
+ *
+ * Interface of routines for initializing the environment, disable screen saver, load MPQ.
+ */
 #ifndef __INIT_H__
 #define __INIT_H__
 

Source/interfac.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file interfac.cpp
+ *
+ * Implementation of load screens.
+ */
 #include "all.h"
 #include "../3rdParty/Storm/Source/storm.h"
 

Source/interfac.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file interfac.h
+ *
+ * Interface of load screens.
+ */
 #ifndef __INTERFAC_H__
 #define __INTERFAC_H__
 

Source/inv.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file inv.cpp
+ *
+ * Implementation of player inventory.
+ */
 #include "all.h"
 
 BOOL invflag;

Source/inv.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file inv.h
+ *
+ * Interface of player inventory.
+ */
 #ifndef __INV_H__
 #define __INV_H__
 

Source/itemdat.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file itemdat.cpp
+ *
+ * Implementation of all item data.
+ */
 #include "all.h"
 
 ItemDataStruct AllItemsList[] = {

Source/itemdat.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file itemdat.h
+ *
+ * Interface of all item data.
+ */
 #ifndef __ITEMDAT_H__
 #define __ITEMDAT_H__
 

Source/items.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file items.cpp
+ *
+ * Implementation of item functionality.
+ */
 #include "all.h"
 
 int itemactive[MAXITEMS];

Source/items.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file items.h
+ *
+ * Interface of item functionality.
+ */
 #ifndef __ITEMS_H__
 #define __ITEMS_H__
 

Source/loadsave.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file loadsave.cpp
+ *
+ * Implementation of save game functionality.
+ */
 #include "all.h"
 
 BYTE *tbuff;

Source/loadsave.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file loadsave.h
+ *
+ * Interface of save game functionality.
+ */
 #ifndef __LOADSAVE_H__
 #define __LOADSAVE_H__
 

Source/logging.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file logging.cpp
+ *
+ * Implementation of logging functionality.
+ */
 #include "all.h"
 #include "../3rdParty/Storm/Source/storm.h"
 

Source/logging.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file logging.h
+ *
+ * Interface of logging functionality.
+ */
 #ifndef __LOGGING_H__
 #define __LOGGING_H__
 

Source/mainmenu.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file mainmenu.cpp
+ *
+ * Implementation of functions for interacting with the main menu.
+ */
 #include "all.h"
 #include "../3rdParty/Storm/Source/storm.h"
 #include "../DiabloUI/diabloui.h"

Source/mainmenu.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file mainmenu.h
+ *
+ * Interface of functions for interacting with the main menu.
+ */
 #ifndef __MAINMENU_H__
 #define __MAINMENU_H__
 

Source/minitext.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file minitext.cpp
+ *
+ * Implementation of scrolling dialog text.
+ */
 #include "all.h"
 
 int qtexty;

Source/minitext.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file minitext.h
+ *
+ * Interface of scrolling dialog text.
+ */
 #ifndef __MINITEXT_H__
 #define __MINITEXT_H__
 

Source/misdat.cpp

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

Source/misdat.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file misdat.h
+ *
+ * Interface of data related to missiles.
+ */
 #ifndef __MISDAT_H__
 #define __MISDAT_H__
 

Source/missiles.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file missiles.cpp
+ *
+ * Implementation of missile functionality.
+ */
 #include "all.h"
 
 int missileactive[MAXMISSILES];

Source/missiles.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file missiles.h
+ *
+ * Interface of missile functionality.
+ */
 #ifndef __MISSILES_H__
 #define __MISSILES_H__
 

Source/monstdat.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file monstdat.cpp
+ *
+ * Implementation of all monster data.
+ */
 #include "all.h"
 
 MonsterData monsterdata[] = {

Source/monstdat.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file monstdat.h
+ *
+ * Interface of all monster data.
+ */
 #ifndef __MONSTDAT_H__
 #define __MONSTDAT_H__
 

Source/movie.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file movie.cpp
+ *
+ * Implementation of video playback.
+ */
 #include "all.h"
 #include "../3rdParty/Storm/Source/storm.h"
 

Source/movie.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file movie.h
+ *
+ * Interface of video playback.
+ */
 #ifndef __MOVIE_H__
 #define __MOVIE_H__
 

Source/mpqapi.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file mpqapi.cpp
+ *
+ * Implementation of functions for creating and editing MPQ files.
+ */
 #include "all.h"
 #include "../3rdParty/Storm/Source/storm.h"
 

Source/mpqapi.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file mpqapi.h
+ *
+ * Interface of functions for creating and editing MPQ files.
+ */
 #ifndef __MPQAPI_H__
 #define __MPQAPI_H__
 

Source/msg.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file msg.cpp
+ *
+ * Implementation of function for sending and reciving network messages.
+ */
 #include "all.h"
 #include "../3rdParty/Storm/Source/storm.h"
 #include "../DiabloUI/diabloui.h"

Source/msg.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file msg.h
+ *
+ * Interface of function for sending and reciving network messages.
+ */
 #ifndef __MSG_H__
 #define __MSG_H__
 

Source/msgcmd.cpp

@@ -1,3 +1,10 @@
+/**
+ * @file msgcmd.cpp
+ *
+ * Functions for sending commands to Battle.net.
+ *
+ * See http://classic.battle.net/info/commands.shtml for a list of commands.
+ */
 #include <new>      // for placement new
 #include <stddef.h> // for offsetof
 #include <typeinfo> // for typeid

Source/msgcmd.h

@@ -1,4 +1,10 @@
-//HEADER_GOES_HERE
+/**
+ * @file msgcmd.h
+ *
+ * Interface for sending commands to Battle.net.
+ *
+ * See http://classic.battle.net/info/commands.shtml for a list of commands.
+ */
 #ifndef __MSGCMD_H__
 #define __MSGCMD_H__
 

Source/multi.cpp

@@ -1,3 +1,8 @@
+/**
+ * @file multi.cpp
+ *
+ * Implementation of functions for keeping multiplaye games in sync.
+ */
 #include "all.h"
 #include "../3rdParty/Storm/Source/storm.h"
 #include "../DiabloUI/diabloui.h"

Source/multi.h

@@ -1,4 +1,8 @@
-//HEADER_GOES_HERE
+/**
+ * @file multi.h
+ *
+ * Interface of functions for keeping multiplaye games in sync.
+ */
 #ifndef __MULTI_H__
 #define __MULTI_H__
 

Source/player.cpp

@@ -267,7 +267,7 @@ void InitPlrGFXMem(int pnum)
 		if (GetPlrGFXSize("ST") > GetPlrGFXSize("AS")) {
 			plr_sframe_size = GetPlrGFXSize("ST"); //TOWN
 		} else {
-			plr_sframe_size = GetPlrGFXSize("AS"); //DUNGION
+			plr_sframe_size = GetPlrGFXSize("AS"); //DUNGEON
 		}
 	}
 	plr[pnum]._pNData = DiabloAllocPtr(plr_sframe_size);
@@ -277,7 +277,7 @@ void InitPlrGFXMem(int pnum)
 		if (GetPlrGFXSize("WL") > GetPlrGFXSize("AW")) {
 			plr_wframe_size = GetPlrGFXSize("WL"); //TOWN
 		} else {
-			plr_wframe_size = GetPlrGFXSize("AW"); //DUNGION
+			plr_wframe_size = GetPlrGFXSize("AW"); //DUNGEON
 		}
 	}
 	plr[pnum]._pWData = DiabloAllocPtr(plr_wframe_size);

doxygen.config

@@ -1,13 +1,27 @@
 PROJECT_NAME           = "Devilution"
 PROJECT_BRIEF          = "Diablo devolved - magic behind the 1996 computer game"
+USE_MDFILE_AS_MAINPAGE = README.md
 OUTPUT_DIRECTORY       = docs
-INPUT                  = ./ ./Source
+INPUT                  = ./ ./Source ./docs
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.c \
                          *.cpp \
                          *.h \
-                         *.inc
+                         *.inc \
+                         *.md
+
 GENERATE_LATEX         = NO
+WARNINGS               = YES
+SOURCE_BROWSER         = YES
+EXTRACT_STATIC         = YES
+JAVADOC_AUTOBRIEF      = YES
+OPTIMIZE_OUTPUT_FOR_C  = YES
+SEPARATE_MEMBER_PAGES  = YES
+DOT_IMAGE_FORMAT       = svg
+INTERACTIVE_SVG        = YES
+HTML_COLORSTYLE_HUE    = 0
+HTML_COLORSTYLE_SAT    = 125
+HTML_COLORSTYLE_GAMMA  = 200
 
 # Call graphces alows logical navigation of the docs
 CALL_GRAPH             = YES
@@ -16,19 +30,6 @@ CALLER_GRAPH           = YES
 # all.h includes everything and everything inclues it so the graph is usless past depth 1
 MAX_DOT_GRAPH_DEPTH    = 1
 
-SOURCE_BROWSER         = YES
-EXTRACT_STATIC         = YES
-JAVADOC_AUTOBRIEF      = YES
-OPTIMIZE_OUTPUT_FOR_C  = YES
-
-HTML_COLORSTYLE_HUE    = 0
-HTML_COLORSTYLE_SAT    = 125
-HTML_COLORSTYLE_GAMMA  = 200
-HTML_DYNAMIC_SECTIONS  = YES
-
-DOT_IMAGE_FORMAT       = svg
-INTERACTIVE_SVG        = YES
-
 # Not all files are documented yet
 EXTRACT_ALL            = YES
 

enums.h

@@ -1,3 +1,9 @@
+/**
+ * @file enums.h
+ *
+ * Various global enumerators.
+ */
+
 typedef enum item_quality {
 	ITEM_QUALITY_NORMAL = 0,
 	ITEM_QUALITY_MAGIC  = 1,

resource.h

@@ -1,7 +1,10 @@
-//{{NO_DEPENDENCIES}}
-// Microsoft Developer Studio generated include file.
-// Used by Diablo.rc
-//
+/**
+ * @file resource.h
+ *
+ * Microsoft Developer Studio generated include file.
+ * Used by Diablo.rc
+ */
+
 #define IDI_ICON1                       101
 #define IDD_DIALOG1                     104 // DX
 #define IDD_DIALOG2                     105 // NOMEMORY

structs.h

@@ -1,3 +1,9 @@
+/**
+ * @file structs.h
+ *
+ * Various global structures.
+ */
+
 //////////////////////////////////////////////////
 // control
 //////////////////////////////////////////////////

types.h

@@ -1,5 +1,8 @@
-// temporary file
-
+/**
+ * @file types.h
+ *
+ * Include OS headers and set compiler state.
+ */
 #ifndef _TYPES_H
 #define _TYPES_H