Skip to content

Commit 62d475e

Browse files
author
Bytekeeper
committed
Fixed @see warnings
1 parent bb522cf commit 62d475e

File tree

16 files changed

+583
-298
lines changed

16 files changed

+583
-298
lines changed

src/main/java/bwapi/Bullet.java

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
* If {@link Flag#CompleteMapInformation} is disabled, then a {@link Bullet} is accessible if and only if
2424
* it is visible. Otherwise if {@link Flag#CompleteMapInformation} is enabled, then all Bullets
2525
* in the game are accessible.
26-
* @see {@link Game#getBullets}, {@link Bullet#exists}
26+
* @see Game#getBullets
27+
* @see Bullet#exists
2728
*/
2829
public class Bullet implements Comparable<Bullet> {
2930
private final BulletData bulletData;
@@ -56,7 +57,8 @@ public int getID() {
5657
* {@link Bullet} information.
5758
*
5859
* @return true if the bullet exists or is visible, false if the bullet was destroyed or has gone out of scope.
59-
* @see {@link #isVisible}, {@link Unit#exists}
60+
* @see #isVisible
61+
* @see Unit#exists
6062
*/
6163
public boolean exists() {
6264
return bulletData.getExists();
@@ -84,7 +86,7 @@ public BulletType getType() {
8486
* Retrieves the {@link Unit} that the {@link Bullet} spawned from.
8587
*
8688
* @return The owning {@link Unit} object. Returns null if the source can not be identified or is inaccessible.
87-
* @see {@link #getTarget}
89+
* @see #getTarget
8890
*/
8991
public Unit getSource() {
9092
return game.getUnit(bulletData.getSource());
@@ -94,7 +96,7 @@ public Unit getSource() {
9496
* Retrieves the Bullet's current position.
9597
*
9698
* @return A {@link Position} containing the Bullet's current coordinates. Returns {@link Position#Unknown} if the {@link Bullet} is inaccessible.
97-
* @see {@link #getTargetPosition}
99+
* @see #getTargetPosition
98100
*/
99101
public Position getPosition() {
100102
return new Position(bulletData.getPositionX(), bulletData.getPositionY());
@@ -115,7 +117,8 @@ public double getAngle() {
115117
*
116118
* @return A double representing the number of pixels moved on the X axis per frame. Returns 0.0 if the {@link Bullet} is inaccessible.
117119
*
118-
* @see {@link #getVelocityY}, {@link #getAngle}
120+
* @see #getVelocityY
121+
* @see #getAngle
119122
*/
120123
public double getVelocityX() {
121124
return bulletData.getVelocityX();
@@ -126,7 +129,8 @@ public double getVelocityX() {
126129
*
127130
* @return A double representing the number of pixels moved on the Y axis per frame. Returns 0.0 if the {@link Bullet} is inaccessible.
128131
*
129-
* @see {@link #getVelocityX}, {@link #getAngle}
132+
* @see #getVelocityX
133+
* @see #getAngle
130134
*/
131135
public double getVelocityY() {
132136
return bulletData.getVelocityY();
@@ -136,7 +140,8 @@ public double getVelocityY() {
136140
* Retrieves the Unit interface that the {@link Bullet} is heading to.
137141
*
138142
* @return The target Unit object, if one exists. Returns null if the Bullet's target {@link Unit} is inaccessible, the {@link Bullet} is targetting the ground, or if the {@link Bullet} itself is inaccessible.
139-
* @see {@link #getTargetPosition}, {@link #getSource}
143+
* @see #getTargetPosition
144+
* @see #getSource
140145
*/
141146
public Unit getTarget() {
142147
return game.getUnit(bulletData.getTarget());
@@ -146,7 +151,8 @@ public Unit getTarget() {
146151
* Retrieves the target position that the {@link Bullet} is heading to.
147152
*
148153
* @return A {@link Position} indicating where the {@link Bullet} is headed. Returns {@link Position#Unknown} if the bullet is inaccessible.
149-
* @see {@link #getTarget}, {@link #getPosition}
154+
* @see #getTarget
155+
* @see #getPosition
150156
*/
151157
public Position getTargetPosition() {
152158
return new Position(bulletData.getTargetPositionX(), bulletData.getTargetPositionY());

src/main/java/bwapi/DamageType.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
*
77
* This corresponds with UnitSizeType to determine the damage done to
88
* a unit.
9-
*
10-
* @see {@link WeaponType}, {@link DamageType}, {@link UnitSizeType}
9+
*
10+
* @see WeaponType
11+
* @see DamageType
12+
* @see UnitSizeType
1113
*
1214
* [View on Liquipedia](http://wiki.teamliquid.net/starcraft/Damage_Type)<br>
1315
* [View on Starcraft Campendium (Official Website)](http://classic.battle.net/scc/gs/damage.shtml)<br>

src/main/java/bwapi/Flag.java

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

33
/**
44
* Contains flag enumerations for BWAPI.
5-
* @see {@link Game#enableFlag}, {@link Game#isFlagEnabled}
5+
* @see Game#enableFlag
6+
* @see Game#isFlagEnabled
67
*/
78
public enum Flag {
89
/**

0 commit comments

Comments
 (0)