Menu
▾
▴
[Jnode-svn-commits] SF.net SVN: jnode:[5146] trunk/core/src
|
From: <cr...@us...> - 2009-03-23 13:52:42
|
Revision: 5146
http://jnode.svn.sourceforge.net/jnode/?rev=5146&view=rev
Author: crawley
Date: 2009-03-23 13:52:30 +0000 (Mon, 23 Mar 2009)
Log Message:
-----------
Javadoc fixes
Modified Paths:
--------------
trunk/core/src/core/org/jnode/vm/x86/performance/X86PerformanceCounters.java
trunk/core/src/core/org/jnode/work/WorkPlugin.java
trunk/core/src/driver/org/jnode/driver/bus/pci/Capability.java
trunk/core/src/driver/org/jnode/driver/bus/pci/PCIBaseAddress.java
trunk/core/src/driver/org/jnode/driver/bus/pci/PCIDeviceConfig.java
trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType0.java
trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType1.java
trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType2.java
trunk/core/src/driver/org/jnode/driver/bus/pci/PCIRomAddress.java
trunk/core/src/driver/org/jnode/driver/bus/pci/PMCapability.java
trunk/core/src/driver/org/jnode/driver/console/Console.java
trunk/core/src/driver/org/jnode/driver/console/ConsoleManager.java
trunk/core/src/driver/org/jnode/driver/console/KeyEventBindings.java
trunk/core/src/driver/org/jnode/driver/console/TextConsole.java
trunk/core/src/driver/org/jnode/driver/console/textscreen/KeyboardHandler.java
trunk/core/src/driver/org/jnode/driver/console/textscreen/TextScreenConsole.java
trunk/core/src/driver/org/jnode/driver/input/KeyboardAPIAdapter.java
trunk/core/src/driver/org/jnode/driver/input/KeyboardInterpreter.java
trunk/core/src/driver/org/jnode/driver/input/KeyboardLayoutManager.java
trunk/core/src/driver/org/jnode/driver/input/MouseProtocolHandler.java
Modified: trunk/core/src/core/org/jnode/vm/x86/performance/X86PerformanceCounters.java
===================================================================
--- trunk/core/src/core/org/jnode/vm/x86/performance/X86PerformanceCounters.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/core/org/jnode/vm/x86/performance/X86PerformanceCounters.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -32,6 +32,9 @@
import org.vmmagic.pragma.Uninterruptible;
/**
+ * Base class for x86 performance counters. The base-class behavior is to provide no
+ * meaningful support for counters.
+ *
* @author Ewout Prangsma (ep...@us...)
*/
public class X86PerformanceCounters extends PerformanceCounters implements Uninterruptible {
@@ -40,7 +43,7 @@
* Create the appropriate instance for the specific cpu.
*
* @param id
- * @return
+ * @return a new counter instance
*/
public static final X86PerformanceCounters create(VmX86Processor processor,
X86CpuID id) {
@@ -85,30 +88,18 @@
this.cpu = cpu;
}
- /**
- * @see org.jnode.vm.performance.PerformanceCounters#getAvailableEvents()()
- */
public Set<PerformanceCounterEvent> getAvailableEvents() {
return Collections.emptySet();
}
- /**
- * @see org.jnode.vm.performance.PerformanceCounters#getAvailableEvent(java.lang.String)
- */
public PerformanceCounterEvent getAvailableEvent(String id) {
return null;
}
- /**
- * @see org.jnode.vm.performance.PerformanceCounters#getMaximumCounters()
- */
public final int getMaximumCounters() {
return maxCounters;
}
- /**
- * @see org.jnode.vm.performance.PerformanceCounters#getCounters(long[])
- */
public final void getCounterValues(long[] counters) {
// Force a read of the counters by yielding
UnsafeX86.saveMSRs();
@@ -126,10 +117,6 @@
// Override me
}
- /**
- * @see org.jnode.vm.performance.PerformanceCounters#
- * startCounters(org.jnode.vm.performance.PerformanceCounterEvent[])
- */
public final void startCounters(PerformanceCounterEvent[] events)
throws IllegalArgumentException {
// Test if the events array is not too long
@@ -153,19 +140,11 @@
}
- /**
- * Stop the counters on the given thread.
- *
- * @see org.jnode.vm.performance.PerformanceCounters#stopCounters()
- */
protected void startCounters(PerformanceCounterEvent[] events,
VmX86Thread thread) throws IllegalArgumentException {
// Override me
}
- /**
- * @see org.jnode.vm.performance.PerformanceCounters#stopCounters()
- */
public final void stopCounters() {
// TODO Implement me
final VmX86Thread thread = (VmX86Thread) cpu.getCurrentThread();
@@ -176,10 +155,9 @@
}
/**
- * Start the counters on the given thread.
- *
- * @see org.jnode.vm.performance.PerformanceCounters#
- * startCounters(org.jnode.vm.performance.PerformanceCounterEvent[])
+ * Stop the counters on the given thread.
+ *
+ * @param thread
*/
protected void stopCounters(VmX86Thread thread) throws IllegalArgumentException {
// Override me
Modified: trunk/core/src/core/org/jnode/work/WorkPlugin.java
===================================================================
--- trunk/core/src/core/org/jnode/work/WorkPlugin.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/core/org/jnode/work/WorkPlugin.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -132,7 +132,7 @@
/**
* Gets the number of entries in the work queue.
*
- * @return
+ * @return the number entries
*/
public final int queueSize() {
return queue.size();
@@ -141,7 +141,7 @@
/**
* Is the work queue empty.
*
- * @return
+ * @return {@code true} if the queue is empty, otherwise {@code false}.
*/
public final boolean isEmpty() {
return queue.isEmpty();
Modified: trunk/core/src/driver/org/jnode/driver/bus/pci/Capability.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/bus/pci/Capability.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/bus/pci/Capability.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -31,10 +31,12 @@
* Offset of this capability in the device config space
*/
private final int offset;
+
/**
* The device this is a capability of
*/
private final PCIDevice device;
+
/**
* The capability id
*/
@@ -50,22 +52,27 @@
* Power Management
*/
public static final int PM = 0x01;
+
/**
* Accelerated Graphics Port
*/
public static final int AGP = 0x02;
+
/**
* Vital Product Data
*/
public static final int VPD = 0x03;
+
/**
* Slot Identification
*/
public static final int SLOTID = 0x04;
+
/**
* Message Signalled Interrupts
*/
public static final int MSI = 0x05;
+
/**
* CompactPCI HotSwap
*/
@@ -95,7 +102,7 @@
*
* @param device
* @param offset
- * @return
+ * @return the Capability created
*/
static final Capability createCapability(PCIDevice device, int offset) {
final int id = device.readConfigByte(offset + PCI_CAP_LIST_ID);
@@ -127,11 +134,6 @@
return id;
}
- /**
- * Convert to a string representation.
- *
- * @see java.lang.Object#toString()
- */
public String toString() {
final StringBuilder sb = new StringBuilder();
sb.append("id=0x");
Modified: trunk/core/src/driver/org/jnode/driver/bus/pci/PCIBaseAddress.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/bus/pci/PCIBaseAddress.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/bus/pci/PCIBaseAddress.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -42,37 +42,44 @@
* Is this base address in IO Space?
*/
private final boolean isIO;
+
/**
* The base address in the IO space
*/
private final int ioAddress;
+
/**
* Memory type
*/
private final byte memType;
+
/**
* The base address in the memory space
*/
private final long memAddress;
+
/**
* Must a memory address be relocated below 1Mb?
*/
private final boolean below1Mb;
+
/**
* Is this a 64-bit memory address?
*/
private final boolean b64;
+
/**
* Size of the address space
*/
private final int size;
/**
- * Read a base address at a given index (0..5)
+ * Read a base address at a given index in a Device's config data.
*
* @param dev
- * @param index
- * @return
+ * @param address0Offset
+ * @param index an index in the range 0 ... 5 inclusive
+ * @return the base address
*/
public static PCIBaseAddress read(PCIDevice dev, int address0Offset, int index) {
if ((index < 0) || (index > 5)) {
Modified: trunk/core/src/driver/org/jnode/driver/bus/pci/PCIDeviceConfig.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/bus/pci/PCIDeviceConfig.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/bus/pci/PCIDeviceConfig.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -49,34 +49,42 @@
* My device
*/
protected final PCIDevice device;
+
/**
* My device ID
*/
private final int deviceID;
+
/**
* The vendor ID
*/
private final int vendorID;
+
/**
* The major class
*/
private final int majorClass;
+
/**
* The sub class
*/
private final int subClass;
+
/**
* The minor class
*/
private int minorClass;
+
/**
* The revision
*/
private final int revision;
+
/**
* The header type
*/
private final int headerTypeRaw;
+
/**
* The list of capabilities
*/
@@ -104,7 +112,7 @@
* based on the header type of the device configuration settings.
*
* @param device
- * @return
+ * @return the config instance
*/
static final PCIDeviceConfig createConfig(PCIDevice device) {
final int headerTypeRaw = device.readConfigByte(PCI_HEADER_TYPE);
@@ -136,7 +144,7 @@
* @param bus
* @param unit
* @param func
- * @return
+ * @return the ID
*/
static final int getDeviceID(PCIDriver pci, int bus, int unit, int func) {
return pci.readConfigWord(bus, unit, func, PCI_DEVICE_ID);
@@ -309,7 +317,7 @@
/**
* Gets all capabilities.
*
- * @return
+ * @return the device capabilities
*/
public final Collection<Capability> getCapabilities() {
if (capabilities == null) {
@@ -321,7 +329,7 @@
/**
* Is this a header type 0 configuration.
*
- * @return
+ * @return {@code true} if this is a type 0 configuration.
*/
public final boolean isHeaderType0() {
return (getHeaderType() == HEADER_TYPE_NORMAL);
@@ -330,7 +338,7 @@
/**
* Is this a header type 1 configuration.
*
- * @return
+ * @return {@code true} if this is a type 1 configuration.
*/
public final boolean isHeaderType1() {
return (getHeaderType() == HEADER_TYPE_BRIDGE);
@@ -339,7 +347,7 @@
/**
* Is this a header type 2 configuration.
*
- * @return
+ * @return {@code true} if this is a type 2 configuration.
*/
public final boolean isHeaderType2() {
return (getHeaderType() == HEADER_TYPE_CARDBUS);
@@ -348,7 +356,7 @@
/**
* Gets this configuration as a header type 0 (normal devices) accessor.
*
- * @return
+ * @return the configuration
* @throws ClassCastException If header type != 0.
*/
public final PCIHeaderType0 asHeaderType0() {
@@ -358,7 +366,7 @@
/**
* Gets this configuration as a header type 1 (pci-pci bridge) accessor.
*
- * @return
+ * @return the configuration
* @throws ClassCastException If header type != 1.
*/
public final PCIHeaderType1 asHeaderType1() {
@@ -368,18 +376,13 @@
/**
* Gets this configuration as a header type 2 (cardbus bridge) accessor.
*
- * @return
+ * @return the configuration
* @throws ClassCastException If header type != 2.
*/
public final PCIHeaderType2 asHeaderType2() {
return (PCIHeaderType2) this;
}
- /**
- * Convert myself to a String representation.
- *
- * @see java.lang.Object#toString()
- */
public String toString() {
final StringBuilder sb = new StringBuilder();
sb.append("device=0x");
@@ -424,16 +427,16 @@
* Gets a 32-bit int from the device's configuration space.
*
* @param offset Byte offset of the requested dword.
- * @return
+ * @return the value fetched.
*/
public int getDWord(int offset) {
return device.readConfigDword(offset);
}
/**
- * Read the capability list.
+ * Load the capability map from the device's configuration space.
*
- * @return
+ * @return the capability map
*/
private Map<Integer, Capability> readCapabilities() {
if ((getStatus() & PCI_STATUS_CAP_LIST) == 0) {
Modified: trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType0.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType0.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType0.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -60,7 +60,7 @@
/**
* Gets the resource addresses.
*
- * @return
+ * @return the resource addresses
*/
public final PCIBaseAddress[] getBaseAddresses() {
PCIBaseAddress[] addresses = new PCIBaseAddress[6];
@@ -116,17 +116,14 @@
}
/**
- * Gets the ROM base address, or null is no rom is found.
+ * Gets the ROM base address, or {@code null} if no ROM is found.
*
- * @return
+ * @return the ROM addres or {@code null}
*/
public final PCIRomAddress getRomAddress() {
return romAddress;
}
- /**
- * @see org.jnode.driver.bus.pci.PCIDeviceConfig#toString()
- */
public final String toString() {
final StringBuilder sb = new StringBuilder(super.toString());
if (getInterruptPin() != 0) {
Modified: trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType1.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType1.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType1.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -172,9 +172,6 @@
return device.readConfigByte(PCI_SUBORDINATE_BUS);
}
- /**
- * @see org.jnode.driver.pci.PCIDeviceConfig#toString()
- */
public String toString() {
return super.toString() + ", " + "primary-bus=" + getPrimaryBus()
+ ", " + "secondary-bus=" + getSecondaryBus()
Modified: trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType2.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType2.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/bus/pci/PCIHeaderType2.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -96,9 +96,6 @@
return device.readConfigByte(PCI_CB_SUBORDINATE_BUS);
}
- /**
- * @see org.jnode.driver.pci.PCIDeviceConfig#toString()
- */
public String toString() {
return super.toString() + ", " + "primary-bus=" + getPrimaryBus()
+ ", " + "card-bus=" + getCardBus()
Modified: trunk/core/src/driver/org/jnode/driver/bus/pci/PCIRomAddress.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/bus/pci/PCIRomAddress.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/bus/pci/PCIRomAddress.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -93,14 +93,16 @@
/**
* Is the ROM base address enabled.
*
- * @return
+ * @return {@code true} if the base address is enabled, otherwise {@code false}.
*/
public final boolean isEnabled() {
return ((dev.readConfigDword(offset) & PCI_ROM_ADDRESS_ENABLE) != 0);
}
/**
- * Enable/disable the ROM
+ * Enable/disable the ROM.
+ *
+ * @param enabled {@code true} to enable, {@code false} to disable.
*/
public final void setEnabled(boolean enabled) {
int v = dev.readConfigDword(offset);
@@ -112,11 +114,6 @@
dev.writeConfigDword(offset, v);
}
- /**
- * Convert this to a String representation
- *
- * @see java.lang.Object#toString()
- */
public String toString() {
final int base = getRomBase();
return NumberUtils.hex(getRomBase()) + "-" + NumberUtils.hex(base + size - 1) +
Modified: trunk/core/src/driver/org/jnode/driver/bus/pci/PMCapability.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/bus/pci/PMCapability.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/bus/pci/PMCapability.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -38,7 +38,7 @@
/**
* Gets the power management capabilities.
*
- * @return
+ * @return the capability word
*/
public final int getCapabilities() {
return readConfigWord(0x02);
@@ -47,7 +47,7 @@
/**
* Gets the status register.
*
- * @return
+ * @return the status register address
*/
public final int getStatus() {
return readConfigWord(0x04);
@@ -56,7 +56,7 @@
/**
* Gets the data register.
*
- * @return
+ * @return the data register address
*/
public final int getData() {
return readConfigByte(0x07);
@@ -65,7 +65,7 @@
/**
* Gets the bridge support register.
*
- * @return
+ * @return the bridge support register address
*/
public final int getBridgeSupportExtensions() {
return readConfigByte(0x06);
Modified: trunk/core/src/driver/org/jnode/driver/console/Console.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/console/Console.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/console/Console.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -32,9 +32,9 @@
PointerListener {
/**
- * Has this control the focus.
+ * Does this console have focus.
*
- * @return
+ * @return {@code true} if the console has focus, otherwise {@code false}.
*/
public boolean isFocused();
@@ -108,7 +108,7 @@
/**
* Gets the manager this console is registered with.
*
- * @return
+ * @return the {@link ConsoleManager}
*/
public ConsoleManager getManager();
Modified: trunk/core/src/driver/org/jnode/driver/console/ConsoleManager.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/console/ConsoleManager.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/console/ConsoleManager.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -48,35 +48,35 @@
* Gets the console with the given accelerator keycode.
*
* @param keyCode
- * @return
+ * @return The console
*/
public Console getConsoleByAccelerator(int keyCode);
/**
- * Gets the names of all registers consoles.
+ * Gets the names of all consoles currently registered
*
- * @return
+ * @return a set of console names.
*/
public Set<String> getConsoleNames();
/**
- * Register a new console.
+ * Add a new console.
*
- * @param console
+ * @param console the console to be registered.
*/
public void registerConsole(Console console);
/**
- * Remove an already registered console.
+ * Remove a currently registered console.
*
- * @param console
+ * @param console the console to be unregistered.
*/
public void unregisterConsole(Console console);
/**
- * Gets the currently focused console.
+ * Gets the console that currently has focus.
*
- * @return Console
+ * @return the focussed console
*/
public Console getFocus();
@@ -97,14 +97,14 @@
/**
* Return the parent of this console manager.
*
- * @return
+ * @return the parent or {@code null}.
*/
public ConsoleManager getParent();
/**
* Set the parent of this console manager.
*
- * @param parent
+ * @param parent the new parent
*/
public void setParent(ConsoleManager parent);
@@ -135,18 +135,19 @@
public static final int STACKED = 0x08;
/**
- * Do not create a line-editting input stream for the console.
+ * Do not create a line-editing input stream for the console.
* The console's input will be whatever System.in currently is.
*/
public static final int NO_LINE_EDITTING = 0x10;
}
/**
- * Create a new console.
+ * Create a new console with given properties and optionally a given name.
*
- * @param name The name of the new console, or null for an automatic name.
- * @param options The options that determine the type of console to create.
- * @return
+ * @param name The name of the new console, or {@code null} for an automatic name.
+ * @param options The options that determine the properties of console to be created;
+ * see {@link CreateOptions}.
+ * @return the new console.
*/
public Console createConsole(String name, int options);
Modified: trunk/core/src/driver/org/jnode/driver/console/KeyEventBindings.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/console/KeyEventBindings.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/console/KeyEventBindings.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -63,7 +63,7 @@
}
/**
- * Reset the bindings to the state created by the constructor {@link #KeyEventBindings()}.
+ * Reset the bindings to the state created by the constructor.
*/
public void clear() {
charMap = new CodeMap(this.defaultCharAction);
@@ -73,7 +73,7 @@
/**
* Lookup the action for a given KeyboardEvent.
*
- * @param ch the character
+ * @param event the event
* @return the corresponding action.
*/
public T getKeyboardEventAction(KeyboardEvent event) {
Modified: trunk/core/src/driver/org/jnode/driver/console/TextConsole.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/console/TextConsole.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/console/TextConsole.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -217,7 +217,7 @@
/**
* Set the console's input completer
*
- * @param The new completer or <code>null</code>.
+ * @param completer The new completer or <code>null</code>.
*/
public void setCompleter(InputCompleter completer);
Modified: trunk/core/src/driver/org/jnode/driver/console/textscreen/KeyboardHandler.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/console/textscreen/KeyboardHandler.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/console/textscreen/KeyboardHandler.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -67,7 +67,7 @@
* Get the next KeyboardEvent from the internal queue (and wait if none is
* available).
*
- * @return
+ * @return the next event
*/
public final KeyboardEvent getEvent() {
return queue.get();
Modified: trunk/core/src/driver/org/jnode/driver/console/textscreen/TextScreenConsole.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/console/textscreen/TextScreenConsole.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/console/textscreen/TextScreenConsole.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -472,7 +472,7 @@
/**
* Get the options used to create this {@link TextScreenConsole}
- * @return
+ * @return the options.
*/
final int getOptions() {
return options;
Modified: trunk/core/src/driver/org/jnode/driver/input/KeyboardAPIAdapter.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/input/KeyboardAPIAdapter.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/input/KeyboardAPIAdapter.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -38,14 +38,12 @@
* All listeners
*/
private final ArrayList<KeyboardListener> listeners = new ArrayList<KeyboardListener>();
+
/**
* The interpreter
*/
private KeyboardInterpreter interpreter = null/*new KeyboardInterpreter()*/;
- /**
- * @see org.jnode.driver.input.KeyboardAPI#addKeyboardListener(org.jnode.driver.input.KeyboardListener)
- */
public synchronized void addKeyboardListener(KeyboardListener l) {
listeners.add(l);
}
@@ -68,23 +66,14 @@
}
}
- /**
- * @see org.jnode.driver.input.KeyboardAPI#getKbInterpreter()
- */
public KeyboardInterpreter getKbInterpreter() {
return interpreter;
}
- /**
- * @see org.jnode.driver.input.KeyboardAPI#removeKeyboardListener(org.jnode.driver.input.KeyboardListener)
- */
public synchronized void removeKeyboardListener(KeyboardListener l) {
listeners.remove(l);
}
- /**
- * @see org.jnode.driver.input.KeyboardAPI#setKbInterpreter(org.jnode.driver.input.AbstractKeyboardInterpreter)
- */
public void setKbInterpreter(KeyboardInterpreter kbInterpreter) {
if (kbInterpreter == null) {
throw new IllegalArgumentException("kbInterpreter==null");
Modified: trunk/core/src/driver/org/jnode/driver/input/KeyboardInterpreter.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/input/KeyboardInterpreter.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/input/KeyboardInterpreter.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -50,15 +50,18 @@
public static final int XT_EXTENDED = 0xE0;
/**
- * Interpret a given scancode into a keyevent.
+ * Interpret a given scancode as a KeyboardEvent.
*
- * @param scancode
+ * @param scancode a scancode
+ * @return the corresponding KeyboardEvent
*/
public KeyboardEvent interpretScancode(int scancode);
/**
- * @param keycode
- * @return
+ * Interpret a given keycode as a KeyboardEvent.
+ *
+ * @param keycode a keycode
+ * @return the corresponding KeyboardEvent
* @throws UnsupportedKeyException
*/
public KeyboardEvent interpretKeycode(int keycode);
Modified: trunk/core/src/driver/org/jnode/driver/input/KeyboardLayoutManager.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/input/KeyboardLayoutManager.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/input/KeyboardLayoutManager.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -132,7 +132,7 @@
* Create a new keyboard interpreter object. Note that keyboard interpreter
* objects are stateful and therefore cannot be shared by multiple keyboards.
*
- * @param a keyboard layout name or identifier.
+ * @param id a keyboard layout name or identifier.
* @return a KeyboardInterpreter
* @throws KeyboardInterpreterException
*/
Modified: trunk/core/src/driver/org/jnode/driver/input/MouseProtocolHandler.java
===================================================================
--- trunk/core/src/driver/org/jnode/driver/input/MouseProtocolHandler.java 2009-03-23 12:46:23 UTC (rev 5145)
+++ trunk/core/src/driver/org/jnode/driver/input/MouseProtocolHandler.java 2009-03-23 13:52:30 UTC (rev 5146)
@@ -28,7 +28,7 @@
/**
* Gets the name of the protocol of this handler.
*
- * @return String
+ * @return the protocol name
*/
public String getName();
@@ -36,22 +36,22 @@
* Does this protocol handler support a given mouse id.
*
* @param id
- * @return True if this handler supports the given id, false otherwise.
+ * @return {@code true} if this handler supports the given id, {@code false} otherwise.
*/
public boolean supportsId(int id);
/**
* Gets the size in bytes of a single packet in this protocol.
*
- * @return
+ * @return the size of a packet
*/
public int getPacketSize();
/**
- * Create an event based of the given data packet.
+ * Create an event based on the supplied data packet.
*
- * @param data
- * @return
+ * @param data a data packet
+ * @return a PointerEvent
*/
public PointerEvent buildEvent(byte[] data);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
