Skip to content

Commit 5303c10

Browse files
committed
more javadoc
1 parent a280d21 commit 5303c10

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

src/main/java/com/exaroton/api/server/PlayerList.java

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public String getName() {
3333

3434
/**
3535
* @return players in list
36-
* @throws APIException
36+
* @throws APIException API error
3737
*/
3838
public String[] getEntries() throws APIException {
3939
GetPlayerListEntriesRequest request = new GetPlayerListEntriesRequest(this.client, this.server, this.name);
@@ -42,7 +42,8 @@ public String[] getEntries() throws APIException {
4242

4343
/**
4444
* add players to list
45-
* @throws APIException
45+
* @param entries player names
46+
* @throws APIException API error
4647
*/
4748
public void add(String[] entries) throws APIException {
4849
AddPlayerListEntriesRequest request = new AddPlayerListEntriesRequest(this.client, this.server, this.name, entries);
@@ -51,15 +52,17 @@ public void add(String[] entries) throws APIException {
5152

5253
/**
5354
* add player to list
54-
* @throws APIException
55+
* @param entry player name
56+
* @throws APIException API error
5557
*/
5658
public void add(String entry) throws APIException {
5759
this.add(new String[]{entry});
5860
}
5961

6062
/**
6163
* remove players from list
62-
* @throws APIException
64+
* @param entries player names
65+
* @throws APIException API error
6366
*/
6467
public void remove(String[] entries) throws APIException {
6568
RemovePlayerListEntriesRequest request = new RemovePlayerListEntriesRequest(this.client, this.server, this.name, entries);
@@ -68,7 +71,8 @@ public void remove(String[] entries) throws APIException {
6871

6972
/**
7073
* remove player from list
71-
* @throws APIException
74+
* @param entry player name
75+
* @throws APIException API error
7276
*/
7377
public void remove(String entry) throws APIException {
7478
this.remove(new String[]{entry});

0 commit comments

Comments
 (0)