Menu
▾
▴
[Crossfire-cvs] SF.net SVN: crossfire:[11724] jxclient/trunk/src/jxclient/com/realtime/ crossfire/jxclient
|
From: Crossfire C. r. messages.
<cro...@li...> - 2009-05-26 05:38:11
|
Revision: 11724
http://crossfire.svn.sourceforge.net/crossfire/?rev=11724&view=rev
Author: akirschbaum
Date: 2009-05-26 05:38:03 +0000 (Tue, 26 May 2009)
Log Message:
-----------
Update comments.
Modified Paths:
--------------
jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyBinding.java
jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/GUIMessageLog.java
jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/MessageBufferUpdater.java
jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/Parser.java
jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/window/GuiManager.java
Modified: jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyBinding.java
===================================================================
--- jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyBinding.java 2009-05-25 22:28:08 UTC (rev 11723)
+++ jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/keybindings/KeyBinding.java 2009-05-26 05:38:03 UTC (rev 11724)
@@ -22,13 +22,16 @@
import com.realtime.crossfire.jxclient.window.GUICommandList;
/**
- *
- * @version 1.0
+ * Abstract base class for key bindings. A key binding consists of information
+ * about the bound key and an associated {@link GUICommandList}.
* @author Lauwenmark
- * @since 1.0
+ * @author Andreas Kirschbaum
*/
public abstract class KeyBinding
{
+ /**
+ * The associated {@link GUICommandList}.
+ */
private final GUICommandList commands;
/**
@@ -37,18 +40,20 @@
*/
private final boolean isDefault;
+ /**
+ * Returns the associated {@link GUICommandList}.
+ * @return the associated command list
+ */
public GUICommandList getCommands()
{
return commands;
}
/**
- * Create a new instance.
- *
- * @param commands The commands to execute.
- *
- * @param isDefault Whether the key binding is a "default" binding which
- * should not be saved.
+ * Creates a new instance.
+ * @param commands the commands to execute
+ * @param isDefault whether the key binding is a "default" binding which
+ * should not be saved
*/
protected KeyBinding(final GUICommandList commands, final boolean isDefault)
{
@@ -65,29 +70,23 @@
public abstract int hashCode();
/**
- * Check whether this key binding matches a key code/modifiers pair.
- *
- * @param keyCode The key code to check.
- *
- * @param modifiers The modifiers to check.
- *
- * @return Whether the key binding matches the parameters.
+ * Checks whether this key binding matches a key code/modifiers pair.
+ * @param keyCode the key code to check
+ * @param modifiers the modifiers to check
+ * @return whether the key binding matches the parameters
*/
public abstract boolean matchesKeyCode(final int keyCode, final int modifiers);
/**
* Check whether this key binding matches a key character.
- *
- * @param keyChar The key character to check.
- *
- * @return Whether the key binding matches the parameters.
+ * @param keyChar the key character to check
+ * @return whether the key binding matches the parameters
*/
public abstract boolean matchesKeyChar(final char keyChar);
/**
- * Return the commands as a string.
- *
- * @return The commands as a string.
+ * Returns the commands as a string.
+ * @return the commands as a string
*/
public String getCommandString()
{
@@ -95,9 +94,8 @@
}
/**
- * Return whether the key binding is a "default" binding which should not
+ * Returns whether the key binding is a "default" binding which should not
* be saved.
- *
* @return <code>true</code>=do not save
*/
public boolean isDefault()
Modified: jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/GUIMessageLog.java
===================================================================
--- jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/GUIMessageLog.java 2009-05-25 22:28:08 UTC (rev 11723)
+++ jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/GUIMessageLog.java 2009-05-26 05:38:03 UTC (rev 11724)
@@ -82,7 +82,7 @@
}
/**
- * Set the message types to show.
+ * Sets the message types to show.
* @param types the types to show
*/
public void setTypes(final int types)
Modified: jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/MessageBufferUpdater.java
===================================================================
--- jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/MessageBufferUpdater.java 2009-05-25 22:28:08 UTC (rev 11723)
+++ jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/MessageBufferUpdater.java 2009-05-26 05:38:03 UTC (rev 11724)
@@ -28,7 +28,6 @@
/**
* Adds drawinfo, drawextinfo, and query messages to a {@link Buffer} instance.
- *
* @author Andreas Kirschbaum
*/
public class MessageBufferUpdater
@@ -158,14 +157,11 @@
};
/**
- * Create a new instance.
- *
+ * Creates a new instance.
* @param crossfireServerConnection the connection instance
- *
- * @param buffer The buffer to update.
- *
- * @param defaultColor The default color to use for undefined colors
- * indices.
+ * @param buffer the buffer to update
+ * @param defaultColor the default color to use for undefined colors
+ * indices
*/
public MessageBufferUpdater(final CrossfireServerConnection crossfireServerConnection, final Buffer buffer, final Color defaultColor)
{
@@ -186,11 +182,9 @@
}
/**
- * Convert a Crossfire color index to a {@link Color} instance.
- *
- * @param index The color index to look up.
- *
- * @return The color.
+ * Converts a Crossfire color index to a {@link Color} instance.
+ * @param index the color index to look up
+ * @return the color
*/
private Color findColor(final int index)
{
@@ -205,11 +199,9 @@
}
/**
- * Set a color mapping.
- *
- * @param index The color index to change.
- *
- * @param color The color to map to.
+ * Sets a color mapping.
+ * @param index the color index to change
+ * @param color the color to map to
*/
public void setColor(final int index, final Color color)
{
@@ -217,9 +209,8 @@
}
/**
- * Set the message types to show.
- *
- * @param types The types to show.
+ * Sets the message types to show.
+ * @param types the types to show
*/
public void setTypes(final int types)
{
@@ -227,11 +218,9 @@
}
/**
- * Return whether a message type should be shown.
- *
- * @param type The message type.
- *
- * @return Whether the message type should be shown.
+ * Returns whether a message type should be shown.
+ * @param type the message type
+ * @return whether the message type should be shown
*/
private boolean isTypeShown(final int type)
{
Modified: jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/Parser.java
===================================================================
--- jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/Parser.java 2009-05-25 22:28:08 UTC (rev 11723)
+++ jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/gui/log/Parser.java 2009-05-26 05:38:03 UTC (rev 11724)
@@ -25,7 +25,7 @@
import java.util.regex.Pattern;
/**
- * Parser to parse drawextinfo messages received from a Crossfire server and
+ * Parser for parsing drawextinfo messages received from a Crossfire server to
* update a {@link Buffer} instance.
* @author Andreas Kirschbaum
*/
Modified: jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/window/GuiManager.java
===================================================================
--- jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/window/GuiManager.java 2009-05-25 22:28:08 UTC (rev 11723)
+++ jxclient/trunk/src/jxclient/com/realtime/crossfire/jxclient/window/GuiManager.java 2009-05-26 05:38:03 UTC (rev 11724)
@@ -303,6 +303,7 @@
* @param tooltipManager the tooltip manager to update
* @param settings the settings to use
* @param server the crossfire server connection to monitor
+ * @param macros the macros instance to use
*/
public GuiManager(final JXCWindow window, final boolean debugGui, final Object semaphoreDrawing, final Object semaphoreRedraw, final TooltipManager tooltipManager, final Settings settings, final CrossfireServerConnection server, final Macros macros)
{
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
