shithub: choc

Download patch

ref: 02c7144d97be44cc37dbcaeea27ab47cf79b7575
parent: e132bd497bbd153e369bfa9e9d83cbc1f0702dab
author: Simon Howard <fraggle@soulsphere.org>
date: Sun Jun 12 20:43:59 EDT 2016 

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.


--- a/src/doom/d_main.c
+++ b/src/doom/d_main.c
@@ -813,6 +813,7 @@
         // with Freedoom and get the right level names.
 
         //!
+        // @category compat
         // @arg <pack>
         //
         // Explicitly specify a Doom II "mission pack" to run as, instead of
--- a/src/doom/g_game.c
+++ b/src/doom/g_game.c
@@ -2219,12 +2219,13 @@
 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; 
--- a/src/i_sdlmusic.c
+++ b/src/i_sdlmusic.c
@@ -922,7 +922,7 @@
 #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.
--- a/src/i_video.c
+++ b/src/i_video.c
@@ -1430,12 +1430,13 @@
     int i;
 
     //!
+    // @category video
     // @vanilla
     //
     // Disable blitting the screen.
     //
 
-    noblit = M_CheckParm ("-noblit"); 
+    noblit = M_CheckParm ("-noblit");
 
     //!
     // @category video 
--- a/src/net_server.c
+++ b/src/net_server.c
@@ -1345,6 +1345,7 @@
     querydata.gamemission = sv_gamemission;
 
     //!
+    // @category net
     // @arg <name>
     //
     // When starting a network server, specify a name for the server.
@@ -1785,10 +1786,10 @@
 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"))
--- a/src/strife/g_game.c
+++ b/src/strife/g_game.c
@@ -2380,7 +2380,8 @@
 void G_TimeDemo (char* name) 
 {
     //!
-    // @vanilla 
+    // @category video
+    // @vanilla
     //
     // Disable rendering the screen entirely.
     //
--- a/src/z_zone.c
+++ b/src/z_zone.c
@@ -122,13 +122,13 @@
 
     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.
     //