Finish documentation for the remaining classes

Author: JasperGeurtz

src/main/java/bwapi/Race.java

@@ -63,27 +63,24 @@ public enum Race {
     }
 
     /**
-     * Retrieves the default worker type for this Race.
+     * Retrieves the default worker type for this {@link Race}.
      *
-     * @note In Starcraft, workers are the units that are used to construct structures.
+     * In Starcraft, workers are the units that are used to construct structures.
      *
-     * @return UnitType of the worker that this race uses.
+     * @return {@link UnitType} of the worker that this race uses.
      */
     public UnitType getWorker() {
         return workerTypes[id];
     }
 
-    // DATA
-
-    //@since 4.2.0
     /**
-     * Retrieves the default resource depot UnitType that workers of this race can
+     * Retrieves the default resource depot {@link UnitType} that workers of this race can
      * construct and return resources to.
      *
-     * @note In Starcraft, the center is the very first structure of the Race's technology
+     * In Starcraft, the center is the very first structure of the Race's technology
      * tree. Also known as its base of operations or resource depot.
      *
-     * @return UnitType of the center that this race uses.
+     * @return {@link UnitType} of the center that this race uses.
      *
      * @since 4.2.0
      */
@@ -102,39 +99,38 @@ public UnitType getCenter() {
     }
 
     /**
-     * Retrieves the default structure UnitType for this Race that is used to harvest gas from
-     * @Geysers.
+     * Retrieves the default structure UnitType for this Race that is used to harvest gas from @Geysers.
      *
-     * @note In Starcraft, you must first construct a structure over a @Geyser in order to
+     * In Starcraft, you must first construct a structure over a @Geyser in order to
      * begin harvesting Vespene Gas.
      *
-     * @return UnitType of the structure used to harvest gas.
+     * @return {@link UnitType} of the structure used to harvest gas.
      */
     public UnitType getRefinery() {
         return refineryTypes[id];
     }
 
     /**
-     * Retrieves the default transport UnitType for this race that is used to transport ground
+     * Retrieves the default transport {@link UnitType} for this race that is used to transport ground
      * units across the map.
      *
-     * @note In Starcraft, transports will allow you to carry ground units over unpassable
+     * In Starcraft, transports will allow you to carry ground units over unpassable
      * terrain.
      *
-     * @return UnitType for transportation.
+     * @return {@link UnitType} for transportation.
      */
     public UnitType getTransport() {
         return transportTypes[id];
     }
 
     /**
-     * Retrieves the default supply provider UnitType for this race that is used to  construct
+     * Retrieves the default supply provider {@link UnitType} for this race that is used to  construct
      * units.
      *
-     * @note In Starcraft, training, morphing, or warping in units requires that the player
+     * In Starcraft, training, morphing, or warping in units requires that the player
      * has sufficient supply available for their Race.
      *
-     * @return UnitType that provides the player with supply.
+     * @return {@link UnitType} that provides the player with supply.
      */
     public UnitType getSupplyProvider() {
         return supplyTypes[id];

src/main/java/bwapi/Region.java

@@ -13,7 +13,7 @@
  *
  * Most parameters that are available are explicitly assigned by Broodwar itself.
  *
- * @see Game#getAllRegions, Game#getRegionAt, Unit#getRegion
+ * @see {@link Game#getAllRegions}, {@link Game#getRegionAt}, {@link Unit#getRegion}
  */
 public class Region implements Comparable<Region> {
     private final RegionData regionData;
@@ -74,10 +74,10 @@ void updateNeighbours() {
     /**
      * Retrieves a unique identifier for this region.
      *
-     * @note This identifier is explicitly assigned by Broodwar.
+     * This identifier is explicitly assigned by Broodwar.
      *
      * @return An integer that represents this region.
-     * @see Game#getRegion
+     * @see {@link Game#getRegion}
      */
     public int getID() {
         return id;
@@ -89,7 +89,7 @@ public int getID() {
      * group ID. This function is generally used to check if a path is available between two
      * points in constant time.
      *
-     * @note This identifier is explicitly assigned by Broodwar.
+     * This identifier is explicitly assigned by Broodwar.
      *
      * @return An integer that represents the group of regions that this one is attached to.
      */
@@ -101,7 +101,7 @@ public int getRegionGroupID() {
      * Retrieves the center of the region. This position is used as the node
      * of the region.
      *
-     * @return A Position indicating the center location of the Region, in pixels.
+     * @return A {@link Position} indicating the center location of the Region, in pixels.
      */
     public Position getCenter() {
         return center;
@@ -122,7 +122,7 @@ public boolean isHigherGround() {
      * to other regions. A value of 2 may indicate a possible choke point, and a value
      * of 3 indicates a signficant strategic position.
      *
-     * @note This value is explicitly assigned by Broodwar.
+     * This value is explicitly assigned by Broodwar.
      *
      * @return An integer indicating this region's strategic potential.
      */
@@ -189,7 +189,7 @@ public int getBoundsBottom() {
     /**
      * Retrieves the closest accessible neighbor region.
      *
-     * @return The closest Region that is accessible.
+     * @return The closest {@link Region} that is accessible.
      */
     public Region getClosestAccessibleRegion() {
         return closestAccessibleRegion;
@@ -198,7 +198,7 @@ public Region getClosestAccessibleRegion() {
     /**
      * Retrieves the closest inaccessible neighbor region.
      *
-     * @return The closest Region that is inaccessible.
+     * @return The closest {@link Region} that is inaccessible.
      */
     public Region getClosestInaccessibleRegion() {
         return closestInaccessibleRegion;
@@ -207,9 +207,9 @@ public Region getClosestInaccessibleRegion() {
     /**
      * Retrieves the center-to-center distance between two regions.
      *
-     * @note Ignores all collisions.
+     * Ignores all collisions.
      *
-     * @param other The target Region to calculate distance to.
+     * @param other The target {@link Region} to calculate distance to.
      * @return The integer distance from this Region to \p other.
      */
     public int getDistance(final Region other) {
@@ -229,7 +229,7 @@ public List<Unit> getUnits() {
      * @return A List<Unit> containing all units in this region that have met the requirements
      * of \p pred.
      *
-     * @see UnitFilter
+     * @see {@link UnitFilter}
      */
     public List<Unit> getUnits(final UnitFilter pred) {
         return game.getUnitsInRectangle(getBoundsLeft(), getBoundsTop(), getBoundsRight(), getBoundsBottom(),

src/main/java/bwapi/TechType.java

@@ -198,12 +198,12 @@ public enum TechType {
     }
 
     /**
-     * Retrieves the race that is required to research or use the TechType.
+     * Retrieves the race that is required to research or use the {@link TechType}.
      *
-     * @note There is an exception where @Infested_Kerrigan can use @Psi_Storm. This does not
+     * There is an exception where @Infested_Kerrigan can use @Psi_Storm. This does not
      * apply to the behavior of this function.
      *
-     * @return Race object indicating which race is designed to use this technology type.
+     * @return {@link Race} object indicating which race is designed to use this technology type.
      */
     public Race getRace() {
         return techRaces[id];
@@ -231,27 +231,27 @@ public int gasPrice() {
      * Retrieves the number of frames needed to research the tech type.
      *
      * @return The time, in frames, it will take for the research to complete.
-     * @see Unit#getRemainingResearchTime
+     * @see {@link Unit#getRemainingResearchTime}
      */
     public int researchTime() {
         return defaultTimeCost[id];
     }
 
     /**
-     * Retrieves the amount of energy needed to use this TechType as an ability.
+     * Retrieves the amount of energy needed to use this {@link TechType} as an ability.
      *
      * @return Energy cost of the ability.
-     * @see Unit#getEnergy
+     * @see {@link Unit#getEnergy}
      */
     public int energyCost() {
         return defaultEnergyCost[id];
     }
 
     /**
-     * Retrieves the UnitType that can research this technology.
+     * Retrieves the {@link UnitType} that can research this technology.
      *
      * @return UnitType that is able to research the technology in the game.
-     * @retval UnitType.None If the technology/ability is either provided for free or never
+     * Returns {@link UnitType#None} If the technology/ability is either provided for free or never
      * available.
      */
     public UnitType whatResearches() {
@@ -260,11 +260,11 @@ public UnitType whatResearches() {
 
     /**
      * Retrieves the Weapon that is attached to this tech type.
-     * A technology's WeaponType is used to indicate the range and behaviour of the ability
+     * A technology's {@link WeaponType} is used to indicate the range and behaviour of the ability
      * when used by a Unit.
      *
      * @return WeaponType containing information about the ability's behavior.
-     * @retval WeaponType.None If there is no corresponding WeaponType.
+     * Returns {@link WeaponType#None} If there is no corresponding WeaponType.
      */
     public WeaponType getWeapon() {
         return techWeapons[id];
@@ -298,23 +298,23 @@ public List<UnitType> whatUses() {
     }
 
     /**
-     * Retrieves the Order that a Unit uses when using this ability.
+     * Retrieves the {@link Order} that a Unit uses when using this ability.
      *
-     * @return Order representing the action a Unit uses to perform this ability
+     * @return {@link Order} representing the action a Unit uses to perform this ability
      */
     public Order getOrder() {
         return techOrders[id];
     }
 
     /**
-     * Retrieves the UnitType required to research this technology.
+     * Retrieves the {@link UnitType} required to research this technology.
      * The required unit type must be a completed unit owned by the player researching the
      * technology.
      *
-     * @return UnitType that is needed to research this tech type.
-     * @retval UnitType.None if no unit is required to research this tech type.
+     * @return {@link UnitType} that is needed to research this tech type.
+     * Returns {@link UnitType#None} if no unit is required to research this tech type.
      *
-     * @see Player#completedUnitCount
+     * @see {@link Player#completedUnitCount}
      *
      * @since 4.1.2
      */

src/main/java/bwapi/Unit.java

@@ -6096,7 +6096,7 @@ public boolean canPlaceCOP(TilePosition target) {
     /**
      * Cheap checks for whether the unit is able to execute a placeCOP command.
      *
-     * @see {@lin Unit#canIssueCommand}, {@link Unit#placeCOP}
+     * @see {@link Unit#canIssueCommand}, {@link Unit#placeCOP}
      */
     public boolean canPlaceCOP(TilePosition target, boolean checkCanIssueCommandType, boolean checkCommandibility) {
         if (checkCommandibility && !canCommand()) {