commit a8135740a1d0d965e3376a86a517a306f93bb6c1
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Sep 14 11:11:43 2024 -0500
Commit: Fabian Greffrath <fabian@greffrath.com>
CommitDate: Wed Jul 2 08:24:12 2025 +0200
src/*: Recast some option descriptions for clarity
---
src/doom/d_main.c | 2 +-
src/heretic/d_main.c | 6 +++---
src/hexen/h2_main.c | 4 ++--
src/i_musicpack.c | 4 ++--
src/m_argv.c | 8 ++++----
src/strife/d_main.c | 5 +++--
src/w_main.c | 4 +++-
7 files changed, 18 insertions(+), 15 deletions(-)
diff --git a/src/doom/d_main.c b/src/doom/d_main.c
index 410615cb..014e4872 100644
--- a/src/doom/d_main.c
+++ b/src/doom/d_main.c
@@ -1805,7 +1805,7 @@ void D_DoomMain (void)
// @arg <n>
// @vanilla
//
- // Start playing on episode n (1-4).
+ // Start playing episode n (1-4).
//
p = M_CheckParmWithArgs("-episode", 1);
diff --git a/src/heretic/d_main.c b/src/heretic/d_main.c
index a1d7a5e8..9090df83 100644
--- a/src/heretic/d_main.c
+++ b/src/heretic/d_main.c
@@ -413,8 +413,8 @@ void D_CheckRecordFrom(void)
// @category demo
// @arg <save-num> <demo-name>
//
- // Record a demo, loading from the given filename. Equivalent
- // to -loadgame <save-num> -record <demo-name>.
+ // Load a game from the given savegame slot and record a demo from
+ // it. Equivalent to -loadgame <save-num> -record <demo-name>.
p = M_CheckParmWithArgs("-recordfrom", 2);
if (!p)
@@ -809,7 +809,7 @@ void D_DoomMain(void)
// @arg <n>
// @vanilla
//
- // Start playing on episode n (1-4).
+ // Start playing episode n (1-4).
//
p = M_CheckParmWithArgs("-episode", 1);
diff --git a/src/hexen/h2_main.c b/src/hexen/h2_main.c
index 8f44ed11..0a7bff85 100644
--- a/src/hexen/h2_main.c
+++ b/src/hexen/h2_main.c
@@ -1186,8 +1186,8 @@ static void CheckRecordFrom(void)
// @category demo
// @arg <save-num> <demo-name>
//
- // Record a demo, loading from the given filename. Equivalent
- // to -loadgame <save-num> -record <demo-name>.
+ // Load a game from the given savegame slot and record a demo from
+ // it. Equivalent to -loadgame <save-num> -record <demo-name>.
//
p = M_CheckParm("-recordfrom");
if (!p || p > myargc - 2)
diff --git a/src/i_musicpack.c b/src/i_musicpack.c
index 6bd3779c..10a2d164 100644
--- a/src/i_musicpack.c
+++ b/src/i_musicpack.c
@@ -1132,8 +1132,8 @@ static boolean I_MP_InitMusic(void)
// @category obscure
// @arg <file>
//
- // Read all MIDI files from loaded WAD files, dump an example substitution
- // music config file to the specified filename and quit.
+ // Read all MIDI files from loaded WAD files, dump an example
+ // substitution music config file to the specified file, and quit.
//
i = M_CheckParmWithArgs("-dumpsubstconfig", 1);
diff --git a/src/m_argv.c b/src/m_argv.c
index cc43758b..724a42b6 100644
--- a/src/m_argv.c
+++ b/src/m_argv.c
@@ -288,10 +288,10 @@ void M_FindResponseFile(void)
//!
// @arg <file>
//
- // Load extra command line arguments from the given response file.
- // Arguments read from the file will be inserted into the command
- // line replacing this argument. A response file can also be loaded
- // using the abbreviated syntax '@filename.rsp'.
+ // Load extra command-line arguments from the given response
+ // file. Arguments read from the file are inserted into the
+ // command line, replacing this argument. A response file can
+ // also be loaded using the abbreviated syntax '@file.rsp'.
//
i = M_CheckParmWithArgs("-response", 1);
if (i <= 0)
diff --git a/src/strife/d_main.c b/src/strife/d_main.c
index 93966ce7..56372b53 100644
--- a/src/strife/d_main.c
+++ b/src/strife/d_main.c
@@ -1591,7 +1591,8 @@ void D_DoomMain (void)
// @category obscure
// @vanilla
//
- // Set Rogue playtesting mode (godmode, noclip toggled by backspace).
+ // Set Rogue playtesting mode
+ // (god mode; no cliping mode toggled by backspace).
//
workparm = M_CheckParm ("-work");
@@ -1937,7 +1938,7 @@ void D_DoomMain (void)
// // @arg <n>
// // @vanilla
// //
- // // Start playing on episode n (1-4).
+ // // Start playing episode n (1-4).
// //
// p = M_CheckParmWithArgs("-episode", 1);
diff --git a/src/w_main.c b/src/w_main.c
index ab32d9fe..3496fd1d 100644
--- a/src/w_main.c
+++ b/src/w_main.c
@@ -175,7 +175,9 @@ boolean W_ParseCommandLine(void)
// @arg <files>
// @vanilla
//
- // Load the specified PWAD files.
+ // Load the specified PWAD files. Each succeeding argument is
+ // treated as a PWAD file name until one starts with a dash or the
+ // argument list is exhausted.
//
p = M_CheckParmWithArgs ("-file", 1);