commit 02c7144d97be44cc37dbcaeea27ab47cf79b7575
Author: Simon Howard <fraggle@soulsphere.org>
AuthorDate: Mon Jun 13 00:43:59 2016 -0400
Commit: Simon Howard <fraggle@soulsphere.org>
CommitDate: Mon Jun 13 00:43:59 2016 -0400
Set categories for some command line args.
The "General" section has become rather cluttered and some of these
belong in specific categories. Remove a couple of z_zone.c debugging
arguments which don't really belong in user documentation.
---
src/doom/d_main.c | 1 +
src/doom/g_game.c | 5 +++--
src/i_sdlmusic.c | 2 +-
src/i_video.c | 3 ++-
src/net_server.c | 5 +++--
src/strife/g_game.c | 3 ++-
src/z_zone.c | 4 ++--
7 files changed, 14 insertions(+), 9 deletions(-)
diff --git a/src/doom/d_main.c b/src/doom/d_main.c
index 1b708381..0ffd56d3 100644
--- a/src/doom/d_main.c
+++ b/src/doom/d_main.c
@@ -813,6 +813,7 @@ void D_IdentifyVersion(void)
// with Freedoom and get the right level names.
//!
+ // @category compat
// @arg <pack>
//
// Explicitly specify a Doom II "mission pack" to run as, instead of
diff --git a/src/doom/g_game.c b/src/doom/g_game.c
index 72dd9ad1..a4c91b91 100644
--- a/src/doom/g_game.c
+++ b/src/doom/g_game.c
@@ -2219,12 +2219,13 @@ void G_DoPlayDemo (void)
void G_TimeDemo (char* name)
{
//!
- // @vanilla
+ // @category video
+ // @vanilla
//
// Disable rendering the screen entirely.
//
- nodrawers = M_CheckParm ("-nodraw");
+ nodrawers = M_CheckParm ("-nodraw");
timingdemo = true;
singletics = true;
diff --git a/src/i_sdlmusic.c b/src/i_sdlmusic.c
index 416fbf95..ca04218c 100644
--- a/src/i_sdlmusic.c
+++ b/src/i_sdlmusic.c
@@ -922,7 +922,7 @@ static boolean I_SDL_InitMusic(void)
#endif
//!
- // @arg <output filename>
+ // @arg <filename>
//
// Read all MIDI files from loaded WAD files, dump an example substitution
// music config file to the specified filename and quit.
diff --git a/src/i_video.c b/src/i_video.c
index 8004b539..e454aedd 100644
--- a/src/i_video.c
+++ b/src/i_video.c
@@ -1430,12 +1430,13 @@ void I_GraphicsCheckCommandLine(void)
int i;
//!
+ // @category video
// @vanilla
//
// Disable blitting the screen.
//
- noblit = M_CheckParm ("-noblit");
+ noblit = M_CheckParm ("-noblit");
//!
// @category video
diff --git a/src/net_server.c b/src/net_server.c
index b3ec1693..885fffd8 100644
--- a/src/net_server.c
+++ b/src/net_server.c
@@ -1345,6 +1345,7 @@ void NET_SV_SendQueryResponse(net_addr_t *addr)
querydata.gamemission = sv_gamemission;
//!
+ // @category net
// @arg <name>
//
// When starting a network server, specify a name for the server.
@@ -1785,11 +1786,11 @@ static void UpdateMasterServer(void)
void NET_SV_RegisterWithMaster(void)
{
//!
+ // @category net
+ //
// When running a server, don't register with the global master server.
// Implies -server.
//
- // @category net
- //
if (!M_CheckParm("-privateserver"))
{
diff --git a/src/strife/g_game.c b/src/strife/g_game.c
index af438880..e238b0ca 100644
--- a/src/strife/g_game.c
+++ b/src/strife/g_game.c
@@ -2380,7 +2380,8 @@ void G_DoPlayDemo (void)
void G_TimeDemo (char* name)
{
//!
- // @vanilla
+ // @category video
+ // @vanilla
//
// Disable rendering the screen entirely.
//
diff --git a/src/z_zone.c b/src/z_zone.c
index f88e3f02..828fd7eb 100644
--- a/src/z_zone.c
+++ b/src/z_zone.c
@@ -122,13 +122,13 @@ void Z_Init (void)
block->size = mainzone->size - sizeof(memzone_t);
- //!
+ // [Deliberately undocumented]
// Zone memory debugging flag. If set, memory is zeroed after it is freed
// to deliberately break any code that attempts to use it after free.
//
zero_on_free = M_ParmExists("-zonezero");
- //!
+ // [Deliberately undocumented]
// Zone memory debugging flag. If set, each time memory is freed, the zone
// heap is scanned to look for remaining pointers to the freed block.
//