[Crossfire-cvs] SF.net SVN: crossfire:[11710] jxclient/trunk/src/jxclient/com/realtime/ crossfire/jxclient/gui/keybindings

[Crossfire C. r. messages. <cro...@li...>]

Revision: 11710
          http://crossfire.svn.sourceforge.net/crossfire/?rev=11710&view=rev
Author:   akirschbaum
Date:     2009-05-23 19:15:28 +0000 (Sat, 23 May 2009)

Log Message:
-----------
Update comments.

Modified Paths:
--------------
    jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyBindingState.java
    jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyCharKeyBinding.java

Modified: jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyBindingState.java
===================================================================
--- jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyBindingState.java	2009-05-23 19:09:07 UTC (rev 11709)
+++ jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyBindingState.java	2009-05-23 19:15:28 UTC (rev 11710)
@@ -22,8 +22,7 @@
 import com.realtime.crossfire.jxclient.window.GUICommandList;
 
 /**
- * Manage the state for the key binding dialog.
- *
+ * Manages the state for the key binding dialog.
  * @author Andreas Kirschbaum
  */
 public class KeyBindingState
@@ -71,15 +70,12 @@
     private char keyChar = '\0';
 
     /**
-     * Create a new instance.
-     *
-     * @param keyBindings The <code>KeyBindings</code> to modify; may be
-     * <code>null</code> when removing bindings.
-     *
-     * @param keyBindings2 The <code>KeyBindings</code> to modify; only used
-     * when removing bindings; may be <code>null</code> when removing bindings.
-     *
-     * @param commands The commands to bind, or <code>null</code> to unbind.
+     * Creates a new instance.
+     * @param keyBindings the <code>KeyBindings</code> to modify; may be
+     * <code>null</code> when removing bindings
+     * @param keyBindings2 the <code>KeyBindings</code> to modify; only used
+     * when removing bindings; may be <code>null</code> when removing bindings
+     * @param commands the commands to bind, or <code>null</code> to unbind
      */
     public KeyBindingState(final KeyBindings keyBindings, final KeyBindings keyBindings2, final GUICommandList commands)
     {
@@ -89,11 +85,9 @@
     }
 
     /**
-     * Record a binding by key code.
-     *
-     * @param keyCode The key code that was pressed.
-     *
-     * @param modifiers The bindings that are active.
+     * Records a binding by key code.
+     * @param keyCode the key code that was pressed
+     * @param modifiers the bindings that are active
      */
     public void keyPressed(final int keyCode, final int modifiers)
     {
@@ -104,9 +98,8 @@
     }
 
     /**
-     * Record a binding by key character.
-     *
-     * @param keyChar The key character that was typed.
+     * Records a binding by key character.
+     * @param keyChar the key character that was typed
      */
     public void keyTyped(final char keyChar)
     {
@@ -118,10 +111,9 @@
     }
 
     /**
-     * Record a key released event.
-     *
+     * Records a key released event.
      * @return <code>true</code> if the dialog has finished, or
-     * <code>false</code> if the dialog is still active.
+     * <code>false</code> if the dialog is still active
      */
     public boolean keyReleased()
     {

Modified: jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyCharKeyBinding.java
===================================================================
--- jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyCharKeyBinding.java	2009-05-23 19:09:07 UTC (rev 11709)
+++ jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyCharKeyBinding.java	2009-05-23 19:15:28 UTC (rev 11710)
@@ -23,7 +23,6 @@
 
 /**
  * A {@link KeyBinding} that matches by key character.
- *
  * @author Andreas Kirschbaum
  */
 public class KeyCharKeyBinding extends KeyBinding
@@ -34,14 +33,11 @@
     private final int keyChar;
 
     /**
-     * Create a {@link KeyBinding} that matches by key character.
-     *
-     * @param keyChar The key character to match.
-     *
-     * @param commands The commands to associate with this binding.
-     *
-     * @param isDefault Whether the key binding is a "default" binding which
-     * should not be saved.
+     * Creates a {@link KeyBinding} that matches by key character.
+     * @param keyChar the key character to match
+     * @param commands the commands to associate with this binding
+     * @param isDefault whether the key binding is a "default" binding which
+     * should not be saved
      */
     public KeyCharKeyBinding(final char keyChar, final GUICommandList commands, final boolean isDefault)
     {
@@ -50,9 +46,8 @@
     }
 
     /**
-     * Return the key character to match.
-     *
-     * @return The key character to match.
+     * Returns the key character to match.
+     * @return the key character to match
      */
     public int getKeyChar()
     {


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