Skip to content

Commit 9e1eb38

Browse files
committed
Naming fixes for documentation and method names
1 parent 3ab7d65 commit 9e1eb38

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

src/main/java/bwapi/DamageType.java

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

33
/**
4-
* Namespace containing damage types.
5-
*
6-
* @see DamageType
4+
* Enum containing damage types.
75
*
86
* [View on Liquipedia](http://wiki.teamliquid.net/starcraft/Damage_Type)<br>
97
* [View on Starcraft Campendium (Official Website)](http://classic.battle.net/scc/gs/damage.shtml)<br>

src/main/java/bwapi/DefaultBWListener.java

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
package bwapi;
22

3+
/**
4+
* Convenience class that extends all methods in {@link BWEventListener}.
5+
* Not all of the methods need an implementation.
6+
*/
37
public class DefaultBWListener implements BWEventListener {
48

59
public void onStart() {
610
}
711

8-
public void onEnd(final boolean b) {
12+
public void onEnd(final boolean isWinner) {
913
}
1014

1115
public void onFrame() {
1216
}
1317

14-
public void onSendText(final String s) {
18+
public void onSendText(final String text) {
1519
}
1620

17-
public void onReceiveText(final Player player, final String s) {
21+
public void onReceiveText(final Player player, final String text) {
1822
}
1923

2024
public void onPlayerLeft(final Player player) {
@@ -47,7 +51,7 @@ public void onUnitMorph(final Unit unit) {
4751
public void onUnitRenegade(final Unit unit) {
4852
}
4953

50-
public void onSaveGame(final String s) {
54+
public void onSaveGame(final String text) {
5155
}
5256

5357
public void onUnitComplete(final Unit unit) {

src/main/java/bwapi/EventType.java

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

55
/**
6-
* Contains a list of event types supported by BWAPI.
6+
* Enum of event types supported by BWAPI.
77
*/
88
public enum EventType {
99
MatchStart(0),

0 commit comments

Comments
 (0)