comments for classes

Author: Cody616

app/src/main/java/com/example/chaiss/AnalysisActivity.java

@@ -51,13 +51,15 @@ protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_analysis);
 
+        // Initialize views
         scrollView = findViewById(R.id.scroll_view_analysis);
         chessBoardImage = findViewById(R.id.chess_board);
         analysisText = findViewById(R.id.analysis_text);
         pawnText = findViewById(R.id.pawn_structure_text);
         developmentText = findViewById(R.id.piece_development_text);
         kingSafetyText = findViewById(R.id.king_safety_text);
 
+        // Initialize buttons
         Button addPieceButton = findViewById(R.id.add_piece_button);
         Button lockButton = findViewById(R.id.lock_button);
         Button analyzeButton = findViewById(R.id.analyze_button);
@@ -141,6 +143,7 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
         }
     }
 
+    // Show dialog to delete a piece
     private void showDeletePieceDialog() {
         AlertDialog.Builder builder = new AlertDialog.Builder(this);
         builder.setTitle("Delete Piece");
@@ -173,6 +176,7 @@ private void showDeletePieceDialog() {
         builder.show();
     }
 
+    // Show dialog to select which piece to add
     private void showPieceSelectionDialog() {
         AlertDialog.Builder builder = new AlertDialog.Builder(this);
         builder.setTitle("Select a Piece to Place");
@@ -195,6 +199,7 @@ private void showPieceSelectionDialog() {
         builder.show();
     }
 
+    // Show dialog to input square for placing piece
     private void showSquareSelectionDialog(String piece) {
         AlertDialog.Builder builder = new AlertDialog.Builder(this);
         builder.setTitle("Enter Square (e.g., e4)");
@@ -216,6 +221,7 @@ private void showSquareSelectionDialog(String piece) {
         builder.show();
     }
 
+    // Show dialog to select color for the new piece
     private void showColorSelectionDialog(String piece, String square) {
         AlertDialog.Builder builder = new AlertDialog.Builder(this);
         builder.setTitle("Select Piece Color");
@@ -230,6 +236,7 @@ private void showColorSelectionDialog(String piece, String square) {
         builder.show();
     }
 
+    // Add selected piece to board
     private void addPieceToBoard(String square, String piece) {
         try {
             PyObject result = chessLogic1.callAttr("add_piece", currentFEN, square, piece);
@@ -253,9 +260,7 @@ private void addPieceToBoard(String square, String piece) {
         }
     }
 
-
-
-
+    // Show instructions about using analysis page
     private void showInstructionsDialog() {
         AlertDialog.Builder builder = new AlertDialog.Builder(this);
         builder.setTitle("Instructions");
@@ -278,6 +283,7 @@ private void showInstructionsDialog() {
         builder.show();
     }
 
+    // Handles touch interactions on the chessboard
     private void handleTouch(MotionEvent event) {
         if (isLocked) {
             Toast.makeText(this, "Board is locked", Toast.LENGTH_SHORT).show();
@@ -373,6 +379,7 @@ private void handleTouch(MotionEvent event) {
         }
     }
 
+    // Converts touch screen coordinates into a chessboard square nam
     private String getSquareFromTouch(float x, float y) {
         int boardSize = chessBoardImage.getWidth();
         int squareSize = boardSize / 8;
@@ -394,6 +401,7 @@ private String getSquareFromTouch(float x, float y) {
         return "" + file + rank;
     }
 
+    // Updates the displayed chessboard based on the current FEN and theme settings
     private void updateBoard() {
         new Thread(() -> {
             try {
@@ -421,6 +429,7 @@ private void updateBoard() {
         }).start();
     }
 
+    // Prompts user to select whose turn it is to move, then analyzes the current board position
     private void analyzePosition() {
         AlertDialog.Builder builder = new AlertDialog.Builder(this);
         builder.setTitle("Select Turn");
@@ -467,6 +476,7 @@ private void analyzePosition() {
         builder.show();
     }
 
+    // Sends the current board position (FEN)
     private void getBestMoveFromAPI(String fen) {
         new Thread(() -> {
             try {
@@ -529,6 +539,8 @@ private void getBestMoveFromAPI(String fen) {
             }
         }).start();
     }
+
+    // Returns the drawable resource ID
     private int getPieceResource(String piece) {
         switch (piece) {
             case "P": return R.drawable.wpawn;
@@ -546,6 +558,8 @@ private int getPieceResource(String piece) {
             default: return 0;
         }
     }
+
+    // Moves a piece from one square to another
     private void movePiece(String fromSquare, String toSquare) {
         try {
             if (isFreeMoveMode) {

app/src/main/java/com/example/chaiss/MainMenu.java

@@ -17,6 +17,7 @@ protected void onCreate(Bundle savedInstanceState) {
         analysisButton.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View v) {
+                // Start the AnalysisActivity when the button is clicked
                 Intent intent = new Intent(MainMenu.this, AnalysisActivity.class);
                 startActivity(intent);
             }
@@ -26,11 +27,12 @@ public void onClick(View v) {
         playButton.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View v) {
+                // Start the SelectDifficultyActivity when the button is clicked
                 Intent intent = new Intent(MainMenu.this, SelectDifficultyActivity.class);
                 startActivity(intent);
             }
         });
-
+        // Setup the Settings button to navigate to SettingsActivity
         Button settingsButton = findViewById(R.id.button7);
         settingsButton.setOnClickListener(new View.OnClickListener() {
             @Override