JavaDoc fixes

tastybento · Feb 18, 2018 · 488a8f1 · 488a8f1
1 parent 55a0b3d
commit 488a8f1
Show file tree

Hide file tree

Showing 24 changed files with 169 additions and 169 deletions.
diff --git a/pom.xml b/pom.xml
@@ -89,6 +89,9 @@
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>
 				<version>3.0.0</version>
+				<configuration>
+					<additionalJOption>-Xdoclint:none</additionalJOption>
+				</configuration>
 				<executions>
 					<execution>
 						<id>attach-javadocs</id>
@@ -97,9 +100,6 @@
 						</goals>
 					</execution>
 				</executions>
-				<configuration>
-					<failOnError>false</failOnError>
-				</configuration>
 			</plugin>
 		</plugins>
 	</build>

diff --git a/src/com/wasteofplastic/askyblock/ASkyBlockAPI.java b/src/com/wasteofplastic/askyblock/ASkyBlockAPI.java
@@ -70,7 +70,7 @@ protected ASkyBlockAPI(ASkyBlock plugin) {
     }
 
     /**
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return Map of all of the known challenges with a boolean marking
      *         them as complete (true) or incomplete (false). This is a view of the
      *         challenges map that only allows read operations.
@@ -80,7 +80,7 @@ public Map<String, Boolean> getChallengeStatus(UUID playerUUID) {
     }
 
     /**
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return Map of all of the known challenges and how many times each
      *         one has been completed. This is a view of the challenges
      *         map that only allows read operations.
@@ -101,7 +101,7 @@ public Location getHomeLocation(UUID playerUUID) {
      * Returns the island level from the last time it was calculated. Note this
      * does not calculate the island level.
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return the last level calculated for the island or zero if none.
      */
     public int getIslandLevel(UUID playerUUID) {
@@ -112,7 +112,7 @@ public int getIslandLevel(UUID playerUUID) {
      * Returns the island level from the last time it was calculated. Note this
      * does not calculate the island level.
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return the last level calculated for the island or zero if none.
      */
     public long getLongIslandLevel(UUID playerUUID) {
@@ -132,7 +132,7 @@ public long getLongIslandLevel(UUID playerUUID) {
      * You will need to check if the player is in a team and individually set the level of each team member.
      * This value will be overwritten if the players run the build-in level command or if the island level
      * is calculated some other way, e.g. at login or via an admin command.
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @param level - level to set
      */
     public void setIslandLevel(UUID playerUUID, int level) {
@@ -145,7 +145,7 @@ public void setIslandLevel(UUID playerUUID, int level) {
      * or use getIslandLevel(playerUUID). See https://gist.github.com/tastybento/e81d2403c03f2fe26642
      * for example code.
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return true if player has an island, false if not
      */
     public boolean calculateIslandLevel(UUID playerUUID) {
@@ -160,7 +160,7 @@ public boolean calculateIslandLevel(UUID playerUUID) {
      * Provides the location of the player's island, either the team island or
      * their own
      * 
-     * @param playerUUID - players UUID
+     * @param playerUUID - the player's UUID - players UUID
      * @return Location of island
      */
     public Location getIslandLocation(UUID playerUUID) {
@@ -181,7 +181,7 @@ public UUID getOwner(Location location) {
     /**
      * Get Team Leader
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return UUID of Team Leader or null if there is none. Use inTeam to
      *         check.
      */
@@ -193,7 +193,7 @@ public UUID getTeamLeader(UUID playerUUID) {
      * Get a list of team members. This is a copy and changing the return value
      * will not affect the membership.
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return List of team members, including the player. Empty if there are
      *         none.
      */
@@ -204,7 +204,7 @@ public List<UUID> getTeamMembers(UUID playerUUID) {
     /**
      * Provides location of the player's warp sign
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return Location of sign or null if one does not exist
      */
     public Location getWarp(UUID playerUUID) {
@@ -226,15 +226,15 @@ public String getWarpOwner(Location location) {
      * Status of island ownership. Team members do not have islands of their
      * own, only leaders do.
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return true if player has an island, false if the player does not.
      */
     public boolean hasIsland(UUID playerUUID) {
         return plugin.getPlayers().hasIsland(playerUUID);
     }
 
     /**
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return true if in a team
      */
     public boolean inTeam(UUID playerUUID) {
@@ -342,7 +342,7 @@ public boolean setIslandBiome(Location islandLoc, Biome biomeType) {
     /**
      * Sets a message for the player to receive next time they login
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @param message - message to set
      * @return true if player is offline, false if online
      */
@@ -354,7 +354,7 @@ public boolean setMessage(UUID playerUUID, String message) {
      * Sends a message to every player in the team that is offline If the player
      * is not in a team, nothing happens.
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @param message - message to send
      */
     public void tellOfflineTeam(UUID playerUUID, String message) {
@@ -458,7 +458,7 @@ public Map<UUID, Long> getLongTopTen() {
 
     /**
      * Obtains a copy of the island object owned by playerUUID
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return copy of Island object
      */
     public Island getIslandOwnedBy(UUID playerUUID) {
@@ -527,7 +527,7 @@ public LinkedHashMap<String, List<String>> getAllChallenges(){
 
     /**
      * Get the number of resets left for this player
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return Number of resets left
      */
     public int getResetsLeft(UUID playerUUID) {
@@ -536,7 +536,7 @@ public int getResetsLeft(UUID playerUUID) {
 
     /**
      * Set the number of resets left for this player
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @param resets - number to set
      */
     public void setResetsLeft(UUID playerUUID, int resets) {
@@ -545,7 +545,7 @@ public void setResetsLeft(UUID playerUUID, int resets) {
 
     /**
      * Find out if this player is a team leader or not. If the player is not in a team, the result will always be false.
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return true if the player is in a team and is the leader
      */
     public boolean isLeader(UUID playerUUID) {

diff --git a/src/com/wasteofplastic/askyblock/CoopPlay.java b/src/com/wasteofplastic/askyblock/CoopPlay.java
@@ -258,7 +258,7 @@ public void loadCoops() {
 
     /**
      * Gets a serialize list of all the coops for this player. Used when saving the player
-     * @param playerUUID
+     * @param playerUUID - the player's UUID
      * @return List of island location | uuid of invitee
      */
     private List<String> getMyCoops(UUID playerUUID) {
@@ -273,7 +273,7 @@ private List<String> getMyCoops(UUID playerUUID) {
 
     /**
      * Sets a player's coops from string. Used when loading a player.
-     * @param playerUUID
+     * @param playerUUID - the player's UUID
      * @param coops
      */
     private void setMyCoops(UUID playerUUID, List<String> coops) {

diff --git a/src/com/wasteofplastic/askyblock/Messages.java b/src/com/wasteofplastic/askyblock/Messages.java
@@ -51,7 +51,7 @@ public Messages(ASkyBlock plugin) {
     /**
      * Returns what messages are waiting for the player or null if none
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return List of messages
      */
     public List<String> getMessages(UUID playerUUID) {
@@ -62,7 +62,7 @@ public List<String> getMessages(UUID playerUUID) {
     /**
      * Clears any messages for player
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      */
     public void clearMessages(UUID playerUUID) {
         messages.remove(playerUUID);
@@ -114,7 +114,7 @@ public boolean loadMessages() {
     /**
      * Provides the messages for the player
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @return List of messages
      */
     public List<String> get(UUID playerUUID) {
@@ -124,7 +124,7 @@ public List<String> get(UUID playerUUID) {
     /**
      * Stores a message for player
      * 
-     * @param playerUUID
+     * @param playerUUID - the player's UUID
      * @param playerMessages
      */
     public void put(UUID playerUUID, List<String> playerMessages) {
@@ -135,7 +135,7 @@ public void put(UUID playerUUID, List<String> playerMessages) {
     /**
      * Sends a message to every player in the team that is offline
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @param message - message to send
      */
     public void tellOfflineTeam(UUID playerUUID, String message) {
@@ -158,7 +158,7 @@ public void tellOfflineTeam(UUID playerUUID, String message) {
     /**
      * Tells all online team members something happened
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @param message - message to send
      */
     public void tellTeam(UUID playerUUID, String message) {
@@ -181,7 +181,7 @@ public void tellTeam(UUID playerUUID, String message) {
     /**
      * Sets a message for the player to receive next time they login
      * 
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @param message - message to set
      * @return true if player is offline, false if online
      */
@@ -201,7 +201,7 @@ public boolean setMessage(UUID playerUUID, String message) {
 
     /**
      * Stores a message without any online check
-     * @param playerUUID - player's UUID
+     * @param playerUUID - the player's UUID - player's UUID
      * @param message - message to store
      */
     public void storeMessage(UUID playerUUID, String message) {