refactor: Move some code comments into correct scopes (#1551)

xezon · xezon · commit b95042c58333 · 2025-09-12T11:28:09.000+02:00
diff --git a/Core/Libraries/Source/WWVegas/WWLib/FastAllocator.h b/Core/Libraries/Source/WWVegas/WWLib/FastAllocator.h
@@ -163,14 +163,20 @@ class StackAllocator{
                T* pTArray = (T*)mTArray;
                const T* const pTArrayEnd = pTArray + nCount;
                while(pTArray < pTArrayEnd){
-                  new(pTArray)T; //Use the placement operator new. This simply calls the constructor
-                  ++pTArray;     //of T with 'this' set to the input address. Note that we don't put
-               }                 //a '()' after the T this is because () causes trivial types like int
-            }                    //and class* to be assigned zero/NULL. We don't want that.
+                  //Use the placement operator new. This simply calls the constructor
+                  //of T with 'this' set to the input address. Note that we don't put
+                  //a '()' after the T this is because () causes trivial types like int
+                  //and class* to be assigned zero/NULL. We don't want that.
+                  new(pTArray)T;
+                  ++pTArray;
+               }
+            }
             return (T*)mTArray;
-         } //Else the request is too big. So let's use (the slower) operator new.
+         }
+         //Else the request is too big. So let's use (the slower) operator new.
          return (mpTHeap = new T[nCount]); //The compiler will call the constructors here.
-      } //Else we are being used. Let's be nice and allocate something anyway.
+      }
+      //Else we are being used. Let's be nice and allocate something anyway.
       return new T[nCount];
    }
 
diff --git a/Generals/Code/GameEngine/Source/Common/GameLOD.cpp b/Generals/Code/GameEngine/Source/Common/GameLOD.cpp
@@ -288,8 +288,10 @@ void GameLODManager::init(void)
 	if ((Real)(m_numRAM)/(Real)(256*1024*1024) >= PROFILE_ERROR_LIMIT)
 		m_memPassed=TRUE;	//check if they have at least 256 MB
 
+	//find data needed to determine m_idealDetailLevel
 	if (m_idealDetailLevel == STATIC_GAME_LOD_UNKNOWN || TheGlobalData->m_forceBenchmark)
 	{
+		//find equivalent CPU to unknown cpu.
 		if (m_cpuType == XX || TheGlobalData->m_forceBenchmark)
 		{
 			//need to run the benchmark
@@ -335,8 +337,8 @@ void GameLODManager::init(void)
 				}
 				prof++;
 			}
-		}	//finding equivalent CPU to unkown cpu.
-	}	//find data needed to determine m_idealDetailLevel
+		}
+	}
 
 	if (userSetDetail == STATIC_GAME_LOD_CUSTOM)
 	{
diff --git a/Generals/Code/GameEngine/Source/GameLogic/AI/TurretAI.cpp b/Generals/Code/GameEngine/Source/GameLogic/AI/TurretAI.cpp
@@ -1265,12 +1265,13 @@ void TurretAIIdleState::resetIdleScan()
 StateReturnType TurretAIIdleState::onEnter()
 {
 	AIUpdateInterface *ai = getMachineOwner()->getAIUpdateInterface();
+	// ai doesn't exist if the object was just created this frame.
 	if (ai)
 	{
 		ai->resetNextMoodCheckTime();
 		if (ai->friend_getTurretSync() == getTurretAI()->friend_getWhichTurret())
 			ai->friend_setTurretSync(TURRET_INVALID);
-	} // ai doesn't exist if the object was just created this frame.
+	}
 
 	resetIdleScan();
 
diff --git a/Generals/Code/GameEngine/Source/GameLogic/Object/PartitionManager.cpp b/Generals/Code/GameEngine/Source/GameLogic/Object/PartitionManager.cpp
@@ -1658,17 +1658,19 @@ ObjectShroudStatus PartitionData::getShroudedStatus(Int playerIndex)
 		else if( shroudedCells + foggedCells == m_coiInUseCount )
 		{
 			m_shroudedness[playerIndex] = OBJECTSHROUD_FOGGED;	//object is visible but fogged.
-			if (m_object && m_ghostObject)	//object does not exist for modules holding only GhostObjects
+			if (m_object && m_ghostObject)
 			{
+				//object does not exist for modules holding only GhostObjects
 				//fogged but may not be visible if faction unit or faction building that has not been seen before
 				Player *player=ThePlayerList->getNthPlayer(playerIndex);
 				if (player->getRelationship(m_object->getTeam()) == NEUTRAL)
 				{	//anything neutral that moves around will not be rendered inside fog.
 					if (!m_object->isKindOf(KINDOF_IMMOBILE))
 						m_shroudedness[playerIndex] = OBJECTSHROUD_SHROUDED;
 				}
-				else	//Not neutral
-				{	//enemy unit will always be shrouded unless it's a building that's already been seen by the player.  Fogged Mines are also always
+				else
+				{	//Not neutral
+					//enemy unit will always be shrouded unless it's a building that's already been seen by the player.  Fogged Mines are also always
 					//shroued no matter what.
 					if (!(m_object->isKindOf(KINDOF_IMMOBILE) && m_everSeenByPlayer[playerIndex]) || m_object->isKindOf(KINDOF_MINE))
 						m_shroudedness[playerIndex] = OBJECTSHROUD_SHROUDED;
@@ -1685,15 +1687,16 @@ ObjectShroudStatus PartitionData::getShroudedStatus(Int playerIndex)
 			}
 		}
 		else if( shroudedCells == 0  &&  foggedCells == 0 )
-		{	//Record that this object was seen by the player.  This info will be used to show fogged enemy faction buildings.
+		{	//no cell I use has anything
+			//Record that this object was seen by the player.  This info will be used to show fogged enemy faction buildings.
 			m_everSeenByPlayer[playerIndex] = true;
 			m_shroudedness[playerIndex] = OBJECTSHROUD_CLEAR;
 			if (m_ghostObject && m_shroudednessPrevious[playerIndex] == OBJECTSHROUD_FOGGED)
 			{	//object was previously fogged but now is visible so we no longer
 				//need a ghost object.
 				m_ghostObject->freeSnapShot(playerIndex);
 			}
-		}	// no cell I use has anything
+		}
 		else
 		{	//Record that this object was seen by the player.  This info will be used to show fogged enemy faction buildings.
 			m_everSeenByPlayer[playerIndex] = true;
diff --git a/Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DInGameUI.cpp b/Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DInGameUI.cpp
@@ -355,8 +355,8 @@ void W3DInGameUI::init( void )
 			// hide it for now
 			motd->winHide( TRUE );
 
-		}  // end if*/
-
+		}  // end if
+*/
 
 }  // end init
 
diff --git a/Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DTerrainTracks.cpp b/Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DTerrainTracks.cpp
@@ -884,6 +884,7 @@ Try improving the fit to vertical surfaces like cliffs.
 		}	//while (mod)
 	}//edges to flush
 
+	//there are some edges to render in pool.
 	//draw the filled vertex buffers
 	if (m_edgesToFlush >= 2)
 	{
@@ -909,7 +910,7 @@ Try improving the fit to vertical surfaces like cliffs.
 			}
 			mod=mod->m_nextSystem;
 		}
-	}	//there are some edges to render in pool.
+	}
 
 	m_edgesToFlush=0;	//reset count for next flush
 }
diff --git a/GeneralsMD/Code/GameEngine/Source/Common/GameLOD.cpp b/GeneralsMD/Code/GameEngine/Source/Common/GameLOD.cpp
@@ -290,8 +290,10 @@ void GameLODManager::init(void)
 	if ((Real)(m_numRAM)/(Real)(256*1024*1024) >= PROFILE_ERROR_LIMIT)
 		m_memPassed=TRUE;	//check if they have at least 256 MB
 
+	//find data needed to determine m_idealDetailLevel
 	if (m_idealDetailLevel == STATIC_GAME_LOD_UNKNOWN || TheGlobalData->m_forceBenchmark)
 	{
+		//find equivalent CPU to unknown cpu.
 		if (m_cpuType == XX || TheGlobalData->m_forceBenchmark)
 		{
 			//need to run the benchmark
@@ -337,8 +339,8 @@ void GameLODManager::init(void)
 				}
 				prof++;
 			}
-		}	//finding equivalent CPU to unkown cpu.
-	}	//find data needed to determine m_idealDetailLevel
+		}
+	}
 
 	if (userSetDetail == STATIC_GAME_LOD_CUSTOM)
 	{
diff --git a/GeneralsMD/Code/GameEngine/Source/GameLogic/AI/TurretAI.cpp b/GeneralsMD/Code/GameEngine/Source/GameLogic/AI/TurretAI.cpp
@@ -1287,12 +1287,13 @@ void TurretAIIdleState::resetIdleScan()
 StateReturnType TurretAIIdleState::onEnter()
 {
 	AIUpdateInterface *ai = getMachineOwner()->getAIUpdateInterface();
+	// ai doesn't exist if the object was just created this frame.
 	if (ai)
 	{
 		ai->resetNextMoodCheckTime();
 		if (ai->friend_getTurretSync() == getTurretAI()->friend_getWhichTurret())
 			ai->friend_setTurretSync(TURRET_INVALID);
-	} // ai doesn't exist if the object was just created this frame.
+	}
 
 	resetIdleScan();
 
diff --git a/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/PartitionManager.cpp b/GeneralsMD/Code/GameEngine/Source/GameLogic/Object/PartitionManager.cpp
@@ -1662,17 +1662,19 @@ ObjectShroudStatus PartitionData::getShroudedStatus(Int playerIndex)
 		else if( shroudedCells + foggedCells == m_coiInUseCount )
 		{
 			m_shroudedness[playerIndex] = OBJECTSHROUD_FOGGED;	//object is visible but fogged.
-			if (m_object && m_ghostObject)	//object does not exist for modules holding only GhostObjects
+			if (m_object && m_ghostObject)
 			{
+				//object does not exist for modules holding only GhostObjects
 				//fogged but may not be visible if faction unit or faction building that has not been seen before
 				Player *player=ThePlayerList->getNthPlayer(playerIndex);
 				if (player->getRelationship(m_object->getTeam()) == NEUTRAL)
 				{	//anything neutral that moves around will not be rendered inside fog.
 					if (!m_object->isKindOf(KINDOF_IMMOBILE))
 						m_shroudedness[playerIndex] = OBJECTSHROUD_SHROUDED;
 				}
-				else	//Not neutral
-				{	//enemy unit will always be shrouded unless it's a building that's already been seen by the player.  Fogged Mines are also always
+				else
+				{	//Not neutral
+					//enemy unit will always be shrouded unless it's a building that's already been seen by the player.  Fogged Mines are also always
 					//shroued no matter what.
 					if (!(m_object->isKindOf(KINDOF_IMMOBILE) && m_everSeenByPlayer[playerIndex]) || m_object->isKindOf(KINDOF_MINE))
 						m_shroudedness[playerIndex] = OBJECTSHROUD_SHROUDED;
@@ -1689,15 +1691,16 @@ ObjectShroudStatus PartitionData::getShroudedStatus(Int playerIndex)
 			}
 		}
 		else if( shroudedCells == 0  &&  foggedCells == 0 )
-		{	//Record that this object was seen by the player.  This info will be used to show fogged enemy faction buildings.
+		{	//no cell I use has anything
+			//Record that this object was seen by the player.  This info will be used to show fogged enemy faction buildings.
 			m_everSeenByPlayer[playerIndex] = true;
 			m_shroudedness[playerIndex] = OBJECTSHROUD_CLEAR;
 			if (m_ghostObject && m_shroudednessPrevious[playerIndex] == OBJECTSHROUD_FOGGED)
 			{	//object was previously fogged but now is visible so we no longer
 				//need a ghost object.
 				m_ghostObject->freeSnapShot(playerIndex);
 			}
-		}	// no cell I use has anything
+		}
 		else
 		{	//Record that this object was seen by the player.  This info will be used to show fogged enemy faction buildings.
 			m_everSeenByPlayer[playerIndex] = true;
diff --git a/GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DInGameUI.cpp b/GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DInGameUI.cpp
@@ -355,8 +355,8 @@ void W3DInGameUI::init( void )
 			// hide it for now
 			motd->winHide( TRUE );
 
-		}  // end if*/
-
+		}  // end if
+*/
 
 }  // end init
 
diff --git a/GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DTerrainTracks.cpp b/GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DTerrainTracks.cpp
@@ -884,6 +884,7 @@ Try improving the fit to vertical surfaces like cliffs.
 		}	//while (mod)
 	}//edges to flush
 
+	//there are some edges to render in pool.
 	//draw the filled vertex buffers
 	if (m_edgesToFlush >= 2)
 	{
@@ -909,7 +910,7 @@ Try improving the fit to vertical surfaces like cliffs.
 			}
 			mod=mod->m_nextSystem;
 		}
-	}	//there are some edges to render in pool.
+	}
 
 	m_edgesToFlush=0;	//reset count for next flush
 }
diff --git a/GeneralsMD/Code/Libraries/Source/WWVegas/WW3D2/sortingrenderer.cpp b/GeneralsMD/Code/Libraries/Source/WWVegas/WW3D2/sortingrenderer.cpp
@@ -113,11 +113,13 @@ void Sort(TempIndexStruct *begin, TempIndexStruct *end)
 			std::swap(begin[1], end[-1]);
 		}
 		if (begin[0] > end[-1]) {
+			// end[-1] has the largest element
 			std::swap(begin[0], end[-1]);
-		}																// end[-1] has the largest element
+		}
 		if (begin[1] > begin[0]) {
+			// begin[0] has the middle element and begin[1] has the smallest element
 			std::swap(begin[1], begin[0]);
-		}																// begin[0] has the middle element and begin[1] has the smallest element
+		}
 
 		// *begin is now the partitioning element
 		TempIndexStruct *begin1 = begin + 1;	// TODO: Temp fix until I find out who is passing me NaN

Original file line number	Diff line number	Diff line change
`@@ -288,8 +288,10 @@ void GameLODManager::init(void)`
`288`	`288`	`if ((Real)(m_numRAM)/(Real)(25610241024) >= PROFILE_ERROR_LIMIT)`
`289`	`289`	`m_memPassed=TRUE; //check if they have at least 256 MB`
`290`	`290`
	`291`	`+ //find data needed to determine m_idealDetailLevel`
`291`	`292`	`if (m_idealDetailLevel == STATIC_GAME_LOD_UNKNOWN \|\| TheGlobalData->m_forceBenchmark)`
`292`	`293`	`{`
	`294`	`+ //find equivalent CPU to unknown cpu.`
`293`	`295`	`if (m_cpuType == XX \|\| TheGlobalData->m_forceBenchmark)`
`294`	`296`	`{`
`295`	`297`	`//need to run the benchmark`
`@@ -335,8 +337,8 @@ void GameLODManager::init(void)`
`335`	`337`	`}`
`336`	`338`	`prof++;`
`337`	`339`	`}`
`338`		`- } //finding equivalent CPU to unkown cpu.`
`339`		`- } //find data needed to determine m_idealDetailLevel`
	`340`	`+ }`
	`341`	`+ }`
`340`	`342`
`341`	`343`	`if (userSetDetail == STATIC_GAME_LOD_CUSTOM)`
`342`	`344`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1265,12 +1265,13 @@ void TurretAIIdleState::resetIdleScan()`
`1265`	`1265`	`StateReturnType TurretAIIdleState::onEnter()`
`1266`	`1266`	`{`
`1267`	`1267`	`AIUpdateInterface *ai = getMachineOwner()->getAIUpdateInterface();`
	`1268`	`+ // ai doesn't exist if the object was just created this frame.`
`1268`	`1269`	`if (ai)`
`1269`	`1270`	`{`
`1270`	`1271`	`ai->resetNextMoodCheckTime();`
`1271`	`1272`	`if (ai->friend_getTurretSync() == getTurretAI()->friend_getWhichTurret())`
`1272`	`1273`	`ai->friend_setTurretSync(TURRET_INVALID);`
`1273`		`- } // ai doesn't exist if the object was just created this frame.`
	`1274`	`+ }`
`1274`	`1275`
`1275`	`1276`	`resetIdleScan();`
`1276`	`1277`
Original file line number	Diff line number	Diff line change
`@@ -884,6 +884,7 @@ Try improving the fit to vertical surfaces like cliffs.`
`884`	`884`	`} //while (mod)`
`885`	`885`	`}//edges to flush`
`886`	`886`
	`887`	`+ //there are some edges to render in pool.`
`887`	`888`	`//draw the filled vertex buffers`
`888`	`889`	`if (m_edgesToFlush >= 2)`
`889`	`890`	`{`
`@@ -909,7 +910,7 @@ Try improving the fit to vertical surfaces like cliffs.`
`909`	`910`	`}`
`910`	`911`	`mod=mod->m_nextSystem;`
`911`	`912`	`}`
`912`		`- } //there are some edges to render in pool.`
	`913`	`+ }`
`913`	`914`
`914`	`915`	`m_edgesToFlush=0; //reset count for next flush`
`915`	`916`	`}`
Original file line number	Diff line number	Diff line change
`@@ -290,8 +290,10 @@ void GameLODManager::init(void)`
`290`	`290`	`if ((Real)(m_numRAM)/(Real)(25610241024) >= PROFILE_ERROR_LIMIT)`
`291`	`291`	`m_memPassed=TRUE; //check if they have at least 256 MB`
`292`	`292`
	`293`	`+ //find data needed to determine m_idealDetailLevel`
`293`	`294`	`if (m_idealDetailLevel == STATIC_GAME_LOD_UNKNOWN \|\| TheGlobalData->m_forceBenchmark)`
`294`	`295`	`{`
	`296`	`+ //find equivalent CPU to unknown cpu.`
`295`	`297`	`if (m_cpuType == XX \|\| TheGlobalData->m_forceBenchmark)`
`296`	`298`	`{`
`297`	`299`	`//need to run the benchmark`
`@@ -337,8 +339,8 @@ void GameLODManager::init(void)`
`337`	`339`	`}`
`338`	`340`	`prof++;`
`339`	`341`	`}`
`340`		`- } //finding equivalent CPU to unkown cpu.`
`341`		`- } //find data needed to determine m_idealDetailLevel`
	`342`	`+ }`
	`343`	`+ }`
`342`	`344`
`343`	`345`	`if (userSetDetail == STATIC_GAME_LOD_CUSTOM)`
`344`	`346`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1287,12 +1287,13 @@ void TurretAIIdleState::resetIdleScan()`
`1287`	`1287`	`StateReturnType TurretAIIdleState::onEnter()`
`1288`	`1288`	`{`
`1289`	`1289`	`AIUpdateInterface *ai = getMachineOwner()->getAIUpdateInterface();`
	`1290`	`+ // ai doesn't exist if the object was just created this frame.`
`1290`	`1291`	`if (ai)`
`1291`	`1292`	`{`
`1292`	`1293`	`ai->resetNextMoodCheckTime();`
`1293`	`1294`	`if (ai->friend_getTurretSync() == getTurretAI()->friend_getWhichTurret())`
`1294`	`1295`	`ai->friend_setTurretSync(TURRET_INVALID);`
`1295`		`- } // ai doesn't exist if the object was just created this frame.`
	`1296`	`+ }`
`1296`	`1297`
`1297`	`1298`	`resetIdleScan();`
`1298`	`1299`