commit 77171e708204e38888ad051290a8209b704f7bf2
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Sep 14 10:49:41 2024 -0500
Commit: Fabian Greffrath <fabian@greffrath.com>
CommitDate: Wed Jul 2 08:24:12 2025 +0200
src/*: Rename some metasyntactic variables
1. Use hyphenated phrases for metasyntactic variable names; these are
not C identifiers and do not have to follow the same rules.
2. Favor "file" over "filename"; the former is already used with
greater consistency.
3. Use "W" and "H" to refer to width and height measurements rather
than "x" and "y", for clarity and distinction from other geometric
parameters.
---
src/heretic/d_main.c | 6 +++---
src/hexen/h2_main.c | 6 +++---
src/i_musicpack.c | 2 +-
src/i_video.c | 6 +++---
src/m_argv.c | 2 +-
5 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/src/heretic/d_main.c b/src/heretic/d_main.c
index f6d43af2..a1d7a5e8 100644
--- a/src/heretic/d_main.c
+++ b/src/heretic/d_main.c
@@ -399,7 +399,7 @@ void D_StartTitle(void)
=
= D_CheckRecordFrom
=
-= -recordfrom <savegame num> <demoname>
+= -recordfrom <save-num> <demo-name>
==============
*/
@@ -411,10 +411,10 @@ void D_CheckRecordFrom(void)
//!
// @vanilla
// @category demo
- // @arg <savenum> <demofile>
+ // @arg <save-num> <demo-name>
//
// Record a demo, loading from the given filename. Equivalent
- // to -loadgame <savenum> -record <demofile>.
+ // to -loadgame <save-num> -record <demo-name>.
p = M_CheckParmWithArgs("-recordfrom", 2);
if (!p)
diff --git a/src/hexen/h2_main.c b/src/hexen/h2_main.c
index a3a8d004..8f44ed11 100644
--- a/src/hexen/h2_main.c
+++ b/src/hexen/h2_main.c
@@ -1173,7 +1173,7 @@ void H2_StartTitle(void)
//
// CheckRecordFrom
//
-// -recordfrom <savegame num> <demoname>
+// -recordfrom <save-num> <demo-name>
//
//==========================================================================
@@ -1184,10 +1184,10 @@ static void CheckRecordFrom(void)
//!
// @vanilla
// @category demo
- // @arg <savenum> <demofile>
+ // @arg <save-num> <demo-name>
//
// Record a demo, loading from the given filename. Equivalent
- // to -loadgame <savenum> -record <demofile>.
+ // 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 ab27ba27..6bd3779c 100644
--- a/src/i_musicpack.c
+++ b/src/i_musicpack.c
@@ -1130,7 +1130,7 @@ static boolean I_MP_InitMusic(void)
//!
// @category obscure
- // @arg <filename>
+ // @arg <file>
//
// 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 e14ce970..6ff3b80e 100644
--- a/src/i_video.c
+++ b/src/i_video.c
@@ -1006,7 +1006,7 @@ void I_GraphicsCheckCommandLine(void)
//!
// @category video
- // @arg <x>
+ // @arg <W>
//
// Specify the screen width, in pixels. Implies -window.
//
@@ -1021,7 +1021,7 @@ void I_GraphicsCheckCommandLine(void)
//!
// @category video
- // @arg <y>
+ // @arg <H>
//
// Specify the screen height, in pixels. Implies -window.
//
@@ -1036,7 +1036,7 @@ void I_GraphicsCheckCommandLine(void)
//!
// @category video
- // @arg <WxY>
+ // @arg <WxH>
//
// Specify the dimensions of the window. Implies -window.
//
diff --git a/src/m_argv.c b/src/m_argv.c
index c53578e9..cc43758b 100644
--- a/src/m_argv.c
+++ b/src/m_argv.c
@@ -286,7 +286,7 @@ void M_FindResponseFile(void)
for (;;)
{
//!
- // @arg <filename>
+ // @arg <file>
//
// Load extra command line arguments from the given response file.
// Arguments read from the file will be inserted into the command