docs: Fix spelling errors in GeneralsMD/Code/GameEngine comments #2146

bobtista · 2026-01-18T23:56:43Z

Fix spelling errors in code comments.

greptile-apps · 2026-01-18T23:59:15Z

Greptile Summary

This PR corrects spelling errors in code comments across 69 files in the GeneralsMD/Code/GameEngine directory. All changes are documentation-only and do not affect code logic or functionality.

Key corrections made:

Fixed common misspellings: extention→extension (18 occurrences in AIDock.cpp), heigh→height, dum→dump, wont→won't, thise→those
Corrected technical terms: implemtation→implementation, propogated→propagated, heirarchy→hierarchy
Fixed grammar: nevers→never, carraige→carriage, theres→there
Improved clarity: debuggin→debugging, widnow→window, compaired→compared

The corrections span across include headers, source files for AI systems, game logic, GUI components, and object behaviors. All 138 line changes are purely cosmetic improvements to comment readability.

Confidence Score: 5/5

This PR is completely safe to merge with zero risk
All changes are exclusively to code comments with no modifications to executable code, logic, or functionality. Spelling corrections improve documentation quality without any possibility of introducing bugs or runtime issues.
No files require special attention

Important Files Changed

Filename	Overview
GeneralsMD/Code/GameEngine/Include/GameClient/GameWindow.h	Fixed 7 spelling errors in comments: propagated, additional, system, hierarchy, point, child, parameter, regardless
GeneralsMD/Code/GameEngine/Source/GameLogic/AI/AIDock.cpp	Fixed repeated spelling error 'extention' to 'extension' in 18 comments throughout docking behavior states
GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp	Fixed 10 spelling errors: definitely, never (2x), implementation (2x), those, and grammatical corrections
GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GameWindowManager.cpp	Fixed 7 spelling errors: status, propagate, debugging, window, compared, initialize (2x), lengths
GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/AIUpdate/RailroadGuideAIUpdate.cpp	Fixed 6 spelling errors: won't, building, resetting, carriage (3x), there

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Tool as Spell Checker
    participant Code as Codebase
    
    Dev->>Tool: Run spelling check on comments
    Tool->>Code: Scan 69 files in GeneralsMD/Code/GameEngine
    Code-->>Tool: Return misspellings found
    
    Note over Tool: Common errors identified:<br/>extention→extension (18x)<br/>heigh→height<br/>dum→dump<br/>wont→won't<br/>thise→those
    
    Tool->>Code: Apply corrections to comments only
    Code-->>Dev: 138 lines corrected
    
    Note over Code: No functional changes<br/>Comments only<br/>Safe to merge

greptile-apps

_{105 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp

Generals/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBarCommand.cpp

Generals/Code/GameEngine/Source/GameClient/GUI/GameWindowManager.cpp

Generals/Code/GameEngine/Source/GameClient/GameClient.cpp

Generals/Code/GameEngine/Source/GameClient/InGameUI.cpp

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/KeyboardOptionsMenu.cpp

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Behavior/BunkerBusterBehavior.cpp

Stubbjax · 2026-01-19T00:36:45Z

GeneralsMD/Code/GameEngine/Include/GameLogic/PartitionManager.h


 	/// A convenience function to reveal shroud at some location
-	// Queueing does not give you control of the timestamp to enforce the queue.  I own the delay, you don't.
+	// Queuing does not give you control of the timestamp to enforce the queue.  I own the delay, you don't.


Both spellings are technically correct.

Whichever doesn't make Xezon's IDE complain then? :)

Although not exclusively, queuing aligns more to American English, while queueing is used more in British English.
We use American English as that was the language that EA used. So I would say this change is correct.

GeneralsMD/Code/GameEngine/Include/GameClient/GameWindow.h

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/SpecialPower/SpecialPowerModule.cpp

xezon · 2026-01-19T21:57:15Z

It looks like not all Stubbjax comments are addressed.

bobtista · 2026-01-19T22:09:58Z

It looks like not all Stubbjax comments are addressed.

addressed and rebased main

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp

Stubbjax · 2026-01-19T23:57:39Z

Generals/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBarCommand.cpp

 			//
 			// since we're assuming all inventory exit commands appear in a continuous order,
-			// we need to also need to keep track of what is the last valid inventory commadn index
+			// we need to also need to keep track of what is the last valid inventory command index


Remove duplicate instance of 'need to'.

typos.toml

xezon · 2026-01-20T18:16:28Z

@Stubbjax happy with this?

Stubbjax · 2026-01-21T07:31:00Z

@Stubbjax happy with this?

There are still a few unresolved comments.

Skyaero42 · 2026-01-21T10:01:39Z

Core/GameEngine/Include/Common/AudioEventRTS.h

 	AsciiString m_decayName;				///< This is the filename that should be used during the decay.

 	AudioPriority m_priority;				///< This should be the priority as given by the event info, or the overrided priority.
 	Real m_volume;									///< This is the override for the volume. It will either be the normal


"It will either be the normal" is an unfinished sentence

Fixed in 2147 (core)

Skyaero42 · 2026-01-21T10:03:25Z

Core/GameEngine/Include/GameNetwork/LANGameInfo.h


 /**
  * LANGameInfo class - maintains information about the LAN game and
 	* the contents of its slot list hroughout the game.


fixed in 2147 (core)

Skyaero42 · 2026-01-21T10:06:23Z

Core/GameEngineDevice/Include/W3DDevice/GameClient/W3DTerrainVisual.h

 	virtual void enableWaterGrid( Bool enable );
 	/// set min/max height values allowed in water grid pointed to by waterTable
 	virtual void setWaterGridHeightClamps( const WaterHandle *waterTable, Real minZ, Real maxZ );
 	/// adjust fallof parameters for grid change method


fixed in 2147 (Core)

Skyaero42 · 2026-01-21T10:08:34Z

Generals/Code/GameEngine/Include/Common/StatsCollector.h

 	StatsCollector( void );
 	~StatsCollector( void );

 	void reset( void );							///< Reset's all values and writes the file header


fixed in 2145 (Generals)

Skyaero42 · 2026-01-21T10:10:19Z

Generals/Code/GameEngine/Include/GameClient/ParticleSys.h


 	UnsignedInt				m_startTimestamp;								///< timestamp when this particle system was (re)started
 	UnsignedInt				m_systemLifetimeLeft;						///< lifetime remaining for entire particle system
 	UnsignedInt				m_personalityStore;							///< increments each time it is aggigned to each new particle


fixed in 2145

Skyaero42

I only checked a few files before/after existing changes and I'm finding a lot more spelling issues.

Recommend using AI checking each file and pointing out spelling errors in comments.

xezon · 2026-01-21T10:22:12Z

I also have the impression that the spelling error fix effort is very incomplete. Where ever I look in Source Code, there are a ton of spelling errors. It would be interesting to know how you verify completeness and correctness of fixes. Some spelling error fixes are also choosing the wrong word, implying a not too rigerous approach to this.

It would have been great if we just make one fixing pass and everything is done. This is currently the second pass.

Stubbjax · 2026-01-21T10:55:29Z

I also have the impression that the spelling error fix effort is very incomplete.

I think these PRs are meant to incrementally cover some common misspellings and not fix everything in one go to make things manageable. There are infinitely more spelling / grammatical issues than just the ones made visible here.

It would have been great if we just make one fixing pass and everything is done. This is currently the second pass.

That would take a long time to review. The problem is there are too many inconsistencies - not just in the code base, but in English itself - and likely no amount of automation is going to completely cover everything.

xezon · 2026-01-21T11:01:13Z

Ok that is fair. I agree the smaller reviews help the GitHub process, because of its limitations.

Skyaero42

Agreeing with the several passes.

xezon · 2026-01-22T17:48:20Z

I do not understand the splitting of this change. The title claims one thing, but the actual changes files are in all sorts of unrelated folders that do correspond to what the title says.

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

…rolBarCommand.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

…er.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

…rolBarCommand.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

…Menus/KeyboardOptionsMenu.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

…Menus/KeyboardOptionsMenu.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

…nkerBusterBehavior.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

bobtista · 2026-01-23T19:14:25Z

I do not understand the splitting of this change. The title claims one thing, but the actual changes files are in all sorts of unrelated folders that do correspond to what the title says.

If we squash or rebase main the changes are right

greptile-apps bot reviewed Jan 18, 2026

View reviewed changes

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp Outdated Show resolved Hide resolved

Stubbjax reviewed Jan 19, 2026

View reviewed changes

xezon added the Documentation Is documentation or complementary resource label Jan 19, 2026

xezon reviewed Jan 19, 2026

View reviewed changes

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/SpecialPower/SpecialPowerModule.cpp Outdated Show resolved Hide resolved

bobtista force-pushed the fix/typos-generalsmd-engine branch from 0be45b4 to 64fc1d0 Compare January 19, 2026 22:07

Stubbjax reviewed Jan 20, 2026

View reviewed changes

xezon reviewed Jan 20, 2026

View reviewed changes

typos.toml Outdated Show resolved Hide resolved

xezon requested review from Skyaero42, Stubbjax and xezon January 21, 2026 07:29

xezon approved these changes Jan 21, 2026

View reviewed changes

Skyaero42 reviewed Jan 21, 2026

View reviewed changes

Skyaero42 requested changes Jan 21, 2026

View reviewed changes

Stubbjax approved these changes Jan 22, 2026

View reviewed changes

xezon requested a review from Skyaero42 January 22, 2026 14:55

Skyaero42 approved these changes Jan 22, 2026

View reviewed changes

docs: Fix spelling errors in engine comments

d579f0a

bobtista and others added 17 commits January 22, 2026 15:28

docs: Fix spelling errors in GeneralsMD/Code/GameEngine comments

6a2f73c

Update GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp

1190831

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

Update Generals/Code/GameEngine/Source/GameClient/GUI/ControlBar/Cont…

d8ea21f

…rolBarCommand.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Update Generals/Code/GameEngine/Source/GameClient/GUI/GameWindowManag…

8c35fd5

…er.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Update Generals/Code/GameEngine/Source/GameClient/GUI/ControlBar/Cont…

0e61968

…rolBarCommand.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Update Generals/Code/GameEngine/Source/GameClient/GameClient.cpp

c9b811e

Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Update GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/…

110b24c

…Menus/KeyboardOptionsMenu.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Update Generals/Code/GameEngine/Source/GameClient/InGameUI.cpp

e96b0c9

Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Update GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/…

bc0fb85

…Menus/KeyboardOptionsMenu.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Update GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Behavior/Bu…

660bdc2

…nkerBusterBehavior.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

Update GeneralsMD/Code/GameEngine/Include/GameClient/GameWindow.h

89e4171

Co-authored-by: Stubbjax <stubbjax02@hotmail.com>

nit: revert intend change

d1e6b10

nit: address comment comments

5b3bbc9

fix: Address PR review feedback for spelling errors

9822a2d

Remove accidentally committed typos.toml

c8a0b02

fix: Address remaining Stubbjax review comments

9b41e9a

refactor: Remove non-GeneralsMD files from this PR

e66f7ba

bobtista force-pushed the fix/typos-generalsmd-engine branch from c7aa065 to e66f7ba Compare January 22, 2026 21:29

fix: properly to property in GeneralsMD Weaponset

8fce742

docs: Fix spelling errors in GeneralsMD/Code/GameEngine comments #2146

Are you sure you want to change the base?

docs: Fix spelling errors in GeneralsMD/Code/GameEngine comments #2146

Uh oh!

Conversation

bobtista commented Jan 18, 2026

Uh oh!

greptile-apps bot commented Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Sequence Diagram

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

xezon commented Jan 19, 2026

Uh oh!

bobtista commented Jan 19, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

xezon commented Jan 20, 2026

Uh oh!

Stubbjax commented Jan 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Skyaero42 left a comment

Choose a reason for hiding this comment

Uh oh!

xezon commented Jan 21, 2026

Uh oh!

Stubbjax commented Jan 21, 2026

Uh oh!

xezon commented Jan 21, 2026

Uh oh!

Skyaero42 left a comment

Choose a reason for hiding this comment

Uh oh!

xezon commented Jan 22, 2026

Uh oh!

greptile-apps bot commented Jan 18, 2026 •

edited

Loading