From: <kar...@us...> - 2006-06-23 11:45:45
|
Revision: 1116 Author: karianna Date: 2006-06-23 04:45:20 -0700 (Fri, 23 Jun 2006) ViewCVS: http://svn.sourceforge.net/pcgen/?rev=1116&view=rev Log Message: ----------- Many Javadoc and Eclipse warning fixes Modified Paths: -------------- Trunk/pcgen/code/src/java/pcgen/core/chooser/WeaponProfTypeChoiceManager.java Trunk/pcgen/code/src/java/pcgen/gui/utils/WholeNumberField.java Trunk/pcgen/code/src/java/pcgen/persistence/lst/WeaponProfLoader.java Trunk/pcgen/code/src/java/plugin/doomsdaybook/gui/XMLFilter.java Trunk/pcgen/code/src/java/plugin/lsttokens/deity/WorshippersToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/equipment/WieldToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/equipment/WtToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/WieldcategoryToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/unitset/WeightunitToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/paper/WidthToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/pcclass/XppenaltyToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/pcclass/XtrafeatsToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/spell/XpcostToken.java Trunk/pcgen/code/src/java/plugin/overland/gui/XMLFilter.java Modified: Trunk/pcgen/code/src/java/pcgen/core/chooser/WeaponProfTypeChoiceManager.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/core/chooser/WeaponProfTypeChoiceManager.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/pcgen/core/chooser/WeaponProfTypeChoiceManager.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -28,7 +28,6 @@ import pcgen.core.PlayerCharacter; import pcgen.core.WeaponProf; -import java.util.Iterator; import java.util.List; /** @@ -37,7 +36,8 @@ public class WeaponProfTypeChoiceManager extends AbstractComplexChoiceManager<String> { String weaponType = ""; - /** + + /** * Make a new Weapon Proficiency type chooser. * * @param aPObject @@ -82,8 +82,6 @@ final List<String> selectedList) { final List<WeaponProf> tArrayList = Globals.getWeaponProfs(weaponType, aPc); - Iterator iter; - WeaponProf tempProf; for ( WeaponProf wp : tArrayList ) { Modified: Trunk/pcgen/code/src/java/pcgen/gui/utils/WholeNumberField.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/gui/utils/WholeNumberField.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/pcgen/gui/utils/WholeNumberField.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -103,6 +103,9 @@ private static class WholeNumberDocument extends PlainDocument { + /** + * @see javax.swing.text.PlainDocument#insertString(int, java.lang.String, javax.swing.text.AttributeSet) + */ public void insertString(int offs, String str, AttributeSet a) throws BadLocationException { Modified: Trunk/pcgen/code/src/java/pcgen/persistence/lst/WeaponProfLoader.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/persistence/lst/WeaponProfLoader.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/pcgen/persistence/lst/WeaponProfLoader.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -113,7 +113,11 @@ } /** - * @see pcgen.persistence.lst.LstObjectFileLoader#getObjectNamed(java.lang.String) + * Get the weapon prof object with key aKey + * + * @param aKey + * @return PObject + * @see pcgen.persistence.lst.LstObjectFileLoader#getObjectKeyed(java.lang.String) */ protected PObject getObjectKeyed(String aKey) { Modified: Trunk/pcgen/code/src/java/plugin/doomsdaybook/gui/XMLFilter.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/doomsdaybook/gui/XMLFilter.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/doomsdaybook/gui/XMLFilter.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -18,7 +18,14 @@ // Empty Constructor } - public boolean accept(java.io.File file, String str) + /** + * Returns true if file matches *.xml + * + * @param file + * @param str + * @return true if filter matches *.xml + */ + public boolean accept(java.io.File file, String str) { return str.matches(".*\\.xml$"); } Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/deity/WorshippersToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/deity/WorshippersToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/deity/WorshippersToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -8,10 +8,21 @@ */ public class WorshippersToken implements DeityLstToken{ - public String getTokenName() { + /** + * Get token name + * @return token name + */ + public String getTokenName() { return "WORSHIPPERS"; } + /** + * Parse WORSHIPPERS token + * + * @param deity + * @param value + * @return true + */ public boolean parse(Deity deity, String value) { deity.setWorshippers(value); return true; Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/equipment/WieldToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/equipment/WieldToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/equipment/WieldToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -8,10 +8,20 @@ */ public class WieldToken implements EquipmentLstToken { - public String getTokenName() { + /** + * Get token name + * @return token name + */ + public String getTokenName() { return "WIELD"; } + /** + * Parse WIELD token + * @param eq + * @param value + * @return true + */ public boolean parse(Equipment eq, String value) { eq.setWield(value); return true; Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/equipment/WtToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/equipment/WtToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/equipment/WtToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -8,10 +8,20 @@ */ public class WtToken implements EquipmentLstToken { - public String getTokenName() { + /** + * Get token name + * @return token name + */ + public String getTokenName() { return "WT"; } + /** + * Parse WT token, set the equipment weight + * @param eq + * @param value + * @return true + */ public boolean parse(Equipment eq, String value) { eq.setWeight(value); return true; Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/WieldcategoryToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/WieldcategoryToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/WieldcategoryToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -9,10 +9,20 @@ */ public class WieldcategoryToken implements GameModeLstToken { - public String getTokenName() { + /** + * Get token name + * @return token name + */ + public String getTokenName() { return "WIELDCATEGORY"; } + /** + * Parse WIELDCATEGORY token + * @param gameMode + * @param value + * @return true if successful + */ public boolean parse(GameMode gameMode, String value) { try { WieldCategoryLoader catDiceLoader = new WieldCategoryLoader(); Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/unitset/WeightunitToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/unitset/WeightunitToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/gamemode/unitset/WeightunitToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -8,10 +8,20 @@ */ public class WeightunitToken implements UnitSetLstToken { + /** + * Get token name + * @return token name + */ public String getTokenName() { return "WEIGHTUNIT"; } + /** + * Parse WEIGHTUNIT token + * @param unitSet + * @param value + * @return true + */ public boolean parse(UnitSet unitSet, String value) { unitSet.setWeightUnit(value); return true; Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/paper/WidthToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/paper/WidthToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/paper/WidthToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -29,7 +29,6 @@ import pcgen.core.PaperInfo; import pcgen.persistence.lst.PaperInfoLstToken; - /** * <code>WidthToken</code> * @@ -37,10 +36,21 @@ */ public class WidthToken implements PaperInfoLstToken { + /** + * Get token name + * @return token name + */ public String getTokenName() { return "WIDTH"; } + /** + * Parse WIDTH token + * + * @param paperInfo + * @param value + * @return true + */ public boolean parse(PaperInfo paperInfo, String value) { paperInfo.setPaperInfo(Constants.PAPERINFO_WIDTH, value); return true; Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/pcclass/XppenaltyToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/pcclass/XppenaltyToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/pcclass/XppenaltyToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -8,10 +8,22 @@ */ public class XppenaltyToken implements PCClassLstToken { - public String getTokenName() { + /** + * Get token name + * @return token name + */ + public String getTokenName() { return "XPPENALTY"; } + /** + * Parse XPPENALTY token + * + * @param pcclass + * @param value + * @param level + * @return true + */ public boolean parse(PCClass pcclass, String value, int level) { pcclass.setXPPenalty(value); return true; Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/pcclass/XtrafeatsToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/pcclass/XtrafeatsToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/pcclass/XtrafeatsToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -8,10 +8,22 @@ */ public class XtrafeatsToken implements PCClassLstToken { - public String getTokenName() { + /** + * Get Token name + * @return token name + */ + public String getTokenName() { return "XTRAFEATS"; } + /** + * Parse the XTRAFEATS token + * + * @param pcclass + * @param value + * @param level + * @return true if successful else false + */ public boolean parse(PCClass pcclass, String value, int level) { try { pcclass.setInitialFeats(Integer.parseInt(value)); Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/spell/XpcostToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/spell/XpcostToken.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/spell/XpcostToken.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -8,11 +8,22 @@ */ public class XpcostToken implements SpellLstToken { - public String getTokenName() { + /** + * Get the token name + * @return token name + */ + public String getTokenName() { return "XPCOST"; } - public boolean parse(Spell spell, String value) { + /** + * Parse XPCOST token + * + * @param spell + * @param value + * @return true + */ + public boolean parse(Spell spell, String value) { spell.setXPCost(value); return true; } Modified: Trunk/pcgen/code/src/java/plugin/overland/gui/XMLFilter.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/overland/gui/XMLFilter.java 2006-06-23 11:33:50 UTC (rev 1115) +++ Trunk/pcgen/code/src/java/plugin/overland/gui/XMLFilter.java 2006-06-23 11:45:20 UTC (rev 1116) @@ -5,9 +5,7 @@ */ package plugin.overland.gui; - /** - * * @author devon */ public class XMLFilter implements java.io.FilenameFilter @@ -18,6 +16,13 @@ // Empty Constructor } + /** + * Return true if filter matches *.xml + * + * @param file + * @param str + * @return true if filter matches + */ public boolean accept(java.io.File file, String str) { return str.matches(".*\\.xml$"); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |