javadoc fixes

git-svn-id: svn://192.168.1.10/public/CoffeeMud@17160 0d6f1817-ed0e-0410-87c9-987e46238f29

CHANGES

@@ -1,4 +1,4 @@
-# Build 5.9.7 Release ??/??/2018
+# Build 5.9.7 Release 08/29/2018
    1. Scholars gain XP from visiting bookstores, and can study dissertations.
    2. A lot of the old static strings in rideables are now customizable by editors, Shipwright/Wainwright
    3. Small boats can TENDER themselves to large ships now, and be RAISEd and LOWERd.

com/planet_ink/coffee_mud/CharClasses/interfaces/CharClass.java

@@ -202,9 +202,9 @@ public interface CharClass extends Tickable, StatsAffecting, MsgListener, CMObje
 	public boolean isValidClassDivider(MOB killer, MOB killed, MOB mob, Set<MOB> followers);
 
 	/**
-	 * Returns whether this class, for the given mob of this class, should count in the division 
-	 * of experience gained by the killer for having killed the killed.  Assumes the mob is in the 
-	 * same room, and requires the followers of the killer be passed in.  
+	 * Returns whether this class, for the given mob of this class, should count in the division
+	 * of experience gained by the killer for having killed the killed.  Assumes the mob is in the
+	 * same room, and requires the followers of the killer be passed in.
 	 * @param killer the killer mob
 	 * @param killed who the killer mob killed
 	 * @param mob the mob whose sharing capacity is being evaluated
@@ -214,18 +214,18 @@ public interface CharClass extends Tickable, StatsAffecting, MsgListener, CMObje
 	public boolean canBeADivider(MOB killer, MOB killed, MOB mob, Set<MOB> followers);
 
 	/**
-	 * Returns whether this class, for the given mob of this class, should share in the 
-	 * experience gained by the killer for having killed the killed.  Assumes the mob 
+	 * Returns whether this class, for the given mob of this class, should share in the
+	 * experience gained by the killer for having killed the killed.  Assumes the mob
 	 * is in the same room, and requires the followers of the killer be passed in.
-	 * 
+	 *
 	 * @param killer the killer mob
 	 * @param killed who the killer mob killed
 	 * @param mob the mob whose sharing capacity is being evaluated
 	 * @param followers the killers followers
 	 * @return whether the mob shares in the exp gains
 	 */
 	public boolean canBeABenificiary(MOB killer, MOB killed, MOB mob, Set<MOB> followers);
-	
+
 	/**
 	 * Typically called when a mob gains a level in this class, to allow the class to
 	 * assign any new skills.  Can also be called just to populate a mob with class skills,
@@ -259,7 +259,7 @@ public interface CharClass extends Tickable, StatsAffecting, MsgListener, CMObje
 	/**
 	 * Whenever a uses a skill, this method can return any additional expertise
 	 * granted explicitly by the class.
-	 * @see ExpertiseLibrary.Flag
+	 * @see com.planet_ink.coffee_mud.Libraries.interfaces.ExpertiseLibrary.Flag
 	 * @param host the player or mob whose class is being queried
 	 * @param expertiseCode the expertise code
 	 * @param abilityID the Ability ID
@@ -426,7 +426,7 @@ public interface CharClass extends Tickable, StatsAffecting, MsgListener, CMObje
 	 * @return a list of races, racecats, or ANY
 	 */
 	public String[] getRequiredRaceList();
-	
+
 	/**
 	 * Returns whether the given race matches the required race
 	 * list rules.

com/planet_ink/coffee_mud/Common/interfaces/AccountStats.java

@@ -189,7 +189,7 @@ public interface AccountStats extends CMCommon
 	 * during character creation.  This is independent of the account
 	 * bonus.
 	 * @see AccountStats#setBonusCharStatPoints(int)
-	 * 
+	 *
 	 * @return the number of bonus charstat points
 	 */
 	public int getBonusCharStatPoints();
@@ -199,7 +199,7 @@ public interface AccountStats extends CMCommon
 	 * during character creation.  This is independent of the account
 	 * bonus.
 	 * @see AccountStats#getBonusCharStatPoints()
-	 * 
+	 *
 	 * @param bonus the number of bonus charstat points
 	 */
 	public void setBonusCharStatPoints(int bonus);
@@ -208,9 +208,9 @@ public interface AccountStats extends CMCommon
 	 * Returns the number of bonus common skills available to
 	 * this character.  This is independent of the account
 	 * bonus.
-	 * 
+	 *
 	 * @see AccountStats#setBonusCommonSkillLimits(int)
-	 * 
+	 *
 	 * @return the number of bonus Common points
 	 */
 	public int getBonusCommonSkillLimits();
@@ -219,9 +219,9 @@ public interface AccountStats extends CMCommon
 	 * Sets the number of bonus common skills available to
 	 * this character.  This is independent of the account
 	 * bonus.
-	 * 
+	 *
 	 * @see AccountStats#getBonusCommonSkillLimits()
-	 * 
+	 *
 	 * @param bonus the number of bonus Common points
 	 */
 	public void setBonusCommonSkillLimits(int bonus);
@@ -230,9 +230,9 @@ public interface AccountStats extends CMCommon
 	 * Returns the number of bonus Crafting skills available to
 	 * this character.  This is independent of the account
 	 * bonus.
-	 * 
+	 *
 	 * @see AccountStats#setBonusCraftingSkillLimits(int)
-	 * 
+	 *
 	 * @return the number of bonus Crafting points
 	 */
 	public int getBonusCraftingSkillLimits();
@@ -241,9 +241,9 @@ public interface AccountStats extends CMCommon
 	 * Sets the number of bonus Crafting skills available to
 	 * this character.  This is independent of the account
 	 * bonus.
-	 * 
+	 *
 	 * @see AccountStats#getBonusCraftingSkillLimits()
-	 * 
+	 *
 	 * @param bonus the number of bonus Crafting points
 	 */
 	public void setBonusCraftingSkillLimits(int bonus);
@@ -252,9 +252,9 @@ public interface AccountStats extends CMCommon
 	 * Returns the number of bonus Gathering skills available to
 	 * this character.  This is independent of the account
 	 * bonus.
-	 * 
+	 *
 	 * @see AccountStats#setBonusNonCraftingSkillLimits(int)
-	 * 
+	 *
 	 * @return the number of bonus Gathering points
 	 */
 	public int getBonusNonCraftingSkillLimits();
@@ -263,9 +263,9 @@ public interface AccountStats extends CMCommon
 	 * Sets the number of bonus Gathering skills available to
 	 * this character.  This is independent of the account
 	 * bonus.
-	 * 
+	 *
 	 * @see AccountStats#getBonusNonCraftingSkillLimits()
-	 * 
+	 *
 	 * @param bonus the number of bonus Gathering points
 	 */
 	public void setBonusNonCraftingSkillLimits(int bonus);
@@ -274,9 +274,9 @@ public interface AccountStats extends CMCommon
 	 * Returns the number of bonus Language skills available to
 	 * this character.  This is independent of the account
 	 * bonus.
-	 * 
+	 *
 	 * @see AccountStats#setBonusLanguageLimits(int)
-	 * 
+	 *
 	 * @return the number of bonus Language points
 	 */
 	public int getBonusLanguageLimits();
@@ -285,9 +285,9 @@ public interface AccountStats extends CMCommon
 	 * Sets the number of bonus Language skills available to
 	 * this character.  This is independent of the account
 	 * bonus.
-	 * 
+	 *
 	 * @see AccountStats#getBonusLanguageLimits()
-	 * 
+	 *
 	 * @param bonus the number of bonus Language points
 	 */
 	public void setBonusLanguageLimits(int bonus);
@@ -303,15 +303,17 @@ public interface AccountStats extends CMCommon
 	/**
 	 * Returns a modifiable Set that contains the set of player
 	 * Names that constitutes this players ignored player list.
-	 * @see AccountStats.getIgnored()
+	 * @see AccountStats#isIgnored(String)
+	 * @see AccountStats#isIgnored(MOB)
 	 *
 	 * @return a set of player ignored player list Names
 	 */
 	public Set<String> getIgnored();
 
 	/**
 	 * Returns whether the given player is being ignored.
-	 * @see AccountStats.getIgnored()
+	 * @see AccountStats#getIgnored()
+	 * @see AccountStats#isIgnored(String)
 	 *
 	 * @param mob the mob to check
 	 * @return true if the given mob is ignored
@@ -320,7 +322,8 @@ public interface AccountStats extends CMCommon
 
 	/**
 	 * Returns whether the given player name is being ignored.
-	 * @see AccountStats.getIgnored()
+	 * @see AccountStats#getIgnored()
+	 * @see AccountStats#isIgnored(MOB)
 	 *
 	 * @param name the name to check
 	 * @return true if the given name is ignored
@@ -356,7 +359,7 @@ public interface AccountStats extends CMCommon
 	 * @return the Tracker object that handles this achievement/mob
 	 */
 	public Tracker getAchievementTracker(Achievement A, MOB mob);
-	
+
 	/**
 	 * Deletes the tracker for the given achievement, for the given mob.
 	 * @see AccountStats#rebuildAchievementTracker(MOB, String)
@@ -376,7 +379,7 @@ public interface AccountStats extends CMCommon
 	 * @param achievementTattoo the tattoo/id of the achievement
 	 */
 	public void rebuildAchievementTracker(final MOB mob, String achievementTattoo);
-	
+
 	/**
 	 * Returns an XML representation of all the data in this object, for
 	 * persistent storage.
@@ -395,20 +398,20 @@ public interface AccountStats extends CMCommon
 	 * @param str an XML representation of all the data in this object
 	 */
 	public void setXML(String str);
-	
+
 	/**
 	 * The recorded player and account statistics.
 	 * @author Bo Zimmerman
 	 *
 	 */
 	public enum PrideStat
 	{
-		PVPKILLS, 
-		AREAS_EXPLORED, 
-		ROOMS_EXPLORED, 
-		EXPERIENCE_GAINED, 
-		MINUTES_ON, 
-		QUESTS_COMPLETED, 
+		PVPKILLS,
+		AREAS_EXPLORED,
+		ROOMS_EXPLORED,
+		EXPERIENCE_GAINED,
+		MINUTES_ON,
+		QUESTS_COMPLETED,
 		QUESTPOINTS_EARNED
 	}
 
@@ -422,5 +425,5 @@ public enum Agent
 		PLAYER,
 		ACCOUNT
 	}
-	
+
 }

com/planet_ink/coffee_mud/Common/interfaces/Clan.java

@@ -434,15 +434,15 @@ public interface Clan extends Cloneable, Tickable, CMCommon, Modifiable
 
 	/**
 	 * Adjusts the amount of experience earned by this
-	 * @param MOB member the person contributing the xp
+	 * @param memberM member the person contributing the xp
 	 * @param howMuch the experience adjustment, + or -
 	 */
 	public void adjExp(MOB memberM, int howMuch);
 
 	/**
 	 * Adjusts the amount of base gold value deposited by this
 	 * member.
-	 * @param MOB member the person contributing
+	 * @param memberM member the person contributing
 	 * @param newValue the value adjustment, + or -
 	 */
 	public void adjDeposit(MOB memberM, double newValue);
@@ -451,7 +451,7 @@ public interface Clan extends Cloneable, Tickable, CMCommon, Modifiable
 	 * Adjusts the amount of experience earned by a player based
 	 * on the tax rate.  Will automatically adjust the exp of
 	 * the clan and save it.
-	 * @param MOB member the person contributing the xp
+	 * @param memberM member the person contributing the xp
 	 * @param exp the old experience
 	 * @return the exp adjusted by the clan, if at all.
 	 */
@@ -780,7 +780,7 @@ public interface Clan extends Cloneable, Tickable, CMCommon, Modifiable
 
 	/**
 	 * Gets external items belonging to this clan, which should be destroyed with the
-	 * clan, but can still be transient.  These are items like artifacts, or ships, 
+	 * clan, but can still be transient.  These are items like artifacts, or ships,
 	 * vehicles, etc.
 	 *
 	 * @see com.planet_ink.coffee_mud.core.interfaces.ItemCollection
@@ -789,7 +789,7 @@ public interface Clan extends Cloneable, Tickable, CMCommon, Modifiable
 	 * @return an item collection
 	 */
 	public ItemCollection getExtItems();
-	
+
 	/**
 	 * Returns whether the given user can be assigned the given role
 	 * @param mob the mob to check
@@ -849,7 +849,7 @@ public class MemberRecord
 		public long		donatedXP	= 0;
 		public double	donatedGold	= 0;
 
-		public MemberRecord(String name, int role)
+		public MemberRecord(final String name, final int role)
 		{
 			this.name = name;
 			this.role = role;
@@ -871,14 +871,14 @@ public class FullMemberRecord extends MemberRecord
 		public int level;
 		public long timestamp;
 		public boolean isAdmin;
-		public FullMemberRecord(MemberRecord M, int level, long timestamp, boolean isAdmin)
+		public FullMemberRecord(final MemberRecord M, final int level, final long timestamp, final boolean isAdmin)
 		{
-			super(M.name,M.role); 
+			super(M.name,M.role);
 			this.mobpvps=M.mobpvps;
 			this.playerpvps=M.playerpvps;
 			this.donatedGold=M.donatedGold;
 			this.donatedXP=M.donatedXP;
-			this.level=level; 
+			this.level=level;
 			this.timestamp=timestamp;
 			this.isAdmin=isAdmin;
 		}
@@ -989,7 +989,7 @@ public static enum Trophy
 		;
 		public final String description;
 		public final String codeString;
-		private Trophy(String desc, String codeName)
+		private Trophy(final String desc, final String codeName)
 		{
 			this.description=desc;
 			this.codeString=codeName;

com/planet_ink/coffee_mud/Common/interfaces/PlayerStats.java

@@ -900,9 +900,9 @@ public interface PlayerStats extends CMCommon, Modifiable, AccountStats, Conting
 	/**
 	 * Returns the maximum amount of deferred xp that this player
 	 * can be awarded, typically over a given level.
-	 * @see PlayerStats#setMaxXP(int)
-	 * @see PlayerStats#getXP()
-	 * @see PlayerStats#setXP(int)
+	 * @see PlayerStats#setMaxDeferredXP(int)
+	 * @see PlayerStats#getDeferredXP()
+	 * @see PlayerStats#setDeferredXP(int)
 	 *
 	 * @return the maximum amount of deferred xp
 	 */
@@ -946,7 +946,7 @@ public interface PlayerStats extends CMCommon, Modifiable, AccountStats, Conting
 	 * XP.  This is used for the guildmaster exception, where
 	 * XP is only awarded under certain conditions.
 	 *
-	 * @return
+	 * @return the last time this player has been awarded
 	 */
 	public long getLastXPAwardMillis();