Skip to content

Commit 62a20f0

Browse files
committed
Fix force & flag & explosiontype javadoc
1 parent 9e1eb38 commit 62a20f0

File tree

3 files changed

+9
-15
lines changed

3 files changed

+9
-15
lines changed

src/main/java/bwapi/ExplosionType.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
package bwapi;
22

33
/**
4-
* Namespace containing explosion types.
5-
* @see ExplosionType
4+
* Enum containing explosion types.
65
*/
76
public enum ExplosionType {
87
None(0),

src/main/java/bwapi/Flag.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
/**
44
* Contains flag enumerations for BWAPI.
5-
* @see Game#enableFlag, Game#isFlagEnabled
5+
* @see {@link Game#enableFlag}, {@link Game#isFlagEnabled}
66
*/
77
public enum Flag {
88
CompleteMapInformation(0),

src/main/java/bwapi/Force.java

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
import java.util.stream.Collectors;
88

99
/**
10-
* The Force class is used to get information about each force in a match.
10+
* The {@link Force} class is used to get information about each force in a match.
1111
* Normally this is considered a team.
1212
*
13-
* @note It is not called a team because players on the same force do not necessarily need
13+
* It is not called a team because players on the same force do not necessarily need
1414
* to be allied at the beginning of a match.
1515
*
1616
*/
@@ -27,32 +27,27 @@ public class Force implements Comparable<Force>{
2727
}
2828

2929
/**
30-
* Retrieves the unique ID that represents this Force.
30+
* Retrieves the unique ID that represents this {@link Force}.
3131
*
32-
* @return An integer containing the ID for the Force.
32+
* @return An integer containing the ID for the {@link Force}.
3333
*/
3434
public int getID() {
3535
return id;
3636
}
3737

3838
/**
39-
* Retrieves the name of the Force.
39+
* Retrieves the name of the {@link Force}.
4040
*
4141
* @return A String object containing the name of the force.
42-
*
43-
*
44-
* @note Don't forget to use String when passing this parameter to
45-
* Game#sendText and other variadic functions.
4642
*/
4743
public String getName() {
4844
return name;
4945
}
5046

5147
/**
52-
* Retrieves the set of players that belong to this Force.
53-
*
54-
* @return A List<Player> object containing the players that are part of this Force.
48+
* Retrieves the set of players that belong to this {@link Force}.
5549
*
50+
* @return A List<Player> object containing the players that are part of this {@link Force}.
5651
*/
5752
public List<Player> getPlayers() {
5853
return game.getPlayers().stream()

0 commit comments

Comments
 (0)