From: <kar...@us...> - 2006-06-23 11:14:58
|
Revision: 1114 Author: karianna Date: 2006-06-23 04:14:39 -0700 (Fri, 23 Jun 2006) ViewCVS: http://svn.sourceforge.net/pcgen/?rev=1114&view=rev Log Message: ----------- Many Javadoc and Eclipse warning fixes Modified Paths: -------------- Trunk/pcgen/code/src/java/pcgen/core/bonus/Bonus.java Trunk/pcgen/code/src/java/pcgen/core/bonus/BonusObj.java Trunk/pcgen/code/src/java/pcgen/core/kit/BaseKit.java Trunk/pcgen/code/src/java/pcgen/gui/editor/BasePanel.java Trunk/pcgen/code/src/java/pcgen/persistence/lst/BaseKitLoader.java Trunk/pcgen/code/src/java/plugin/exporttokens/BioToken.java Trunk/pcgen/code/src/java/plugin/initiative/XMLCombatant.java Trunk/pcgen/code/src/java/plugin/lsttokens/BonusLst.java Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/wieldcategory/ZeroToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/race/XtraskillptsperlvlToken.java Modified: Trunk/pcgen/code/src/java/pcgen/core/bonus/Bonus.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/core/bonus/Bonus.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/pcgen/core/bonus/Bonus.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -31,7 +31,6 @@ import java.util.Enumeration; import java.util.HashMap; -import java.util.Iterator; import java.util.StringTokenizer; import java.util.jar.JarFile; import java.util.jar.JarEntry; @@ -413,6 +412,10 @@ return bonusClass; } + /** + * toString function bonusname:bonustype + * @return String bonusname:bonustype + */ public String toString() { return bonusObjectName + ':' + Integer.toString(bonusType); Modified: Trunk/pcgen/code/src/java/pcgen/core/bonus/BonusObj.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/core/bonus/BonusObj.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/pcgen/core/bonus/BonusObj.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -891,7 +891,8 @@ } } } - /* (non-Javadoc) + + /** * @see java.lang.Object#clone() */ public Object clone() throws CloneNotSupportedException Modified: Trunk/pcgen/code/src/java/pcgen/core/kit/BaseKit.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/core/kit/BaseKit.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/pcgen/core/kit/BaseKit.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -30,7 +30,6 @@ import pcgen.core.Kit; import pcgen.core.PlayerCharacter; import pcgen.util.Logging; -import java.util.Iterator; import pcgen.core.prereq.Prerequisite; /** @@ -111,7 +110,11 @@ return Collections.unmodifiableList(lookups); } - public Object clone() + /** + * Clone this Base Kit + * @return cloned Base Kit + */ + public Object clone() { BaseKit aClone = null; try Modified: Trunk/pcgen/code/src/java/pcgen/gui/editor/BasePanel.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/gui/editor/BasePanel.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/pcgen/gui/editor/BasePanel.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -34,6 +34,15 @@ */ abstract class BasePanel extends JPanel implements PObjectUpdater { - public abstract void updateData(PObject thisPObject); - public abstract void updateView(PObject thisPObject); + /** + * Update the data in the panel with PObject + * @param thisPObject + */ + public abstract void updateData(PObject thisPObject); + + /** + * Update the data in the view with PObject + * @param thisPObject + */ + public abstract void updateView(PObject thisPObject); } Modified: Trunk/pcgen/code/src/java/pcgen/persistence/lst/BaseKitLoader.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/persistence/lst/BaseKitLoader.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/pcgen/persistence/lst/BaseKitLoader.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -18,6 +18,7 @@ * @param obj * @param tag * @return true if parse OK + * @throws PersistenceLayerException */ public static boolean parseCommonTags(BaseKit obj, final String tag) throws PersistenceLayerException @@ -32,7 +33,7 @@ key = tag.substring(0, idxColon); } catch(StringIndexOutOfBoundsException e) { - // TODO Handle Exception + throw new PersistenceLayerException(); } BaseKitLstToken token = (BaseKitLstToken) tokenMap.get(key); Modified: Trunk/pcgen/code/src/java/plugin/exporttokens/BioToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/exporttokens/BioToken.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/plugin/exporttokens/BioToken.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -104,6 +104,10 @@ return sb.toString(); } + /** + * Returns false + * @return false + */ public boolean isEncoded() { return false; } Modified: Trunk/pcgen/code/src/java/plugin/initiative/XMLCombatant.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/initiative/XMLCombatant.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/plugin/initiative/XMLCombatant.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -35,7 +35,6 @@ import pcgen.util.Logging; import java.util.List; -import java.util.Vector; import java.util.ArrayList; /** @@ -564,6 +563,10 @@ return "-" + bonus; } + /** + * Return as HTML String + * @return PCRenderer as HTML string + */ public String toHtmlString() { return new PcRenderer().getHtmlText(); Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/BonusLst.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/BonusLst.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/BonusLst.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -10,14 +10,24 @@ /** * @author djones4 - * */ public class BonusLst implements GlobalLstToken { + /** + * Returns token name + * @return token name + */ public String getTokenName() { return "BONUS"; } + /** + * Parse BONUS token + * @param obj + * @param value + * @param anInt + * @return true or false + */ public boolean parse(PObject obj, String value, int anInt) { boolean result = false; value = CoreUtility.replaceAll(value, "<this>", obj.getKeyName()); Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/wieldcategory/ZeroToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/wieldcategory/ZeroToken.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/wieldcategory/ZeroToken.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -8,10 +8,20 @@ */ public class ZeroToken implements WieldCategoryLstToken { - public String getTokenName() { + /** + * Get token name + * @return Token name + */ + public String getTokenName() { return "ZERO"; } + /** + * Parse ZERO token + * @param cat + * @param value + * @return true + */ public boolean parse(WieldCategory cat, String value) { //The wield category steps cat.setWCStep(0, value); Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/race/XtraskillptsperlvlToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/race/XtraskillptsperlvlToken.java 2006-06-23 10:55:48 UTC (rev 1113) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/race/XtraskillptsperlvlToken.java 2006-06-23 11:14:39 UTC (rev 1114) @@ -8,10 +8,20 @@ */ public class XtraskillptsperlvlToken implements RaceLstToken { + /** + * Get token name + * @return token name + */ public String getTokenName() { return "XTRASKILLPTSPERLVL"; } + /** + * Parse XTRASKILLPTSPERLVL + * @param race + * @param value + * @return true if successful else false + */ public boolean parse(Race race, String value) { try { race.setBonusSkillsPerLevel(Integer.parseInt(value)); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |