Skip to content

Commit 884a63a

Browse files
authored
Fix Javadoc comments in Error classes (#18)
2 parents 6f647a2 + 983c0fe commit 884a63a

File tree

9 files changed

+32
-9
lines changed

9 files changed

+32
-9
lines changed

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/InvalidPlayerError.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
* Player has no username (somehow)
77
*/
88
public final class InvalidPlayerError extends Error {
9+
/**
10+
* Player has no username (somehow)
11+
*/
912
public InvalidPlayerError() {
1013
super(CloudnodeMSG.getInstance().config().invalidPlayer());
1114
}

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/MessageYourselfError.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
44

5-
/**
6-
* Player has no username (somehow)
7-
*/
85
public final class MessageYourselfError extends Error {
96
public MessageYourselfError() {
107
super(CloudnodeMSG.getInstance().config().messageYourself());

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/NeverJoinedError.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
* Target player has never joined the server
88
*/
99
public final class NeverJoinedError extends Error {
10+
/**
11+
* Target player has never joined the server
12+
*
13+
* @param player the player's username
14+
*/
1015
public NeverJoinedError(final @NotNull String player) {
1116
super(CloudnodeMSG.getInstance().config().neverJoined(player));
1217
}

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/NoPermissionError.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33
import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
44

55
/**
6-
* Player has no username (somehow)
6+
* No permission
77
*/
88
public final class NoPermissionError extends Error {
9+
/**
10+
* No permission
11+
*/
912
public NoPermissionError() {
1013
super(CloudnodeMSG.getInstance().config().noPermission());
1114
}

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/NobodyReplyError.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
44

5-
/**
6-
* Player has no username (somehow)
7-
*/
85
public final class NobodyReplyError extends Error {
96
public NobodyReplyError() {
107
super(CloudnodeMSG.getInstance().config().nobodyReply());

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/NotIgnoredError.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
* That player is not ignored
88
*/
99
public final class NotIgnoredError extends Error {
10+
/**
11+
* That player is not ignored
12+
*
13+
* @param player the player's username
14+
*/
1015
public NotIgnoredError(final @NotNull String player) {
1116
super(CloudnodeMSG.getInstance().config().notIgnored(player));
1217
}

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/NotPlayerError.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
* Only players can use this command
77
*/
88
public final class NotPlayerError extends Error {
9+
/**
10+
* Only players can use this command
11+
*/
912
public NotPlayerError() {
1013
super(CloudnodeMSG.getInstance().config().notPlayer());
1114
}

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/PlayerNotFoundError.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,14 @@
44
import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
55

66
/**
7-
* Player has no username (somehow)
7+
* Player not found
88
*/
99
public final class PlayerNotFoundError extends Error {
10+
/**
11+
* Player not found
12+
*
13+
* @param player the player's username
14+
*/
1015
public PlayerNotFoundError(final @NotNull String player) {
1116
super(CloudnodeMSG.getInstance().config().playerNotFound(player));
1217
}

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/ReplyOfflineError.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,14 @@
44
import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
55

66
/**
7-
* Player has no username (somehow)
7+
* The player that messaged you is no longer online
88
*/
99
public final class ReplyOfflineError extends Error {
10+
/**
11+
* The player that messaged you is no longer online
12+
*
13+
* @param player The player's username
14+
*/
1015
public ReplyOfflineError(final @NotNull String player) {
1116
super(CloudnodeMSG.getInstance().config().replyOffline(player));
1217
}

0 commit comments

Comments
 (0)