Skip to content
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

Documentation and Commenting of Project #1

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Documentation and Commenting of Project #1

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2286fb6
Updated Stone.java to adhere to java documentation standards, and rem…
Mar 7, 2017
a848496
JavaDoc, Comments, and proper formatting added to WrongMoveException.…
Mar 7, 2017
577a1bf
Rename of Dices, and proper comments and documentation of GameDices.java
Mar 7, 2017
c5fc002
JavaDocs for throws parameter added
Mar 7, 2017
d02e08f
Added reference to readme
Mar 7, 2017
f25312b
Modified field accessibility for Game.java as well as commented every…
Mar 8, 2017
6e72ccc
Modified some accessibility for Board.java as well as commented every…
Mar 9, 2017
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
17 changes: 12 additions & 5 deletions src/eu/janinko/games/backgammon/WrongMoveException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
package eu.janinko.games.backgammon;

/**
* Exception Class for invalid Backgammon movements.
*
* @see Exception
*/
public class WrongMoveException extends Exception {


/**
* Exception for requesting invalid moves in Backgammon. For criteria of
* when this exception is used see the Backgammon rules.
*/
public WrongMoveException() {
super("Wrong move!");
}
/**
*
*/
private static final long serialVersionUID = 8184331891011138632L;

// Unique ID corresponding to this exception type
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

serialVersionUID is documented in https://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html and as it's part of Java specification I think it's not necessary to have it commented.

private static final long serialVersionUID = 8184331891011138632L;

}