Commented spectator fixes

Added comments to the new merge for spectator fixes

src/client/chessboard/chessboard-wrapper.tsx

@@ -85,7 +85,7 @@ export function ChessboardWrapper(props: ChessboardWrapperProps): JSX.Element {
         setLastClickedSquare(undefined);
     };
 
-    //set the side to their respective colors
+    //set the side to their respective colors and orientations
     switch (props.side) {
         case Side.WHITE:
             if (orientation !== "white") setOrientation("white");

src/client/setup/setup.tsx

@@ -35,6 +35,7 @@ export function Setup(): JSX.Element {
         );
     }
 
+    //if the client is a host, let them choose a game type
     if (data.clientType === ClientType.HOST) {
         return (
             <SetupBase>

src/common/message/game-message.ts

@@ -68,6 +68,10 @@ export class GameInterruptedMessage extends Message {
     }
 }
 
+/**
+ * A message that contains why the game has finished
+ *
+ */
 export class GameFinishedMessage extends Message {
     constructor(public readonly reason: GameFinishedReason) {
         super();
@@ -83,6 +87,9 @@ export class GameFinishedMessage extends Message {
     }
 }
 
+/**
+ * A message that contains why the game was temporarily held
+ */
 export class GameHoldMessage extends Message {
     constructor(public readonly reason: GameHoldReason) {
         super();

src/server/api/client-manager.ts

@@ -53,6 +53,11 @@ export class ClientManager {
         return socket !== undefined;
     }
 
+    /**
+     * send an update message to all spectators
+     * @param message - the message to send
+     * @returns if it completed successfully
+     */
     public sendToSpectators(message: Message): boolean {
         if (this.spectatorIds.size !== 0) {
             for (const item of this.spectatorIds) {

src/server/api/game-manager.ts

@@ -119,6 +119,8 @@ export class HumanGameManager extends GameManager {
                 this.clientManager,
             );
         }
+
+        //bind all spectators
         const sendToSpectators = this.clientManager.sendToSpectators.bind(
             this.clientManager,
         );
@@ -156,6 +158,8 @@ export class HumanGameManager extends GameManager {
             sendToPlayer(message);
             sendToOpponent(message);
             sendToSpectators(message);
+
+            //end the game in save manager
             if (ids) {
                 if (currentSave?.host === ids[0])
                     SaveManager.endGame(ids[0], ids[1]);