kske
/
chess
Archived
1
Fork 0
Code Issues 6 Pull Requests Releases 5 Activity

Changed class Javadoc to use @author and @since tags

This commit is contained in:
Kai S. K. Engelbart 2019-10-26 07:55:21 +02:00
parent de015a64fb
commit ae9abded19
Signed by: kske
GPG Key ID: 8BEB13EC5DF7EF13
45 changed files with 141 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/dev/kske/chess/board/Bishop.java
View File

@ -7,7 +7,9 @@ import java.util.List;
* Project: <strong>Chess</strong><br>
* File: <strong>Bishop.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Bishop extends Piece {

4
src/dev/kske/chess/board/Board.java
View File

@ -16,7 +16,9 @@ import dev.kske.chess.board.Piece.Type;
* Project: <strong>Chess</strong><br>
* File: <strong>Board.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Board {

2
src/dev/kske/chess/board/FENString.java
View File

@ -14,8 +14,8 @@ import dev.kske.chess.exception.ChessException;
* Represents a FEN string and enables parsing an existing FEN string or
* serializing a {@link Board} to one.
*
* @since Chess v0.5-alpha
* @author Kai S. K. Engelbart
* @since Chess v0.4-alpha
*/
public class FENString {

4
src/dev/kske/chess/board/GameState.java
View File

@ -4,7 +4,9 @@ package dev.kske.chess.board;
* Project: <strong>Chess</strong><br>
* File: <strong>GameState.java</strong><br>
* Created: <strong>07.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public enum GameState {
CHECK, CHECKMATE, STALEMATE, NORMAL;

4
src/dev/kske/chess/board/King.java
View File

@ -7,7 +7,9 @@ import java.util.List;
* Project: <strong>Chess</strong><br>
* File: <strong>King.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class King extends Piece {

4
src/dev/kske/chess/board/Knight.java
View File

@ -7,7 +7,9 @@ import java.util.List;
* Project: <strong>Chess</strong><br>
* File: <strong>Knight.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Knight extends Piece {

4
src/dev/kske/chess/board/Log.java
View File

@ -11,7 +11,9 @@ import dev.kske.chess.board.Piece.Type;
* Project: <strong>Chess</strong><br>
* File: <strong>Log.java</strong><br>
* Created: <strong>09.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Log implements Iterable<MoveNode> {

4
src/dev/kske/chess/board/Move.java
View File

@ -6,7 +6,9 @@ import java.util.Objects;
* Project: <strong>Chess</strong><br>
* File: <strong>Move.java</strong><br>
* Created: <strong>02.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Move {

4
src/dev/kske/chess/board/MoveNode.java
View File

@ -11,7 +11,9 @@ import dev.kske.chess.board.Piece.Color;
* Project: <strong>Chess</strong><br>
* File: <strong>MoveNode.java</strong><br>
* Created: <strong>02.10.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.5-alpha
* @author Kai S. K. Engelbart
*/
public class MoveNode {

4
src/dev/kske/chess/board/Pawn.java
View File

@ -7,7 +7,9 @@ import java.util.List;
* Project: <strong>Chess</strong><br>
* File: <strong>Pawn.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Pawn extends Piece {

4
src/dev/kske/chess/board/Piece.java
View File

@ -8,7 +8,9 @@ import java.util.Objects;
* Project: <strong>Chess</strong><br>
* File: <strong>Piece.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public abstract class Piece implements Cloneable {

4
src/dev/kske/chess/board/Position.java
View File

@ -4,7 +4,9 @@ package dev.kske.chess.board;
* Project: <strong>Chess</strong><br>
* File: <strong>Position.java</strong><br>
* Created: <strong>02.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Position {

4
src/dev/kske/chess/board/Queen.java
View File

@ -7,7 +7,9 @@ import java.util.List;
* Project: <strong>Chess</strong><br>
* File: <strong>Queen.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Queen extends Piece {

4
src/dev/kske/chess/board/Rook.java
View File

@ -7,7 +7,9 @@ import java.util.List;
* Project: <strong>Chess</strong><br>
* File: <strong>Rook.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Rook extends Piece {

4
src/dev/kske/chess/event/Event.java
View File

@ -4,7 +4,9 @@ package dev.kske.chess.event;
* Project: <strong>Chess</strong><br>
* File: <strong>Event.java</strong><br>
* Created: <strong>7 Aug 2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.4-alpha
* @author Kai S. K. Engelbart
*/
public interface Event<T> {

4
src/dev/kske/chess/event/EventBus.java
View File

@ -7,7 +7,9 @@ import java.util.List;
* Project: <strong>Chess</strong><br>
* File: <strong>EventBus.java</strong><br>
* Created: <strong>7 Aug 2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.4-alpha
* @author Kai S. K. Engelbart
*/
public class EventBus {

4
src/dev/kske/chess/event/MoveEvent.java
View File

@ -6,7 +6,9 @@ import dev.kske.chess.board.Move;
* Project: <strong>Chess</strong><br>
* File: <strong>MoveEvent.java</strong><br>
* Created: <strong>7 Aug 2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.4-alpha
* @author Kai S. K. Engelbart
*/
public class MoveEvent implements Event<Move> {

4
src/dev/kske/chess/event/Subscribable.java
View File

@ -6,7 +6,9 @@ import java.util.Set;
* Project: <strong>Chess</strong><br>
* File: <strong>Subscribable.java</strong><br>
* Created: <strong>7 Aug 2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.4-alpha
* @author Kai S. K. Engelbart
*/
public interface Subscribable {

4
src/dev/kske/chess/exception/ChessException.java
View File

@ -4,7 +4,9 @@ package dev.kske.chess.exception;
* Project: <strong>Chess</strong><br>
* File: <strong>ChessException.java</strong><br>
* Created: <strong>22 Sep 2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.5-alpha
* @author Kai S. K. Engelbart
*/
public class ChessException extends Exception {

4
src/dev/kske/chess/game/Game.java
View File

@ -22,7 +22,9 @@ import dev.kske.chess.ui.OverlayComponent;
* Project: <strong>Chess</strong><br>
* File: <strong>Game.java</strong><br>
* Created: <strong>06.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class Game {

4
src/dev/kske/chess/game/NaturalPlayer.java
View File

@ -16,7 +16,9 @@ import dev.kske.chess.ui.OverlayComponent;
* Project: <strong>Chess</strong><br>
* File: <strong>NaturalPlayer.java</strong><br>
* Created: <strong>06.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class NaturalPlayer extends Player implements MouseListener {

4
src/dev/kske/chess/game/Player.java
View File

@ -7,7 +7,9 @@ import dev.kske.chess.board.Piece.Color;
* Project: <strong>Chess</strong><br>
* File: <strong>Player.java</strong><br>
* Created: <strong>06.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public abstract class Player {

4
src/dev/kske/chess/game/UCIPlayer.java
View File

@ -12,7 +12,9 @@ import dev.kske.chess.uci.UCIListener;
* Project: <strong>Chess</strong><br>
* File: <strong>UCIPlayer.java</strong><br>
* Created: <strong>18.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.3-alpha
* @author Kai S. K. Engelbart
*/
public class UCIPlayer extends Player implements UCIListener {

4
src/dev/kske/chess/game/ai/AIPlayer.java
View File

@ -19,7 +19,9 @@ import dev.kske.chess.game.Player;
* Project: <strong>Chess</strong><br>
* File: <strong>AIPlayer.java</strong><br>
* Created: <strong>06.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class AIPlayer extends Player {

4
src/dev/kske/chess/game/ai/MoveProcessor.java
View File

@ -11,7 +11,9 @@ import dev.kske.chess.board.Piece.Color;
* Project: <strong>Chess</strong><br>
* File: <strong>MoveProcessor.java</strong><br>
* Created: <strong>08.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class MoveProcessor implements Callable<ProcessingResult> {

4
src/dev/kske/chess/game/ai/ProcessingResult.java
View File

@ -6,7 +6,9 @@ import dev.kske.chess.board.Move;
* Project: <strong>Chess</strong><br>
* File: <strong>ProcessingResult.java</strong><br>
* Created: <strong>08.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class ProcessingResult {

5
src/dev/kske/chess/io/EngineUtil.java
View File

@ -16,7 +16,10 @@ import dev.kske.chess.uci.UCIListener;
* Project: <strong>Chess</strong><br>
* File: <strong>MenuBar.java</strong><br>
* Created: <strong>23.07.2019</strong><br>
* Author: <strong>Leon Hofmeister</strong>
*
* @since Chess v0.2-alpha
* @author Kai S. K. Engelbart
* @author Leon Hofmeister
*/
public class EngineUtil {

8
src/dev/kske/chess/io/TextureUtil.java
View File

@ -15,7 +15,9 @@ import dev.kske.chess.board.Piece;
* Project: <strong>Chess</strong><br>
* File: <strong>TextureUtil.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class TextureUtil {
@ -39,7 +41,6 @@ public class TextureUtil {
return scaledTextures.get(key);
}
/**
* Scales all piece textures to fit the current tile size.
*
@ -47,8 +48,7 @@ public class TextureUtil {
*/
public static void scalePieceTextures(int tileSize) {
scaledTextures.clear();
textures
.forEach((key, img) -> scaledTextures.put(key, img.getScaledInstance(tileSize, tileSize, Image.SCALE_SMOOTH)));
textures.forEach((key, img) -> scaledTextures.put(key, img.getScaledInstance(tileSize, tileSize, Image.SCALE_SMOOTH)));
}
/**

4
src/dev/kske/chess/pgn/PGNDatabase.java
View File

@ -12,7 +12,9 @@ import dev.kske.chess.exception.ChessException;
* Project: <strong>Chess</strong><br>
* File: <strong>PGNDatabase.java</strong><br>
* Created: <strong>4 Oct 2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.5-alpha
* @author Kai S. K. Engelbart
*/
public class PGNDatabase {

4
src/dev/kske/chess/pgn/PGNGame.java
View File

@ -14,7 +14,9 @@ import dev.kske.chess.exception.ChessException;
* Project: <strong>Chess</strong><br>
* File: <strong>PGNGame.java</strong><br>
* Created: <strong>22 Sep 2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.5-alpha
* @author Kai S. K. Engelbart
*/
public class PGNGame {

4
src/dev/kske/chess/uci/UCIHandle.java
View File

@ -7,7 +7,9 @@ import java.io.PrintWriter;
* Project: <strong>Chess</strong><br>
* File: <strong>UCIHandle.java</strong><br>
* Created: <strong>18.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.3-alpha
* @author Kai S. K. Engelbart
*/
public class UCIHandle {

7
src/dev/kske/chess/uci/UCIInfo.java
View File

@ -10,12 +10,13 @@ import dev.kske.chess.board.Move;
* Project: <strong>Chess</strong><br>
* File: <strong>UCIInfo.java</strong><br>
* Created: <strong>28.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.3-alpha
* @author Kai S. K. Engelbart
*/
public class UCIInfo {
private int depth, seldepth, time, nodes, multipv, currmovenumber, hashfull, nps, tbhits, sbhits, cpuload,
cpunr;
private int depth, seldepth, time, nodes, multipv, currmovenumber, hashfull, nps, tbhits, sbhits, cpuload, cpunr;
private List<Move> pv, refutation, currline;
private Move currmove;
private Score score;

5
src/dev/kske/chess/uci/UCIListener.java
View File

@ -6,7 +6,9 @@ import dev.kske.chess.board.Move;
* Project: <strong>Chess</strong><br>
* File: <strong>UCIListener.java</strong><br>
* Created: <strong>19.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.3-alpha
* @author Kai S. K. Engelbart
*/
public interface UCIListener {
@ -53,6 +55,7 @@ public interface UCIListener {
* The engine will check the copy protection now.
*/
default void onCopyProtectionChecking() {}
/**
* The engine has successfully checked the copy protection.
*/

4
src/dev/kske/chess/uci/UCIOption.java
View File

@ -9,7 +9,9 @@ import java.util.StringJoiner;
* Project: <strong>Chess</strong><br>
* File: <strong>UCIOption.java</strong><br>
* Created: <strong>22.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.3-alpha
* @author Kai S. K. Engelbart
*/
public class UCIOption {

16
src/dev/kske/chess/uci/UCIReceiver.java
View File

@ -13,7 +13,9 @@ import dev.kske.chess.board.Move;
* Project: <strong>Chess</strong><br>
* File: <strong>UCIReceiver.java</strong><br>
* Created: <strong>19.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.3-alpha
* @author Kai S. K. Engelbart
*/
public class UCIReceiver implements Runnable {
@ -129,15 +131,9 @@ public class UCIReceiver implements Runnable {
}
}
private void parseInfo(String line) {
listeners.forEach(l -> l.onInfo(new UCIInfo(line)));
}
private void parseInfo(String line) { listeners.forEach(l -> l.onInfo(new UCIInfo(line))); }
private void parseOption(String line) {
listeners.forEach(l -> l.onOption(new UCIOption((line))));
}
private void parseOption(String line) { listeners.forEach(l -> l.onOption(new UCIOption((line)))); }
public void addListener(UCIListener listener) {
listeners.add(listener);
}
public void addListener(UCIListener listener) { listeners.add(listener); }
}

5
src/dev/kske/chess/ui/AIConfigDialog.java
View File

@ -12,8 +12,11 @@ import javax.swing.SpinnerNumberModel;
* Project: <strong>Chess</strong><br>
* File: <strong>AIConfigDialog.java</strong><br>
* Created: <strong>16.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
@Deprecated
public class AIConfigDialog extends JDialog {
private static final long serialVersionUID = -8047984368152479992L;

8
src/dev/kske/chess/ui/BoardComponent.java
View File

@ -12,11 +12,13 @@ import dev.kske.chess.io.TextureUtil;
* Project: <strong>Chess</strong><br>
* File: <strong>BoardComponent.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong><br>
* <br>
* A square panel for rendering the chess board. To work correctly,
* this must be added to a parent component that allows the child to decide the
* size.
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class BoardComponent extends JComponent {
@ -48,8 +50,8 @@ public class BoardComponent extends JComponent {
// Draw the pieces if a board is present
if (board != null) for (int i = 0; i < 8; i++)
for (int j = 0; j < 8; j++)
if (board.getBoardArr()[i][j] != null) g.drawImage(TextureUtil
.getPieceTexture(board.getBoardArr()[i][j]), i * tileSize, j * tileSize, this);
if (board.getBoardArr()[i][j] != null)
g.drawImage(TextureUtil.getPieceTexture(board.getBoardArr()[i][j]), i * tileSize, j * tileSize, this);
}
public int getTileSize() { return boardPane.getTileSize(); }

4
src/dev/kske/chess/ui/BoardPane.java
View File

@ -8,7 +8,9 @@ import javax.swing.JLayeredPane;
* Project: <strong>Chess</strong><br>
* File: <strong>BoardPane.java</strong><br>
* Created: <strong>08.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class BoardPane extends JLayeredPane {

4
src/dev/kske/chess/ui/DialogUtil.java
View File

@ -23,7 +23,9 @@ import dev.kske.chess.io.EngineUtil;
* Project: <strong>Chess</strong><br>
* File: <strong>DialogUtil.java</strong><br>
* Created: <strong>24.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.3-alpha
* @author Kai S. K. Engelbart
*/
public class DialogUtil {

4
src/dev/kske/chess/ui/GameDropTarget.java
View File

@ -13,7 +13,9 @@ import java.util.List;
* Project: <strong>Chess</strong><br>
* File: <strong>GameDropTarget.java</strong><br>
* Created: <strong>13 Aug 2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.3-alpha
* @author Kai S. K. Engelbart
*/
public class GameDropTarget extends DropTargetAdapter {

4
src/dev/kske/chess/ui/GamePane.java
View File

@ -29,7 +29,9 @@ import dev.kske.chess.game.NaturalPlayer;
* Project: <strong>Chess</strong><br>
* File: <strong>GamePane.java</strong><br>
* Created: <strong>23.08.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.4-alpha
* @author Kai S. K. Engelbart
*/
public class GamePane extends JComponent {

4
src/dev/kske/chess/ui/MainWindow.java
View File

@ -24,7 +24,9 @@ import dev.kske.chess.pgn.PGNGame;
* Project: <strong>Chess</strong><br>
* File: <strong>MainWindow.java</strong><br>
* Created: <strong>01.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class MainWindow extends JFrame {

4
src/dev/kske/chess/ui/MenuBar.java
View File

@ -17,7 +17,9 @@ import dev.kske.chess.io.EngineUtil;
* Project: <strong>Chess</strong><br>
* File: <strong>MenuBar.java</strong><br>
* Created: <strong>16.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class MenuBar extends JMenuBar {

1
src/dev/kske/chess/ui/MoveNodeRenderer.java
View File

@ -15,6 +15,7 @@ import dev.kske.chess.board.MoveNode;
* File: <strong>MoveNodeRenderer.java</strong><br>
* Created: <strong>9 Oct 2019</strong><br>
*
* @since Chess v0.5-alpha
* @author Kai S. K. Engelbart
*/
public class MoveNodeRenderer extends JLabel implements ListCellRenderer<MoveNode> {

4
src/dev/kske/chess/ui/OverlayComponent.java
View File

@ -20,7 +20,9 @@ import dev.kske.chess.board.Position;
* Project: <strong>Chess</strong><br>
* File: <strong>OverlayComponent.java</strong><br>
* Created: <strong>08.07.2019</strong><br>
* Author: <strong>Kai S. K. Engelbart</strong>
*
* @since Chess v0.1-alpha
* @author Kai S. K. Engelbart
*/
public class OverlayComponent extends JComponent {