Skip to content

Commit 3ab7d65

Browse files
committed
Small documentation additions
1 parent c46e0ee commit 3ab7d65

File tree

4 files changed

+15
-7
lines changed

4 files changed

+15
-7
lines changed

src/main/java/bwapi/BWClient.java

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

33
import java.util.Objects;
44

5+
/**
6+
* Client class to connect to the game with.
7+
*/
58
public class BWClient {
69
private final BWEventListener eventListener;
710

@@ -14,10 +17,16 @@ public BWClient(final BWEventListener eventListener) {
1417
this.eventListener = eventListener;
1518
}
1619

20+
/**
21+
* Get the {@link Game} instance of the currently running game.
22+
*/
1723
public Game getGame() {
1824
return handler == null ? null : handler.getGame();
1925
}
2026

27+
/**
28+
* Start the game.
29+
*/
2130
public void startGame() {
2231
while (client == null) {
2332
try {

src/main/java/bwapi/BWEventListener.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
package bwapi;
22

3-
3+
/**
4+
* Interface to extend to be given to a {@link BWClient}.
5+
*/
46
public interface BWEventListener {
57

68
void onStart();

src/main/java/bwapi/BulletType.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
import java.util.Arrays;
44

55
/**
6-
* Namespace containing bullet types.
7-
* @see BulletType
6+
* Enum containing bullet types.
87
*/
98
public enum BulletType {
109
Melee(0),

src/main/java/bwapi/Color.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,8 @@
66
/**
77
* The Color object is used in drawing routines to specify the color to use.
88
*
9-
* @note Starcraft uses a 256 color palette for rendering. Thus, the colors available are
9+
* Starcraft uses a 256 color palette for rendering. Thus, the colors available are
1010
* limited to this palette.
11-
*
12-
* @see Color
1311
*/
1412
public class Color {
1513
public final static Color Red = new Color(111);
@@ -78,7 +76,7 @@ RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESER
7876
* A constructor that uses the color index in the palette that is closest to the
7977
* given rgb values. On its first call, the colors in the palette will be sorted for fast indexing.
8078
*
81-
* @note This function computes the distance of the RGB values and may not be accurate.
79+
* This function computes the distance of the RGB values and may not be accurate.
8280
*
8381
* @param red The amount of red.
8482
* @param green The amount of green.

0 commit comments

Comments
 (0)