diff --git a/Source/automap.cpp b/Source/automap.cpp index 6f64b0692..d94d87bb0 100644 --- a/Source/automap.cpp +++ b/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" diff --git a/Source/automap.h b/Source/automap.h index 22ccfaa78..219b0e74b 100644 --- a/Source/automap.h +++ b/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__ diff --git a/Source/gamemenu.cpp b/Source/gamemenu.cpp index 2e385b0bb..16a14434f 100644 --- a/Source/gamemenu.cpp +++ b/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" diff --git a/Source/gamemenu.h b/Source/gamemenu.h index a6ad2f1ce..55ca4c409 100644 --- a/Source/gamemenu.h +++ b/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__ diff --git a/Source/gendung.cpp b/Source/gendung.cpp index 9061e1f9f..2f321f708 100644 --- a/Source/gendung.cpp +++ b/Source/gendung.cpp @@ -1,3 +1,8 @@ +/** + * @file gendung.cpp + * + * Implementation of general dungeon generation code. + */ #include "all.h" WORD level_frame_types[MAXTILES]; diff --git a/Source/gendung.h b/Source/gendung.h index b423c2abe..a32db1f57 100644 --- a/Source/gendung.h +++ b/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__ diff --git a/Source/gmenu.cpp b/Source/gmenu.cpp index c13c76765..3ba56654a 100644 --- a/Source/gmenu.cpp +++ b/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" diff --git a/Source/gmenu.h b/Source/gmenu.h index 1d0490d37..8cdb3878c 100644 --- a/Source/gmenu.h +++ b/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__ diff --git a/Source/help.cpp b/Source/help.cpp index 69b166bf7..60f5ca4ec 100644 --- a/Source/help.cpp +++ b/Source/help.cpp @@ -1,3 +1,8 @@ +/** + * @file help.cpp + * + * Implementation of the in-game help text. + */ #include "all.h" int help_select_line; diff --git a/Source/help.h b/Source/help.h index cb536b9b9..52fb3bf36 100644 --- a/Source/help.h +++ b/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__ diff --git a/Source/init.cpp b/Source/init.cpp index d57d91380..338374fbb 100644 --- a/Source/init.cpp +++ b/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" diff --git a/Source/init.h b/Source/init.h index 76809088b..6867b23b4 100644 --- a/Source/init.h +++ b/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__ diff --git a/Source/interfac.cpp b/Source/interfac.cpp index be837929b..c5be1d437 100644 --- a/Source/interfac.cpp +++ b/Source/interfac.cpp @@ -1,3 +1,8 @@ +/** + * @file interfac.cpp + * + * Implementation of load screens. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/interfac.h b/Source/interfac.h index 5049b2b1f..a88a864ea 100644 --- a/Source/interfac.h +++ b/Source/interfac.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file interfac.h + * + * Interface of load screens. + */ #ifndef __INTERFAC_H__ #define __INTERFAC_H__ diff --git a/Source/inv.cpp b/Source/inv.cpp index b867a1548..a385832a8 100644 --- a/Source/inv.cpp +++ b/Source/inv.cpp @@ -1,3 +1,8 @@ +/** + * @file inv.cpp + * + * Implementation of player inventory. + */ #include "all.h" BOOL invflag; diff --git a/Source/inv.h b/Source/inv.h index 0ef9c39ca..f236172c6 100644 --- a/Source/inv.h +++ b/Source/inv.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file inv.h + * + * Interface of player inventory. + */ #ifndef __INV_H__ #define __INV_H__ diff --git a/Source/itemdat.cpp b/Source/itemdat.cpp index 887ab8b77..ee9c14337 100644 --- a/Source/itemdat.cpp +++ b/Source/itemdat.cpp @@ -1,3 +1,8 @@ +/** + * @file itemdat.cpp + * + * Implementation of all item data. + */ #include "all.h" ItemDataStruct AllItemsList[] = { diff --git a/Source/itemdat.h b/Source/itemdat.h index e84ce0c9f..7d038985d 100644 --- a/Source/itemdat.h +++ b/Source/itemdat.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file itemdat.h + * + * Interface of all item data. + */ #ifndef __ITEMDAT_H__ #define __ITEMDAT_H__ diff --git a/Source/items.cpp b/Source/items.cpp index 230da0427..da10da3d2 100644 --- a/Source/items.cpp +++ b/Source/items.cpp @@ -1,3 +1,8 @@ +/** + * @file items.cpp + * + * Implementation of item functionality. + */ #include "all.h" int itemactive[MAXITEMS]; diff --git a/Source/items.h b/Source/items.h index 4440b0e84..729761e96 100644 --- a/Source/items.h +++ b/Source/items.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file items.h + * + * Interface of item functionality. + */ #ifndef __ITEMS_H__ #define __ITEMS_H__ diff --git a/Source/loadsave.cpp b/Source/loadsave.cpp index cbbf4ebc9..a3dde56ca 100644 --- a/Source/loadsave.cpp +++ b/Source/loadsave.cpp @@ -1,3 +1,8 @@ +/** + * @file loadsave.cpp + * + * Implementation of save game functionality. + */ #include "all.h" BYTE *tbuff; diff --git a/Source/loadsave.h b/Source/loadsave.h index 71309f5fe..376d4af36 100644 --- a/Source/loadsave.h +++ b/Source/loadsave.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file loadsave.h + * + * Interface of save game functionality. + */ #ifndef __LOADSAVE_H__ #define __LOADSAVE_H__ diff --git a/Source/logging.cpp b/Source/logging.cpp index cffa639ec..a3fb3043b 100644 --- a/Source/logging.cpp +++ b/Source/logging.cpp @@ -1,3 +1,8 @@ +/** + * @file logging.cpp + * + * Implementation of logging functionality. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/logging.h b/Source/logging.h index 13b0ec7c0..b88d8e42e 100644 --- a/Source/logging.h +++ b/Source/logging.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file logging.h + * + * Interface of logging functionality. + */ #ifndef __LOGGING_H__ #define __LOGGING_H__ diff --git a/Source/mainmenu.cpp b/Source/mainmenu.cpp index d9eec3351..57b2f6a51 100644 --- a/Source/mainmenu.cpp +++ b/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" diff --git a/Source/mainmenu.h b/Source/mainmenu.h index c2bc0dd63..dc0ddb341 100644 --- a/Source/mainmenu.h +++ b/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__ diff --git a/Source/minitext.cpp b/Source/minitext.cpp index 4ef780a1d..c89d31251 100644 --- a/Source/minitext.cpp +++ b/Source/minitext.cpp @@ -1,3 +1,8 @@ +/** + * @file minitext.cpp + * + * Implementation of scrolling dialog text. + */ #include "all.h" int qtexty; diff --git a/Source/minitext.h b/Source/minitext.h index 3be2aeea6..568e51b6f 100644 --- a/Source/minitext.h +++ b/Source/minitext.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file minitext.h + * + * Interface of scrolling dialog text. + */ #ifndef __MINITEXT_H__ #define __MINITEXT_H__ diff --git a/Source/misdat.cpp b/Source/misdat.cpp index 49cc10342..7f222ae5b 100644 --- a/Source/misdat.cpp +++ b/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. */ diff --git a/Source/misdat.h b/Source/misdat.h index d32f8173c..bab38abd1 100644 --- a/Source/misdat.h +++ b/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__ diff --git a/Source/missiles.cpp b/Source/missiles.cpp index 517b2ac29..410ca94c6 100644 --- a/Source/missiles.cpp +++ b/Source/missiles.cpp @@ -1,3 +1,8 @@ +/** + * @file missiles.cpp + * + * Implementation of missile functionality. + */ #include "all.h" int missileactive[MAXMISSILES]; diff --git a/Source/missiles.h b/Source/missiles.h index 64e45c1ab..ddd67ec96 100644 --- a/Source/missiles.h +++ b/Source/missiles.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file missiles.h + * + * Interface of missile functionality. + */ #ifndef __MISSILES_H__ #define __MISSILES_H__ diff --git a/Source/monstdat.cpp b/Source/monstdat.cpp index c9bed9968..cfb50b5c2 100644 --- a/Source/monstdat.cpp +++ b/Source/monstdat.cpp @@ -1,3 +1,8 @@ +/** + * @file monstdat.cpp + * + * Implementation of all monster data. + */ #include "all.h" MonsterData monsterdata[] = { diff --git a/Source/monstdat.h b/Source/monstdat.h index 9d0312692..2a4e845c5 100644 --- a/Source/monstdat.h +++ b/Source/monstdat.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file monstdat.h + * + * Interface of all monster data. + */ #ifndef __MONSTDAT_H__ #define __MONSTDAT_H__ diff --git a/Source/movie.cpp b/Source/movie.cpp index 75fb47917..d9058671e 100644 --- a/Source/movie.cpp +++ b/Source/movie.cpp @@ -1,3 +1,8 @@ +/** + * @file movie.cpp + * + * Implementation of video playback. + */ #include "all.h" #include "../3rdParty/Storm/Source/storm.h" diff --git a/Source/movie.h b/Source/movie.h index 03fcab32b..f61ba7891 100644 --- a/Source/movie.h +++ b/Source/movie.h @@ -1,4 +1,8 @@ -//HEADER_GOES_HERE +/** + * @file movie.h + * + * Interface of video playback. + */ #ifndef __MOVIE_H__ #define __MOVIE_H__ diff --git a/Source/mpqapi.cpp b/Source/mpqapi.cpp index 2bdcbfc6f..6c88bff4f 100644 --- a/Source/mpqapi.cpp +++ b/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" diff --git a/Source/mpqapi.h b/Source/mpqapi.h index 9afe8fe96..ff6e61129 100644 --- a/Source/mpqapi.h +++ b/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__ diff --git a/Source/msg.cpp b/Source/msg.cpp index 7d2a27e63..c9415318e 100644 --- a/Source/msg.cpp +++ b/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" diff --git a/Source/msg.h b/Source/msg.h index 3b2123f43..81d581765 100644 --- a/Source/msg.h +++ b/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__ diff --git a/Source/msgcmd.cpp b/Source/msgcmd.cpp index 26bd5bbb7..6cba271a2 100644 --- a/Source/msgcmd.cpp +++ b/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 // for placement new #include // for offsetof #include // for typeid diff --git a/Source/msgcmd.h b/Source/msgcmd.h index be57db0f1..db3b451e9 100644 --- a/Source/msgcmd.h +++ b/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__ diff --git a/Source/multi.cpp b/Source/multi.cpp index 75da357f6..d03d8b062 100644 --- a/Source/multi.cpp +++ b/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" diff --git a/Source/multi.h b/Source/multi.h index 08c102602..73cae2807 100644 --- a/Source/multi.h +++ b/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__ diff --git a/Source/player.cpp b/Source/player.cpp index c324b3a69..befb421b5 100644 --- a/Source/player.cpp +++ b/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); diff --git a/doxygen.config b/doxygen.config index 47dd195f7..6e90f7460 100644 --- a/doxygen.config +++ b/doxygen.config @@ -1,33 +1,34 @@ 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 -GENERATE_LATEX = NO - -# Call graphces alows logical navigation of the docs -CALL_GRAPH = YES -CALLER_GRAPH = YES - -# all.h includes everything and everything inclues it so the graph is usless past depth 1 -MAX_DOT_GRAPH_DEPTH = 1 + *.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 -HTML_DYNAMIC_SECTIONS = YES -DOT_IMAGE_FORMAT = svg -INTERACTIVE_SVG = YES +# Call graphces alows logical navigation of the docs +CALL_GRAPH = YES +CALLER_GRAPH = YES + +# all.h includes everything and everything inclues it so the graph is usless past depth 1 +MAX_DOT_GRAPH_DEPTH = 1 # Not all files are documented yet EXTRACT_ALL = YES diff --git a/enums.h b/enums.h index f54f3f791..257cb5325 100644 --- a/enums.h +++ b/enums.h @@ -1,3 +1,9 @@ +/** + * @file enums.h + * + * Various global enumerators. + */ + typedef enum item_quality { ITEM_QUALITY_NORMAL = 0, ITEM_QUALITY_MAGIC = 1, diff --git a/resource.h b/resource.h index c04cac6c6..962c28389 100644 --- a/resource.h +++ b/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 diff --git a/structs.h b/structs.h index 0a04b4595..e80eccfd2 100644 --- a/structs.h +++ b/structs.h @@ -1,3 +1,9 @@ +/** + * @file structs.h + * + * Various global structures. + */ + ////////////////////////////////////////////////// // control ////////////////////////////////////////////////// diff --git a/types.h b/types.h index 5b51454d8..6553268dc 100644 --- a/types.h +++ b/types.h @@ -1,5 +1,8 @@ -// temporary file - +/** + * @file types.h + * + * Include OS headers and set compiler state. + */ #ifndef _TYPES_H #define _TYPES_H