Merge pull request #86 from Project516/copilot/review-javadoc-organization

Fix JavaDoc inaccuracies and missing documentation

Author: Project516

app/src/main/java/io/github/project516/NumberGuessingGame/CheckGuess.java

@@ -6,7 +6,7 @@
  */
 public class CheckGuess {
     /**
-     * Validates that a guess is within the acceptable range (1-100).
+     * Validates that a guess is within the acceptable range (1-101).
      *
      * @param guess the user's guess to validate
      * @throws IllegalArgumentException if the guess is less than 1 or greater than 101

app/src/main/java/io/github/project516/NumberGuessingGame/HighScore.java

@@ -58,6 +58,11 @@ public int compareTo(HighScore other) {
         return Integer.compare(this.numberOfGuesses, other.numberOfGuesses);
     }
 
+    /**
+     * Returns a string representation of this high score in the format "username: X guess(es)".
+     *
+     * @return a formatted string containing the username and number of guesses
+     */
     @Override
     public String toString() {
         return username + ": " + numberOfGuesses + " guess" + (numberOfGuesses == 1 ? "" : "es");

app/src/main/java/io/github/project516/NumberGuessingGame/RandomNumber.java

@@ -12,10 +12,10 @@ public class RandomNumber {
     Random random = new Random();
 
     /**
-     * Generates a random integer between 0 and the specified maximum value (inclusive).
+     * Generates a random integer between 0 (inclusive) and the specified maximum value (inclusive).
      *
-     * @param max the maximum value for the random number
-     * @return a random integer between 0 and max (inclusive)
+     * @param max the maximum value for the random number (inclusive)
+     * @return a random integer in the range [0, max]
      */
     int number(int max) {
 

app/src/main/java/io/github/project516/NumberGuessingGame/ReadVersionFile.java

@@ -5,18 +5,15 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 
-/**
- * Reads version information for the Number Guessing Game. Currently returns a placeholder version
- * string.
- */
+/** Reads version information for the Number Guessing Game from the version.txt resource file. */
 public class ReadVersionFile {
     /**
      * Retrieves the current version of the game by reading from the version.txt resource file.
      *
      * @return the version string
      */
     public String readVersion() {
-        String content = "1.0.0"; // Placeholder version
+        String content = "1.0.0"; // Default fallback version
         try (InputStream inputStream =
                         getClass().getClassLoader().getResourceAsStream("version.txt");
                 BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) {