Skip to content

Updating Javadoc comments to be more accurate #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mckjac88 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updating Javadoc comments to be more accurate #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25a889e
Update Javadoc comments ChessGame.java
Mckjac88 Jan 30, 2026
d095a36
Update Javadoc comment in ChessPosition.java
Mckjac88 Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions shared/src/main/java/chess/ChessGame.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import java.util.Collection;

/**
* For a class that can manage a chess game, making moves on a board
* A class that can manage a chess game, making moves on a board
* <p>
* Note: You can add to this class, but you may not alter
* signature of the existing methods.
Expand All @@ -22,7 +22,7 @@ public TeamColor getTeamTurn() {
}

/**
* Set's which teams turn it is
* Sets which teams turn it is
*
* @param team the team whose turn it is
*/
Expand All @@ -39,7 +39,7 @@ public enum TeamColor {
}

/**
* Gets a valid moves for a piece at the given location
* Gets all valid moves for a piece at the given location
*
* @param startPosition the piece to get valid moves for
* @return Set of valid moves for requested piece, or null if no piece at
Expand All @@ -50,7 +50,7 @@ public Collection<ChessMove> validMoves(ChessPosition startPosition) {
}

/**
* Makes a move in a chess game
* Makes a move in the chess game
*
* @param move chess move to perform
* @throws InvalidMoveException if move is invalid
Expand Down Expand Up @@ -91,7 +91,7 @@ public boolean isInStalemate(TeamColor teamColor) {
}

/**
* Sets this game's chessboard with a given board
* Sets this game's chessboard to a given board
*
* @param board the new board to use
*/
Expand Down
2 changes: 1 addition & 1 deletion shared/src/main/java/chess/ChessPosition.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public int getRow() {

/**
* @return which column this position is in
* 1 codes for the left row
* 1 codes for the left column
*/
public int getColumn() {
throw new RuntimeException("Not implemented");
Expand Down