Review changes

Author: MaximDude

Main.cpp

@@ -1937,7 +1937,6 @@ int main(int argc, char *argv[]) {
 	if (g_NetworkServer.IsServerModeEnabled()) {
 		g_NetworkServer.Start();
 		g_FrameMan.SetMultiplayerMode(true);
-
 		g_AudioMan.SetMultiplayerMode(true);
 		g_AudioMan.SetSoundsVolume(0);
 		g_AudioMan.SetMusicVolume(0);

Managers/FrameMan.h

@@ -340,7 +340,7 @@ namespace RTE {
 		/// <summary>
 		/// Clears the message to be displayed on top of each player's screen.
 		/// </summary>
-		/// <param name="whichScreen">Which screen message to clear..</param>
+		/// <param name="whichScreen">Which screen message to clear.</param>
 		void ClearScreenText(int whichScreen = 0);
 #pragma endregion
 
@@ -585,21 +585,19 @@ namespace RTE {
 
 		static constexpr unsigned short m_BPP = 32; //!< Color depth (bits per pixel).
 
-		// Resolution
-		int m_ResX;
-		int m_ResY;
-
-		// These are the new resolution settings that will take effect next time the FrameMan is started
-		int m_NewResX;
-		int m_NewResY;
+		int m_ResX; //!< Display width.
+		int m_ResY; //!< Display height.
+		int m_NewResX; //!< New display width that will take effect next time the FrameMan is started.
+		int m_NewResY; //!< New display height that will take effect next time the FrameMan is started.
 
 		bool m_Fullscreen; //!< Whether in fullscreen mode or not.	
 		int m_NxWindowed; //!< The number of times the windowed mode resolution should be multiplied and stretched across for better visibility.
 
-		// The number of times the fullscreen mode resolution should be multiplied and stretched across for better visibility
-		// The internal virtual resolution (m_ResX, m_ResY) is 1/n of the actual fullscreen res that the graphics card outputs
+		/// <summary>
+		/// The number of times the fullscreen mode resolution should be multiplied and stretched across for better visibility.
+		/// The internal virtual resolution (m_ResX, m_ResY) is 1/n of the actual fullscreen resolution that the graphics card outputs.
+		/// </summary>
 		int m_NxFullscreen;
-
 		int m_NewNxFullscreen; //!< This is the new fullscreen multiple that will take effect next time the FrameMan is started.
 
 		bool m_HSplit; //!< Whether the screen is split horizontally across the screen, ie as two splitscreens one above the other.		

Managers/PostProcessMan.cpp

@@ -244,15 +244,16 @@ namespace RTE {
 		// Set the screen blender mode for glows
 		set_screen_blender(128, 128, 128, 128);
 
+		// Reference. Do not remove.
 		//acquire_bitmap(m_BackBuffer8);
 		//acquire_bitmap(m_BackBuffer32);
 
 		DrawDotGlowEffects();
 		DrawPostScreenEffects();
 
+		// Reference. Do not remove.
 		//release_bitmap(m_BackBuffer32);
 		//release_bitmap(m_BackBuffer8);
-
 		// Set blender mode back??
 		//set_trans_blender(128, 128, 128, 128);
 

Managers/PostProcessMan.h

@@ -190,22 +190,22 @@ namespace RTE {
 		std::list<PostEffect> m_ScreenRelativeEffects[c_MaxScreenCount]; //!<
 		std::mutex ScreenRelativeEffectsMutex[c_MaxScreenCount]; //!<
 
-		BITMAP *m_YellowGlow; //!<
-		size_t m_YellowGlowHash; //!<
+		BITMAP *m_YellowGlow; //!< Bitmap for the yellow dot glow effect.
+		BITMAP *m_RedGlow; //!< Bitmap for the red dot glow effect.
+		BITMAP *m_BlueGlow; //!< Bitmap for the blue dot glow effect.
+
+		size_t m_YellowGlowHash; //!< Hash value for the yellow dot glow effect bitmap.
+		size_t m_RedGlowHash; //!< Hash value for the red dot glow effect bitmap.
+		size_t m_BlueGlowHash; //!< Hash value for the blue dot glow effect bitmap.
+	
+		BITMAP *m_TempEffectBitmap_16; //!< Temporary 16x16 bitmap to rotate post effects in.
+		BITMAP *m_TempEffectBitmap_32; //!< Temporary 32x32 bitmap to rotate post effects in.
+		BITMAP *m_TempEffectBitmap_64; //!< Temporary 64x64 bitmap to rotate post effects in.
+		BITMAP *m_TempEffectBitmap_128; //!< Temporary 128x128 bitmap to rotate post effects in.
+		BITMAP *m_TempEffectBitmap_256; //!< Temporary 256x256 bitmap to rotate post effects in.
+		BITMAP *m_TempEffectBitmap_512; //!< Temporary 512x512 bitmap to rotate post effects in.
 
-		BITMAP *m_RedGlow; //!<
-		size_t m_RedGlowHash; //!<
-
-		BITMAP *m_BlueGlow; //!<
-		size_t m_BlueGlowHash; //!<
-
-		//!< Temp bitmaps to rotate post effects in.
-		BITMAP *m_TempEffectBitmap_16;
-		BITMAP *m_TempEffectBitmap_32;
-		BITMAP *m_TempEffectBitmap_64;
-		BITMAP *m_TempEffectBitmap_128;
-		BITMAP *m_TempEffectBitmap_256;
-		BITMAP *m_TempEffectBitmap_512;
+	private:
 
 #pragma region Post Effect Handling
 		/// <summary>
@@ -222,10 +222,10 @@ namespace RTE {
 		/// <summary>
 		/// Gets all screen effects that are located within a box in the scene. Their coordinates will be returned relative to the upper left corner of the box passed in here.
 		/// </summary>
-		/// <param name="left">Dimensions of the box.</param>
-		/// <param name="top"></param>
-		/// <param name="right"></param>
-		/// <param name="bottom"></param>
+		/// <param name="left">Position of box left plane (X start).</param>
+		/// <param name="top">Position of box top plane (Y start).</param>
+		/// <param name="right">Position of box right plane (X end).</param>
+		/// <param name="bottom">Position of box bottom plane (Y end).</param>
 		/// <param name="effectsList">The list to add the screen effects that fall within the box to. The coordinates of the effects returned here will be relative to the boxPos passed in above.</param>
 		/// <param name="team">The team whose unseen area should block the glows.</param>
 		/// <returns>Whether any active post effects were found in that box.</returns>
@@ -248,7 +248,7 @@ namespace RTE {
 		size_t GetDotGlowEffectHash(DotGlowColor whichColor) const;
 #pragma endregion
 
-	private:
+#pragma region PostProcess Breakdown
 		/// <summary>
 		/// 
 		/// </summary>
@@ -258,6 +258,7 @@ namespace RTE {
 		/// 
 		/// </summary>
 		void DrawPostScreenEffects();
+#pragma endregion
 
 		/// <summary>
 		/// Clears all the member variables of this PostProcessMan, effectively resetting the members of this abstraction level only.

System/Primitive.h

@@ -344,7 +344,7 @@ namespace RTE {
 		BitmapPrimitive(Vector pos, BITMAP * bitmap, float rotAngle) { BitmapPrimitive(-1, pos, bitmap, rotAngle); }
 
 		/// <summary>
-		/// 
+		/// Constructor method for BitmapPrimitive object.
 		/// </summary>
 		/// <param name="player">Player screen to draw this primitive on.</param>
 		/// <param name="pos">Position of this primitive.</param>