[pcgen-commit-svn] SF.net SVN: pcgen:[14958] Trunk/pcgen/code/src/java/pcgen/cdom/facet/ AddLevelFacet.java

[<nu...@us...>]

Revision: 14958
          http://pcgen.svn.sourceforge.net/pcgen/?rev=14958&view=rev
Author:   nuance
Date:     2011-05-12 08:03:06 +0000 (Thu, 12 May 2011)

Log Message:
-----------
Javadoc tweak.

Modified Paths:
--------------
    Trunk/pcgen/code/src/java/pcgen/cdom/facet/AddLevelFacet.java

Modified: Trunk/pcgen/code/src/java/pcgen/cdom/facet/AddLevelFacet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/facet/AddLevelFacet.java	2011-05-11 15:26:59 UTC (rev 14957)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/facet/AddLevelFacet.java	2011-05-12 08:03:06 UTC (rev 14958)
@@ -130,22 +130,25 @@
 	 * @param pc
 	 *            The PlayerCharacter from which the levels of the PCClass in
 	 *            this LevelCommandFactory will be removed.
-	 * @param lvls
+	 * @param pcClass
+	 *            Despite what the javadoc for this method claims, it actually
+	 *            ignores the PCClass stored as state and instead works on the
+	 *            class passed here.
+	 * @param levels
 	 *            The number of levels to apply to the PlayerCharacter
 	 * @throws NullPointerException
 	 *             if the given PlayerCharacter is null
 	 */
-	private void apply(PlayerCharacter pc, PCClass pcClass, int lvls)
+	private void apply(PlayerCharacter pc, PCClass pcClass, int levels)
 	{
 		boolean tempShowHP = SettingsHandler.getShowHPDialogAtLevelUp();
 		SettingsHandler.setShowHPDialogAtLevelUp(false);
 		boolean tempFeatDlg = SettingsHandler.getShowFeatDialogAtLevelUp();
 		SettingsHandler.setShowFeatDialogAtLevelUp(false);
 		int tempChoicePref = SettingsHandler.getSingleChoicePreference();
-		SettingsHandler
-				.setSingleChoicePreference(Constants.CHOOSER_SINGLECHOICEMETHOD_SELECTEXIT);
+		SettingsHandler.setSingleChoicePreference(Constants.CHOOSER_SINGLECHOICEMETHOD_SELECTEXIT);
 
-		pc.incrementClassLevel(lvls, pcClass, true, true);
+		pc.incrementClassLevel(levels, pcClass, true, true);
 
 		SettingsHandler.setSingleChoicePreference(tempChoicePref);
 		SettingsHandler.setShowFeatDialogAtLevelUp(tempFeatDlg);


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.