Menu
▾
▴
[Jnode-svn-commits] SF.net SVN: jnode:[5158] trunk
|
From: <cr...@us...> - 2009-03-26 13:55:21
|
Revision: 5158
http://jnode.svn.sourceforge.net/jnode/?rev=5158&view=rev
Author: crawley
Date: 2009-03-26 13:46:39 +0000 (Thu, 26 Mar 2009)
Log Message:
-----------
Fixed the last of the Javadoc warnings
Modified Paths:
--------------
trunk/core/src/classpath/vm/java/net/VMNetAPI.java
trunk/gui/src/awt/org/jnode/awt/image/JNodeImageGraphics.java
trunk/gui/src/desktop/org/jnode/desktop/DesktopPlugin.java
trunk/gui/src/driver/org/jnode/driver/video/FrameBufferAPI.java
trunk/gui/src/driver/org/jnode/driver/video/vgahw/VgaState.java
trunk/net/src/driver/org/jnode/driver/net/NetDeviceEvent.java
trunk/net/src/driver/org/jnode/driver/net/WirelessNetDeviceAPI.java
trunk/net/src/driver/org/jnode/driver/net/eepro100/EEPRO100Core.java
trunk/net/src/driver/org/jnode/driver/net/eepro100/EEPRO100RxFD.java
trunk/net/src/driver/org/jnode/driver/net/prism2/Prism2CommFrame.java
trunk/net/src/driver/org/jnode/driver/net/prism2/Prism2Constants.java
trunk/net/src/driver/org/jnode/driver/net/wireless/spi/WirelessDeviceCore.java
trunk/net/src/driver/org/jnode/driver/net/wireless/spi/WirelessEthernetDriver.java
trunk/net/src/net/org/jnode/net/NetworkLayer.java
trunk/net/src/net/org/jnode/net/arp/ARPNetworkLayer.java
trunk/net/src/net/org/jnode/net/ipv4/layer/IPv4NetworkLayer.java
trunk/net/src/net/org/jnode/net/nfs/nfs2/NFS2Client.java
trunk/net/src/net/org/jnode/net/nfs/nfs2/mount/Mount1Client.java
trunk/net/src/net/org/jnode/net/wireless/p80211Header.java
Modified: trunk/core/src/classpath/vm/java/net/VMNetAPI.java
===================================================================
--- trunk/core/src/classpath/vm/java/net/VMNetAPI.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/core/src/classpath/vm/java/net/VMNetAPI.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -32,7 +32,7 @@
* Gets a network device by its name, or null if not found.
*
* @param name
- * @return
+ * @return the device or {@code null}
*/
public VMNetDevice getByName(String name);
@@ -47,13 +47,9 @@
/**
* Return a network device by its address
*
- * @param addr
- * The address of the interface to return
- *
- * @exception SocketException
- * If an error occurs
- * @exception NullPointerException
- * If the specified addess is null
+ * @param addr The address of the interface to return
+ * @exception SocketException If an error occurs
+ * @exception NullPointerException If the specified address is {@code null}
*/
public VMNetDevice getByInetAddress(InetAddress addr)
throws SocketException;
@@ -75,7 +71,7 @@
/**
* Gets the address of a host by its name.
* @param hostname
- * @return
+ * @return the address
* @throws UnknownHostException
*/
public byte[][] getHostByName(String hostname)
@@ -84,7 +80,7 @@
/**
* Gets the name of a host by its address.
* @param ip The host address.
- * @return
+ * @return the host name
* @throws UnknownHostException
*/
public String getHostByAddr(byte[] ip)
Modified: trunk/gui/src/awt/org/jnode/awt/image/JNodeImageGraphics.java
===================================================================
--- trunk/gui/src/awt/org/jnode/awt/image/JNodeImageGraphics.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/gui/src/awt/org/jnode/awt/image/JNodeImageGraphics.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -20,6 +20,8 @@
package org.jnode.awt.image;
+import gnu.java.awt.java2d.AbstractGraphics2D;
+
import java.awt.Graphics;
import java.awt.GraphicsConfiguration;
import java.awt.Shape;
@@ -121,7 +123,7 @@
* Returns a WritableRaster that is used by this class to perform the
* rendering in. It is not necessary that the target surface immediately
* reflects changes in the raster. Updates to the raster are notified via
- * {@link #updateRaster}.
+ * {@link AbstractGraphics2D#updateRaster}.
*
* @return the destination raster
*/
Modified: trunk/gui/src/desktop/org/jnode/desktop/DesktopPlugin.java
===================================================================
--- trunk/gui/src/desktop/org/jnode/desktop/DesktopPlugin.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/gui/src/desktop/org/jnode/desktop/DesktopPlugin.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -40,22 +40,16 @@
/**
* Gets the applications (apps) extensions point
*
- * @return
+ * @return the extension point
*/
public ExtensionPoint getAppsExtensionPoint() {
return getDescriptor().getExtensionPoint("apps");
}
- /**
- * @see org.jnode.plugin.Plugin#startPlugin()
- */
protected void startPlugin() throws PluginException {
System.setProperty("jnode.desktop", "org.jnode.desktop.classic.Desktop");
}
- /**
- * @see org.jnode.plugin.Plugin#stopPlugin()
- */
protected void stopPlugin() throws PluginException {
// Nothing to do
}
Modified: trunk/gui/src/driver/org/jnode/driver/video/FrameBufferAPI.java
===================================================================
--- trunk/gui/src/driver/org/jnode/driver/video/FrameBufferAPI.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/gui/src/driver/org/jnode/driver/video/FrameBufferAPI.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -62,7 +62,6 @@
* The old owner (if any) will receive a request to stop using the underlying FrameBuffer device.
*
* @param owner
- * @return {@code true} if owner can now start using exclusively the underlying FrameBuffer device.
*/
public void requestOwnership(FrameBufferAPIOwner owner);
@@ -70,7 +69,6 @@
* Request the ownership on the underlying FrameBuffer device.
*
* @param owner
- * @return {@code true} if owner can now start using exclusively the underlying FrameBuffer device.
*/
public void releaseOwnership(FrameBufferAPIOwner owner);
Modified: trunk/gui/src/driver/org/jnode/driver/video/vgahw/VgaState.java
===================================================================
--- trunk/gui/src/driver/org/jnode/driver/video/vgahw/VgaState.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/gui/src/driver/org/jnode/driver/video/vgahw/VgaState.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -259,7 +259,7 @@
* Gets the length of the palette.
*
* @param io
- * @return
+ * @return the palette size
*/
protected int getPaletteSize(VgaIO io) {
return 256;
@@ -388,9 +388,6 @@
}
}
- /**
- * @see java.lang.Object#toString()
- */
public String toString() {
return "VGA[SEQ:" + NumberUtils.hex(seq, 2) + ", CRT:" + NumberUtils.hex(crt, 2) +
", GRA:" + NumberUtils.hex(gra, 2) + ", ATT:" + NumberUtils.hex(att, 2) +
Modified: trunk/net/src/driver/org/jnode/driver/net/NetDeviceEvent.java
===================================================================
--- trunk/net/src/driver/org/jnode/driver/net/NetDeviceEvent.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/driver/org/jnode/driver/net/NetDeviceEvent.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -47,7 +47,7 @@
/**
* Gets the device that it the source of this event.
*
- * @return
+ * @return the Device
*/
public final Device getDevice() {
return (Device) getSource();
Modified: trunk/net/src/driver/org/jnode/driver/net/WirelessNetDeviceAPI.java
===================================================================
--- trunk/net/src/driver/org/jnode/driver/net/WirelessNetDeviceAPI.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/driver/org/jnode/driver/net/WirelessNetDeviceAPI.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -32,7 +32,7 @@
/**
* Gets the current authentication mode.
*
- * @return
+ * @return the authentication mode
*/
public AuthenticationMode getAuthenticationMode();
Modified: trunk/net/src/driver/org/jnode/driver/net/eepro100/EEPRO100Core.java
===================================================================
--- trunk/net/src/driver/org/jnode/driver/net/eepro100/EEPRO100Core.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/driver/org/jnode/driver/net/eepro100/EEPRO100Core.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -342,7 +342,7 @@
* @param owner
* @param low
* @param length
- * @return
+ * @return the IOResource for the ports
*/
private IOResource claimPorts(final ResourceManager rm, final ResourceOwner owner,
final int low, final int length) throws ResourceNotFreeException, DriverException {
@@ -380,7 +380,7 @@
/**
* @param cmd
* @param cmdLength
- * @return
+ * @return the return value
*/
final int doEepromCmd(int cmd, int cmdLength) {
int retVal = 0;
@@ -421,7 +421,7 @@
/**
* @param phy_id
* @param location
- * @return
+ * @return the 16-bit word read
*/
public final int mdioRead(int phy_id, int location) {
int val;
@@ -443,7 +443,7 @@
* @param phy_id
* @param location
* @param value
- * @return
+ * @return the control word
*/
public final int mdioWrite(int phy_id, int location, int value) {
int val;
Modified: trunk/net/src/driver/org/jnode/driver/net/eepro100/EEPRO100RxFD.java
===================================================================
--- trunk/net/src/driver/org/jnode/driver/net/eepro100/EEPRO100RxFD.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/driver/org/jnode/driver/net/eepro100/EEPRO100RxFD.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -45,14 +45,17 @@
* Offset within mem of first UDP
*/
private final int firstUPDOffset;
+
/**
* Offset within mem of first ethernet frame
*/
private final int firstFrameOffset;
+
/**
* 32-bit address first UDP
*/
private final Address firstUPDAddress;
+
/**
* 32-bit address of first ethernet frame
*/
@@ -168,7 +171,7 @@
}
/**
- * @return
+ * @return data read from the device
*/
public byte[] getDataBuffer() {
byte[] buf = new byte[DataBufferSize];
@@ -177,7 +180,7 @@
}
/**
- * @return
+ * @return a packet read from the device in a SocketBuffer
*/
public SocketBuffer getPacket() {
int pktLen = this.getCount() & 0x3fff;
Modified: trunk/net/src/driver/org/jnode/driver/net/prism2/Prism2CommFrame.java
===================================================================
--- trunk/net/src/driver/org/jnode/driver/net/prism2/Prism2CommFrame.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/driver/org/jnode/driver/net/prism2/Prism2CommFrame.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -63,7 +63,7 @@
*
* @param src
* @param srcOffset
- * @return
+ * @return the status
*/
public static final int getStatus(byte[] src, int srcOffset) {
return LittleEndian.getUInt16(src, srcOffset);
@@ -74,7 +74,7 @@
*
* @param src
* @param srcOffset
- * @return
+ * @return the data length
*/
public static final int getDataLength(byte[] src, int srcOffset) {
return LittleEndian.getUInt16(src, srcOffset + 58);
Modified: trunk/net/src/driver/org/jnode/driver/net/prism2/Prism2Constants.java
===================================================================
--- trunk/net/src/driver/org/jnode/driver/net/prism2/Prism2Constants.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/driver/org/jnode/driver/net/prism2/Prism2Constants.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -190,17 +190,17 @@
/**
* Gets the code value.
*
- * @return
+ * @return the code value
*/
public final int getCode() {
return code;
}
/**
- * Gets the result value by its code.
+ * Gets the Result value by its code.
*
* @param code
- * @return
+ * @return the Result value
*/
public static final Result getByCode(int code) {
for (Result r : Result.values()) {
@@ -611,10 +611,10 @@
}
/**
- * Get the enum by its value.
+ * Get an InformationType by its value.
*
* @param value
- * @return
+ * @return the InformationType
*/
public static InformationType getByValue(int value) {
for (InformationType it : values()) {
@@ -647,10 +647,10 @@
}
/**
- * Get the enum by its value.
+ * Get the LinkStatus by its value.
*
* @param value
- * @return
+ * @return the LinkStatus
*/
public static LinkStatus getByValue(int value) {
for (LinkStatus ls : values()) {
Modified: trunk/net/src/driver/org/jnode/driver/net/wireless/spi/WirelessDeviceCore.java
===================================================================
--- trunk/net/src/driver/org/jnode/driver/net/wireless/spi/WirelessDeviceCore.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/driver/org/jnode/driver/net/wireless/spi/WirelessDeviceCore.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -38,7 +38,7 @@
/**
* Gets the current authentication mode.
*
- * @return
+ * @return the authentication mode
*/
protected abstract AuthenticationMode getAuthenticationMode()
throws DriverException;
Modified: trunk/net/src/driver/org/jnode/driver/net/wireless/spi/WirelessEthernetDriver.java
===================================================================
--- trunk/net/src/driver/org/jnode/driver/net/wireless/spi/WirelessEthernetDriver.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/driver/org/jnode/driver/net/wireless/spi/WirelessEthernetDriver.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -78,7 +78,7 @@
/**
* Gets the wireless device core.
*
- * @return
+ * @return the WirelessDeviceCore
*/
protected final WirelessDeviceCore getWirelessCore() {
return (WirelessDeviceCore) getDeviceCore();
Modified: trunk/net/src/net/org/jnode/net/NetworkLayer.java
===================================================================
--- trunk/net/src/net/org/jnode/net/NetworkLayer.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/net/org/jnode/net/NetworkLayer.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -96,7 +96,7 @@
* Gets the protocol addresses for a given name, or null if not found.
*
* @param hostname
- * @return
+ * @return the addresses or {@code null}
*/
public ProtocolAddress[] getHostByName(String hostname);
}
Modified: trunk/net/src/net/org/jnode/net/arp/ARPNetworkLayer.java
===================================================================
--- trunk/net/src/net/org/jnode/net/arp/ARPNetworkLayer.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/net/org/jnode/net/arp/ARPNetworkLayer.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -53,10 +53,12 @@
* My logger
*/
private static final Logger log = Logger.getLogger(ARPNetworkLayer.class);
+
/**
* My statistics
*/
private final ARPStatistics stat = new ARPStatistics();
+
/**
* ARP cache
*/
@@ -294,7 +296,7 @@
* Gets the protocol addresses for a given name, or null if not found.
*
* @param hostname
- * @return
+ * @return the addresses or {@code null}
*/
public ProtocolAddress[] getHostByName(String hostname) {
return null;
Modified: trunk/net/src/net/org/jnode/net/ipv4/layer/IPv4NetworkLayer.java
===================================================================
--- trunk/net/src/net/org/jnode/net/ipv4/layer/IPv4NetworkLayer.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/net/org/jnode/net/ipv4/layer/IPv4NetworkLayer.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -384,7 +384,7 @@
* Gets the protocol addresses for a given name, or null if not found.
*
* @param hostname
- * @return
+ * @return the addresses or {@code null}
*/
public ProtocolAddress[] getHostByName(String hostname) {
try {
Modified: trunk/net/src/net/org/jnode/net/nfs/nfs2/NFS2Client.java
===================================================================
--- trunk/net/src/net/org/jnode/net/nfs/nfs2/NFS2Client.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/net/org/jnode/net/nfs/nfs2/NFS2Client.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -514,17 +514,14 @@
/**
* Set the attributes for file.
*
- *
- * @param fileHandle
- * file handle.
- * @param mode
- * mode.
+ * @param fileHandle file handle.
+ * @param mode mode.
* @param uid
* @param gid
* @param size
* @param lastAccessed
* @param lastModified
- * @return
+ * @return the FileAttribute set
* @throws NFS2Exception
* @throws IOException
*/
Modified: trunk/net/src/net/org/jnode/net/nfs/nfs2/mount/Mount1Client.java
===================================================================
--- trunk/net/src/net/org/jnode/net/nfs/nfs2/mount/Mount1Client.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/net/org/jnode/net/nfs/nfs2/mount/Mount1Client.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -188,8 +188,7 @@
/**
* Call remote procedure mount.
*
- * @param dirPath
- * parameter (of type DirPath) to the remote procedure call.
+ * @param path parameter (of type DirPath) to the remote procedure call.
* @return Result from remote procedure call (of type MountResult).
* @throws OncRpcException
* if an ONC/RPC error occurs.
Modified: trunk/net/src/net/org/jnode/net/wireless/p80211Header.java
===================================================================
--- trunk/net/src/net/org/jnode/net/wireless/p80211Header.java 2009-03-26 13:04:02 UTC (rev 5157)
+++ trunk/net/src/net/org/jnode/net/wireless/p80211Header.java 2009-03-26 13:46:39 UTC (rev 5158)
@@ -54,7 +54,6 @@
* @param address3
* @param sequenceControl
* @param address4
- * @param dataLength
*/
public p80211Header(int frameControl, int durationId, EthernetAddress address1,
EthernetAddress address2, EthernetAddress address3, int sequenceControl,
@@ -111,10 +110,8 @@
* layers have set their header data and can be used e.g. to update checksum
* values.
*
- * @param skbuf
- * The buffer
- * @param offset
- * The offset to the first byte (in the buffer) of this header
+ * @param skbuf The buffer
+ * @param offset The offset to the first byte (in the buffer) of this header
* (since low layer headers are already prefixed)
*/
public void finalizeHeader(SocketBuffer skbuf, int offset) {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
