Skip to content

Commit a93e0ff

Browse files
CopilotProject516
andcommitted
Fix JavaDoc documentation inaccuracies in CheckGuess, RandomNumber, and ReadVersionFile
Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
1 parent 013b21e commit a93e0ff

3 files changed

Lines changed: 5 additions & 8 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
*/
77
public class CheckGuess {
88
/**
9-
* Validates that a guess is within the acceptable range (1-100).
9+
* Validates that a guess is within the acceptable range (1-101).
1010
*
1111
* @param guess the user's guess to validate
1212
* @throws IllegalArgumentException if the guess is less than 1 or greater than 101

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ public class RandomNumber {
1212
Random random = new Random();
1313

1414
/**
15-
* Generates a random integer between 0 and the specified maximum value (inclusive).
15+
* Generates a random integer between 0 (inclusive) and the specified maximum value (inclusive).
1616
*
17-
* @param max the maximum value for the random number
18-
* @return a random integer between 0 and max (inclusive)
17+
* @param max the maximum value for the random number (inclusive)
18+
* @return a random integer in the range [0, max]
1919
*/
2020
int number(int max) {
2121

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,7 @@
55
import java.io.InputStream;
66
import java.io.InputStreamReader;
77

8-
/**
9-
* Reads version information for the Number Guessing Game. Currently returns a placeholder version
10-
* string.
11-
*/
8+
/** Reads version information for the Number Guessing Game from the version.txt resource file. */
129
public class ReadVersionFile {
1310
/**
1411
* Retrieves the current version of the game by reading from the version.txt resource file.

0 commit comments

Comments
 (0)