refactor(comments): Replace 'compile' with 'build' in project code comments (#1361)

xezon · xezon · commit a41060519332 · 2025-08-05T19:50:22.000+02:00
diff --git a/Core/GameEngine/Include/Common/Debug.h b/Core/GameEngine/Include/Common/Debug.h
@@ -84,7 +84,7 @@ class AsciiString;
 #if defined(ALLOW_DEBUG_UTILS) && !defined(DEBUG_STACKTRACE) && !defined(DISABLE_DEBUG_STACKTRACE)
 	#define DEBUG_STACKTRACE 1
 	#ifndef DEBUG_LOGGING
-		#define DEBUG_LOGGING 1 // TheSuperHackers @compile Stack trace requires logging.
+		#define DEBUG_LOGGING 1 // TheSuperHackers @build Stack trace requires logging.
 	#endif
 #endif
 #if defined(ALLOW_DEBUG_UTILS) && !defined(DEBUG_PROFILE) && !defined(DISABLE_DEBUG_PROFILE)
diff --git a/Core/Libraries/Include/Lib/BaseTypeCore.h b/Core/Libraries/Include/Lib/BaseTypeCore.h
@@ -21,7 +21,7 @@
 //
 // Basic types and constants
 // Author: Michael S. Booth, January 1995, September 2000
-// TheSuperHackers @compile feliwir 11/04/2025 Move common BaseType.h code to BaseTypeCore.h
+// TheSuperHackers @build feliwir 11/04/2025 Move common BaseType.h code to BaseTypeCore.h
 //
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -34,7 +34,7 @@
 
 #include <math.h>
 #include <string.h>
-// TheSuperHackers @compile feliwir 07/04/2025 Adds utility macros for cross-platform compatibility
+// TheSuperHackers @build feliwir 07/04/2025 Adds utility macros for cross-platform compatibility
 #include <Utility/compat.h>
 #include <Utility/CppMacros.h>
 #include <Utility/stdint_adapter.h>
diff --git a/Core/Libraries/Source/WWVegas/WW3D2/soundrobj.h b/Core/Libraries/Source/WWVegas/WW3D2/soundrobj.h
@@ -41,7 +41,7 @@
 #ifndef __SOUNDROBJ_H
 #define __SOUNDROBJ_H
 
-// TheSuperHackers @compile xezon 05/04/2025 Compile in WWAUDIO for Renegade's w3dview tool.
+// TheSuperHackers @build xezon 05/04/2025 Compile in WWAUDIO for Renegade's w3dview tool.
 #define noWWAUDIO 1
 
 #if noWWAUDIO // (gth) removing dependency on WWAUDIO
diff --git a/Core/Libraries/Source/WWVegas/WWLib/CRC.H b/Core/Libraries/Source/WWVegas/WWLib/CRC.H
@@ -42,7 +42,7 @@
 
 #include	<stdlib.h>
 
-// TheSuperHackers @compile feliwir 17/04/2025 include _ltrotl macros
+// TheSuperHackers @build feliwir 17/04/2025 include _ltrotl macros
 #include <Utility/intrin_compat.h>
 
 /*
diff --git a/Core/Libraries/Source/WWVegas/WWLib/always.h b/Core/Libraries/Source/WWVegas/WWLib/always.h
@@ -45,7 +45,7 @@
 #include <assert.h>
 #include <new>
 
-// TheSuperHackers @compile feliwir 17/04/2025 include utility macros for cross-platform compatibility
+// TheSuperHackers @build feliwir 17/04/2025 include utility macros for cross-platform compatibility
 #include <Utility/compat.h>
 #include <Utility/stdint_adapter.h>
 #include <Utility/CppMacros.h>
diff --git a/Core/Libraries/Source/WWVegas/WWLib/rawfile.cpp b/Core/Libraries/Source/WWVegas/WWLib/rawfile.cpp
@@ -51,7 +51,7 @@
  *   RawFileClass::Write -- Writes the specified data to the buffer specified.                 *
  * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 
-// TheSuperHackers @compile feliwir 11/04/2025 We removed Win32 API here and use plain C
+// TheSuperHackers @build feliwir 11/04/2025 We removed Win32 API here and use plain C
 #include	"always.h"
 #include	"RAWFILE.H"
 #include	<stddef.h>
diff --git a/Core/Libraries/Source/WWVegas/WWLib/refcount.cpp b/Core/Libraries/Source/WWVegas/WWLib/refcount.cpp
@@ -41,7 +41,7 @@
 
 #include "refcount.h"
 
-// TheSuperHackers @compile feliwir 17/04/2025 include __debugbreak macros
+// TheSuperHackers @build feliwir 17/04/2025 include __debugbreak macros
 #include <Utility/intrin_compat.h>
 
 #ifndef NDEBUG
diff --git a/Core/Libraries/Source/WWVegas/WWStub/wwallocstub.cpp b/Core/Libraries/Source/WWVegas/WWStub/wwallocstub.cpp
@@ -16,7 +16,7 @@
 **	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-// TheSuperHackers @compile feliwir 15/04/2025 Simple allocator implementation useful for tools
+// TheSuperHackers @build feliwir 15/04/2025 Simple allocator implementation useful for tools
 #include "always.h"
 #include <stdlib.h>
 
diff --git a/Core/Libraries/Source/WWVegas/WWStub/wwdebugstub.cpp b/Core/Libraries/Source/WWVegas/WWStub/wwdebugstub.cpp
@@ -16,7 +16,7 @@
 **	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-// TheSuperHackers @compile feliwir 15/04/2025 Simple debug implementation useful for tools
+// TheSuperHackers @build feliwir 15/04/2025 Simple debug implementation useful for tools
 #include "wwdebug.h"
 #include <stdarg.h>
 #include <stdlib.h>
diff --git a/Core/Tools/Babylon/StdAfx.h b/Core/Tools/Babylon/StdAfx.h
@@ -30,7 +30,7 @@
 
 #define VC_EXTRALEAN		// Exclude rarely-used stuff from Windows headers
 
-// TheSuperHackers @compile xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
+// TheSuperHackers @build xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
 #define _d3d9TYPES_H_
 
 #include <afxwin.h>         // MFC core and standard components
diff --git a/Core/Tools/DebugWindow/StdAfx.h b/Core/Tools/DebugWindow/StdAfx.h
@@ -30,7 +30,7 @@
 
 #define VC_EXTRALEAN		// Exclude rarely-used stuff from Windows headers
 
-// TheSuperHackers @compile xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
+// TheSuperHackers @build xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
 #define _d3d9TYPES_H_
 
 #include <afxwin.h>         // MFC core and standard components
diff --git a/Core/Tools/W3DView/StdAfx.h b/Core/Tools/W3DView/StdAfx.h
@@ -32,7 +32,7 @@
 
 #include "always.h"
 
-// TheSuperHackers @compile jlallas384 05/04/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
+// TheSuperHackers @build jlallas384 05/04/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
 #define _d3d9TYPES_H_
 
 #include <afxwin.h>         // MFC core and standard components
diff --git a/Core/Tools/mangler/wlib/configfile.cpp b/Core/Tools/mangler/wlib/configfile.cpp
@@ -114,7 +114,7 @@ bit8 ConfigFile::readFile(FILE *in)
     value.truncate('\n');
     value.truncate('#');
 
-    // TheSuperHackers @compile xezon 25/03/2025 Re-implement algorithm to avoid writing into string buffer directly.
+    // TheSuperHackers @build xezon 25/03/2025 Re-implement algorithm to avoid writing into string buffer directly.
     // Remove trailing spaces
     {
       const char* valueStr = value.get();
diff --git a/Core/Tools/matchbot/wlib/configfile.cpp b/Core/Tools/matchbot/wlib/configfile.cpp
@@ -114,7 +114,7 @@ bit8 ConfigFile::readFile(FILE *in)
     value.truncate('\n');
     value.truncate('#');
 
-    // TheSuperHackers @compile xezon 25/03/2025 Re-implement algorithm to avoid writing into string buffer directly.
+    // TheSuperHackers @build xezon 25/03/2025 Re-implement algorithm to avoid writing into string buffer directly.
     // Remove trailing spaces
     {
       const char* valueStr = value.get();
diff --git a/Generals/Code/GameEngine/Include/Common/GameMemory.h b/Generals/Code/GameEngine/Include/Common/GameMemory.h
@@ -179,7 +179,7 @@
 
 #endif // MEMORYPOOL_DEBUG
 
-// TheSuperHackers @compile xezon 30/03/2025 Define DISABLE_GAMEMEMORY to use a null implementations for Game Memory.
+// TheSuperHackers @build xezon 30/03/2025 Define DISABLE_GAMEMEMORY to use a null implementations for Game Memory.
 // Useful for address sanitizer checks and other investigations.
 // Is included below the macros so that memory pool debug code can still be used.
 #ifdef DISABLE_GAMEMEMORY
diff --git a/Generals/Code/GameEngine/Include/GameClient/AnimateWindowManager.h b/Generals/Code/GameEngine/Include/GameClient/AnimateWindowManager.h
@@ -95,7 +95,7 @@ enum AnimTypes CPP_11(: Int)
 } ;
 
 //-----------------------------------------------------------------------------
-// TheSuperHackers @compile xezon 14/03/2025 Puts class into namespace to avoid name collision with AnimateWindow function in WinUser.h
+// TheSuperHackers @build xezon 14/03/2025 Puts class into namespace to avoid name collision with AnimateWindow function in WinUser.h
 namespace wnd
 {
 class AnimateWindow : public MemoryPoolObject
diff --git a/Generals/Code/GameEngine/Include/GameLogic/AI.h b/Generals/Code/GameEngine/Include/GameLogic/AI.h
@@ -312,7 +312,7 @@ class Waypoint;
 class Team;
 class Weapon;
 
-// TheSuperHackers @compile xezon 22/03/2025 Renames AI_PASSIVE to not conflict with macro in ws2def.h
+// TheSuperHackers @build xezon 22/03/2025 Renames AI_PASSIVE to not conflict with macro in ws2def.h
 
 // Note - written out in save/load xfer and .map files, don't change these numbers.  
 enum AttitudeType CPP_11(: Int) {
diff --git a/Generals/Code/GameEngine/Include/GameLogic/ScriptEngine.h b/Generals/Code/GameEngine/Include/GameLogic/ScriptEngine.h
@@ -122,7 +122,7 @@ typedef AllObjectTypes::iterator AllObjectTypesIt;
 typedef std::vector<NamedReveal> VecNamedReveal;
 typedef VecNamedReveal::iterator VecNamedRevealIt;
 
-// TheSuperHackers @compile xezon 17/03/2025 Fixes destructor visibility by removing MemoryPoolObject base class.
+// TheSuperHackers @build xezon 17/03/2025 Fixes destructor visibility by removing MemoryPoolObject base class.
 // MemoryPoolObject looks to be unnecessary because it is never dynamically allocated.
 class AttackPriorityInfo : public Snapshot
 {
diff --git a/Generals/Code/Libraries/Include/Lib/BaseType.h b/Generals/Code/Libraries/Include/Lib/BaseType.h
@@ -68,7 +68,7 @@ inline Real deg2rad(Real rad) { return rad * (PI/180); }
 //-----------------------------------------------------------------------------
 // For twiddling bits
 //-----------------------------------------------------------------------------
-// TheSuperHackers @compile xezon 22/03/2025 Renames BitTest to BitIsSet to prevent conflict with BitTest macro from winnt.h
+// TheSuperHackers @build xezon 22/03/2025 Renames BitTest to BitIsSet to prevent conflict with BitTest macro from winnt.h
 #define BitIsSet( x, i ) ( ( (x) & (i) ) != 0 )
 #define BitSet( x, i ) ( (x) |= (i) )
 #define BitClear( x, i ) ( (x ) &= ~(i) )
diff --git a/Generals/Code/Tools/ParticleEditor/StdAfx.h b/Generals/Code/Tools/ParticleEditor/StdAfx.h
@@ -30,7 +30,7 @@
 
 #define VC_EXTRALEAN		// Exclude rarely-used stuff from Windows headers
 
-// TheSuperHackers @compile xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
+// TheSuperHackers @build xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
 #define _d3d9TYPES_H_
 
 #include <afxwin.h>         // MFC core and standard components
diff --git a/Generals/Code/Tools/WorldBuilder/include/StdAfx.h b/Generals/Code/Tools/WorldBuilder/include/StdAfx.h
@@ -34,7 +34,7 @@
 // To prevent pragma errors.
 #include "Lib/BaseType.h"
 
-// TheSuperHackers @compile xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
+// TheSuperHackers @build xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
 #define _d3d9TYPES_H_
 
 #include <afxwin.h>         // MFC core and standard components
diff --git a/GeneralsMD/Code/GameEngine/Include/Common/GameMemory.h b/GeneralsMD/Code/GameEngine/Include/Common/GameMemory.h
@@ -179,7 +179,7 @@
 
 #endif // MEMORYPOOL_DEBUG
 
-// TheSuperHackers @compile xezon 30/03/2025 Define DISABLE_GAMEMEMORY to use a null implementations for Game Memory.
+// TheSuperHackers @build xezon 30/03/2025 Define DISABLE_GAMEMEMORY to use a null implementations for Game Memory.
 // Useful for address sanitizer checks and other investigations.
 // Is included below the macros so that memory pool debug code can still be used.
 #ifdef DISABLE_GAMEMEMORY
diff --git a/GeneralsMD/Code/GameEngine/Include/GameClient/AnimateWindowManager.h b/GeneralsMD/Code/GameEngine/Include/GameClient/AnimateWindowManager.h
@@ -95,7 +95,7 @@ enum AnimTypes CPP_11(: Int)
 } ;
 
 //-----------------------------------------------------------------------------
-// TheSuperHackers @compile xezon 14/03/2025 Puts class into namespace to avoid name collision with AnimateWindow function in WinUser.h
+// TheSuperHackers @build xezon 14/03/2025 Puts class into namespace to avoid name collision with AnimateWindow function in WinUser.h
 namespace wnd
 {
 class AnimateWindow : public MemoryPoolObject
diff --git a/GeneralsMD/Code/GameEngine/Include/GameLogic/AI.h b/GeneralsMD/Code/GameEngine/Include/GameLogic/AI.h
@@ -319,7 +319,7 @@ class Waypoint;
 class Team;
 class Weapon;
 
-// TheSuperHackers @compile xezon 17/03/2025 Renames AI_PASSIVE to not conflict with macro in ws2def.h
+// TheSuperHackers @build xezon 17/03/2025 Renames AI_PASSIVE to not conflict with macro in ws2def.h
 
 // Note - written out in save/load xfer and .map files, don't change these numbers.  
 enum AttitudeType CPP_11(: Int)
diff --git a/GeneralsMD/Code/GameEngine/Include/GameLogic/ScriptEngine.h b/GeneralsMD/Code/GameEngine/Include/GameLogic/ScriptEngine.h
@@ -122,7 +122,7 @@ typedef AllObjectTypes::iterator AllObjectTypesIt;
 typedef std::vector<NamedReveal> VecNamedReveal;
 typedef VecNamedReveal::iterator VecNamedRevealIt;
 
-// TheSuperHackers @compile xezon 17/03/2025 Fixes destructor visibility by removing MemoryPoolObject base class.
+// TheSuperHackers @build xezon 17/03/2025 Fixes destructor visibility by removing MemoryPoolObject base class.
 // MemoryPoolObject looks to be unnecessary because it is never dynamically allocated.
 class AttackPriorityInfo : public Snapshot
 {
diff --git a/GeneralsMD/Code/Libraries/Include/Lib/BaseType.h b/GeneralsMD/Code/Libraries/Include/Lib/BaseType.h
@@ -68,7 +68,7 @@ inline Real deg2rad(Real rad) { return rad * (PI/180); }
 //-----------------------------------------------------------------------------
 // For twiddling bits
 //-----------------------------------------------------------------------------
-// TheSuperHackers @compile xezon 17/03/2025 Renames BitTest to BitIsSet to prevent conflict with BitTest macro from winnt.h
+// TheSuperHackers @build xezon 17/03/2025 Renames BitTest to BitIsSet to prevent conflict with BitTest macro from winnt.h
 #define BitIsSet( x, i ) ( ( (x) & (i) ) != 0 )
 #define BitSet( x, i ) ( (x) |= (i) )
 #define BitClear( x, i ) ( (x ) &= ~(i) )
diff --git a/GeneralsMD/Code/Libraries/Source/WWVegas/WW3D2/shdlib.h b/GeneralsMD/Code/Libraries/Source/WWVegas/WW3D2/shdlib.h
@@ -39,7 +39,7 @@
 #ifndef SHDLIB_H
 #define SHDLIB_H
 
-// TheSuperHackers @compile Removes the unused WWShade code. (#596)
+// TheSuperHackers @build Removes the unused WWShade code. (#596)
 // If there is a desire to revive this, then the WWShade library needs to be re-added.
 
 #ifdef USE_WWSHADE
diff --git a/GeneralsMD/Code/Tools/ParticleEditor/StdAfx.h b/GeneralsMD/Code/Tools/ParticleEditor/StdAfx.h
@@ -30,7 +30,7 @@
 
 #define VC_EXTRALEAN		// Exclude rarely-used stuff from Windows headers
 
-// TheSuperHackers @compile xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
+// TheSuperHackers @build xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
 #define _d3d9TYPES_H_
 
 #include <afxwin.h>         // MFC core and standard components
diff --git a/GeneralsMD/Code/Tools/WorldBuilder/include/StdAfx.h b/GeneralsMD/Code/Tools/WorldBuilder/include/StdAfx.h
@@ -34,7 +34,7 @@
 // To prevent pragma errors.
 #include "Lib/BaseType.h"
 
-// TheSuperHackers @compile xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
+// TheSuperHackers @build xezon 24/03/2025 Prevent afxwin.h from loading d3d9types.h, colliding with our own DirectX library.
 #define _d3d9TYPES_H_
 
 #include <afxwin.h>         // MFC core and standard components
