From: <cr...@us...> - 2009-03-25 13:09:49
|
Revision: 5153 http://jnode.svn.sourceforge.net/jnode/?rev=5153&view=rev Author: crawley Date: 2009-03-25 13:09:26 +0000 (Wed, 25 Mar 2009) Log Message: ----------- Javadoc fixes Modified Paths: -------------- trunk/fs/src/driver/org/jnode/driver/block/ide/disk/IDEDiskDriver.java trunk/fs/src/driver/org/jnode/driver/block/ide/disk/IDEDiskPartitionDriver.java trunk/fs/src/driver/org/jnode/driver/block/ramdisk/RamDiskDriver.java trunk/fs/src/driver/org/jnode/driver/bus/scsi/CDB.java trunk/fs/src/driver/org/jnode/driver/bus/scsi/SCSIBuffer.java trunk/fs/src/driver/org/jnode/driver/bus/scsi/cdb/mmc/MMCUtils.java trunk/fs/src/driver/org/jnode/driver/bus/scsi/cdb/spc/SenseKey.java trunk/fs/src/fs/org/jnode/fs/iso9660/ISO9660FileSystemType.java trunk/fs/src/fs/org/jnode/fs/iso9660/SupplementaryVolumeDescriptor.java trunk/fs/src/fs/org/jnode/fs/smbfs/Format.java trunk/fs/src/fs/org/jnode/fs/util/FSUtils.java trunk/fs/src/fs/org/jnode/partitions/PartitionTableType.java trunk/fs/src/fs/org/jnode/partitions/ibm/IBMPartitionTableType.java trunk/fs/src/fs/org/jnode/partitions/ibm/MasterBootRecord.java Modified: trunk/fs/src/driver/org/jnode/driver/block/ide/disk/IDEDiskDriver.java =================================================================== --- trunk/fs/src/driver/org/jnode/driver/block/ide/disk/IDEDiskDriver.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/driver/org/jnode/driver/block/ide/disk/IDEDiskDriver.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -66,14 +66,18 @@ * My logger */ private static final Logger log = Logger.getLogger(IDEDiskDriver.class); + /** * Number of addressable sectors */ private long maxSector; + /** Has LBA support? */ //private boolean lba; + /** Has DMA support? */ //private boolean dma; + /** * Support 48-bit addressing? */ @@ -81,9 +85,6 @@ private IDEDiskBus diskBus; private IBMPartitionTable pt; - /** - * @see org.jnode.driver.Driver#startDevice() - */ protected void startDevice() throws DriverException { final IDEDevice dev = (IDEDevice) getDevice(); diskBus = new IDEDiskBus(dev); @@ -142,9 +143,6 @@ } } - /** - * @see org.jnode.driver.Driver#stopDevice() - */ protected void stopDevice() throws DriverException { final IDEDevice dev = (IDEDevice) getDevice(); // find mounted partitions on this device and unregister them ! @@ -174,23 +172,14 @@ this.pt = null; } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#flush() - */ public void flush() { // Nothing to do yet } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#getLength() - */ public long getLength() { return maxSector * SECTOR_SIZE; } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#read(long, byte[], int, int) - */ public void read(long devOffset, ByteBuffer destBuf) throws IOException { int destOffset = 0; int length = destBuf.remaining(); @@ -234,9 +223,6 @@ } } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#write(long, byte[], int, int) - */ public void write(long devOffset, ByteBuffer srcBuf) throws IOException { int srcOffset = 0; int length = srcBuf.remaining(); @@ -284,8 +270,8 @@ } /* - * Register the given partition entry (maybe an extended partition entry) - */ + * Register the given partition entry (maybe an extended partition entry) + */ private void registerPartition(DeviceManager devMan, IDEDevice dev, IBMPartitionTableEntry pte, int partIndex) throws DeviceAlreadyRegisteredException, DriverException { @@ -307,32 +293,28 @@ * * @param devMan * @param dev - * @param partIndex - * @return + * @param partIndex the first partition index to use + * @return the next partition index * @throws DeviceAlreadyRegisteredException - * * @throws DriverException */ - private int registerExtendedPartition(DeviceManager devMan, IDEDevice dev, - int partIndex) throws DeviceAlreadyRegisteredException, DriverException { + private int registerExtendedPartition(DeviceManager devMan, IDEDevice dev, int partIndex) + throws DeviceAlreadyRegisteredException, DriverException { //now we should have an filled vector in the pt final List<IBMPartitionTableEntry> extendedPartitions = pt.getExtendedPartitions(); log.info("Have " + extendedPartitions.size() + " Extended partitions found"); for (int iPart = 0; iPart < extendedPartitions.size(); iPart++) { - IBMPartitionTableEntry pteExt = - extendedPartitions.get(iPart); + IBMPartitionTableEntry pteExt = extendedPartitions.get(iPart); registerPartition(devMan, dev, pteExt, partIndex); - if (iPart < (extendedPartitions.size() - 1)) + if (iPart < (extendedPartitions.size() - 1)) { partIndex++; + } } return partIndex; } - /** - * @see org.jnode.driver.block.PartitionableBlockDeviceAPI#getSectorSize() - */ public int getSectorSize() throws IOException { return SECTOR_SIZE; } @@ -340,7 +322,7 @@ /** * Gets the partition table that this block device contains. * - * @return Null if no partition table is found. + * @return {@code null} if no partition table is found. * @throws IOException */ public IBMPartitionTable getPartitionTable() throws IOException { Modified: trunk/fs/src/driver/org/jnode/driver/block/ide/disk/IDEDiskPartitionDriver.java =================================================================== --- trunk/fs/src/driver/org/jnode/driver/block/ide/disk/IDEDiskPartitionDriver.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/driver/org/jnode/driver/block/ide/disk/IDEDiskPartitionDriver.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -42,9 +42,6 @@ private PartitionTableEntry pte; private MappedBlockDeviceSupport mapping; - /** - * @see org.jnode.driver.Driver#startDevice() - */ protected void startDevice() throws DriverException { try { final IDEDiskPartitionDevice dev = this.device; @@ -60,17 +57,11 @@ } } - /** - * @see org.jnode.driver.Driver#stopDevice() - */ protected void stopDevice() { /* for now only unregister an API */ device.unregisterAPI(FSBlockDeviceAPI.class); } - /** - * @see org.jnode.driver.Driver#afterConnect(org.jnode.driver.Device) - */ protected void afterConnect(Device device) { this.device = (IDEDiskPartitionDevice) device; super.afterConnect(device); @@ -92,30 +83,18 @@ return pte; } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#flush() - */ public void flush() throws IOException { mapping.flush(); } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#getLength() - */ public long getLength() { return mapping.getLength(); } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#read(long, byte[], int, int) - */ public void read(long devOffset, ByteBuffer dest) throws IOException { mapping.read(devOffset, dest); } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#write(long, byte[], int, int) - */ public void write(long devOffset, ByteBuffer src) throws IOException { mapping.write(devOffset, src); } Modified: trunk/fs/src/driver/org/jnode/driver/block/ramdisk/RamDiskDriver.java =================================================================== --- trunk/fs/src/driver/org/jnode/driver/block/ramdisk/RamDiskDriver.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/driver/org/jnode/driver/block/ramdisk/RamDiskDriver.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -34,10 +34,12 @@ public class RamDiskDriver extends Driver implements FSBlockDeviceAPI { private static final String RAMDISK_DEFAULTNAME = "ramdisk"; + /** * The device */ private RamDiskDevice device; + /** * The data */ @@ -89,7 +91,6 @@ /** * @return The partition table entry - * @see org.jnode.driver.block.FSBlockDeviceAPI#getPartitionTableEntry() */ public PartitionTableEntry getPartitionTableEntry() { return null; @@ -97,22 +98,17 @@ /** * @return The sector size - * @see org.jnode.driver.block.FSBlockDeviceAPI#getSectorSize() */ public int getSectorSize() { return 512; } - /** - * @see org.jnode.driver.block.BlockDeviceAPI#flush() - */ public void flush() { // Do nothing } /** * @return The length - * @see org.jnode.driver.block.BlockDeviceAPI#getLength() */ public long getLength() { return data.length; @@ -121,24 +117,16 @@ /** * @param devOffset * @param dest - * @param destOffset - * @param length - * @see org.jnode.driver.block.BlockDeviceAPI#read(long, byte[], int, int) */ public void read(long devOffset, ByteBuffer dest) { - //System.arraycopy(this.data, (int)devOffset, dest, destOffset, length); dest.put(this.data, (int) devOffset, dest.remaining()); } /** * @param devOffset * @param src - * @param srcOffset - * @param length - * @see org.jnode.driver.block.BlockDeviceAPI#write(long, byte[], int, int) */ public void write(long devOffset, ByteBuffer src) { - //System.arraycopy(src, srcOffset, this.data, (int)devOffset, length); src.get(this.data, (int) devOffset, src.remaining()); } } Modified: trunk/fs/src/driver/org/jnode/driver/bus/scsi/CDB.java =================================================================== --- trunk/fs/src/driver/org/jnode/driver/bus/scsi/CDB.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/driver/org/jnode/driver/bus/scsi/CDB.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -29,8 +29,8 @@ /** * Initialize this instance. * - * @param cdbLength Length (in bytes) of this CDB - * @param opcode Opcode of this CDB + * @param cdbLength the length (in bytes) of this CDB + * @param opcode the opcode of this CDB */ public CDB(int cdbLength, int opcode) { super(cdbLength); @@ -40,7 +40,7 @@ /** * Gets the opcode of this CDB. * - * @return + * @return the opcode */ public final int getOpcode() { return getUInt8(0); Modified: trunk/fs/src/driver/org/jnode/driver/bus/scsi/SCSIBuffer.java =================================================================== --- trunk/fs/src/driver/org/jnode/driver/bus/scsi/SCSIBuffer.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/driver/org/jnode/driver/bus/scsi/SCSIBuffer.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -67,7 +67,7 @@ * The byte is returned as 8-bit unsigned integer (0..0xFF). * * @param offset - * @return + * @return the byte */ public final int getUInt8(int offset) { return getUInt8(buffer, offset); @@ -85,10 +85,10 @@ /** * Gets a 16-bit integer from a given offset. - * The byte is returned as 16-bit unsigned integer (0..0xFFFF). + * The data is returned as 16-bit unsigned integer (0..0xFFFF). * * @param offset - * @return + * @return the data */ public final int getUInt16(int offset) { return getUInt16(buffer, offset); @@ -106,10 +106,10 @@ /** * Gets a 32-bit integer from a given offset. - * The byte is returned as 32-bit signed integer (Integer.MIN_VALUE..Integer.MAX_VALUE). + * The data is returned as 32-bit signed integer (Integer.MIN_VALUE..Integer.MAX_VALUE). * * @param offset - * @return + * @return the data */ public final int getInt32(int offset) { return getInt32(buffer, offset); @@ -117,11 +117,11 @@ /** * Gets an ASCII string from the given offset with a given length. - * The padded 0x20 (space) characters are removed. + * The padding 0x20 (space) characters are removed. * * @param offset * @param length - * @return + * @return the string */ public final String getASCII(int offset, int length) { try { @@ -132,29 +132,29 @@ } /** - * Get the bytearray itself. + * Get the byte array itself. * - * @return + * @return the byte array */ public final byte[] toByteArray() { return buffer; } /** - * Convert an integer to a 2-character long hex string. + * Convert an integer (containing a byte) to a 2-character long hex string. * * @param v - * @return + * @return the hex-coded integer */ protected static final String hex2(int v) { return NumberUtils.hex(v, 2); } /** - * Convert an integer to a 4-character long hex string. + * Convert an integer (containing a short) to a 4-character long hex string. * * @param v - * @return + * @return the hex-coded integer */ protected static final String hex4(int v) { return NumberUtils.hex(v, 4); @@ -164,7 +164,7 @@ * Convert an integer to a 8-character long hex string. * * @param v - * @return + * @return the hex-coded integer */ protected static final String hex8(int v) { return NumberUtils.hex(v, 8); Modified: trunk/fs/src/driver/org/jnode/driver/bus/scsi/cdb/mmc/MMCUtils.java =================================================================== --- trunk/fs/src/driver/org/jnode/driver/bus/scsi/cdb/mmc/MMCUtils.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/driver/org/jnode/driver/bus/scsi/cdb/mmc/MMCUtils.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -37,7 +37,7 @@ * Read the capacity data of a given SCSI device. * * @param dev - * @return + * @return the capacity */ public static CapacityData readCapacity(SCSIDevice dev) throws SCSIException, TimeoutException, InterruptedException { Modified: trunk/fs/src/driver/org/jnode/driver/bus/scsi/cdb/spc/SenseKey.java =================================================================== --- trunk/fs/src/driver/org/jnode/driver/bus/scsi/cdb/spc/SenseKey.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/driver/org/jnode/driver/bus/scsi/cdb/spc/SenseKey.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -28,7 +28,7 @@ * @author Ewout Prangsma (ep...@us...) */ public final class SenseKey { - + // FIXME ... should this be an enum now? private final int key; private final String name; private static final SenseKey[] KEYS = { @@ -59,7 +59,7 @@ * Gets the SenseKey wrapper for a given key number. * * @param key - * @return + * @return the wrapper */ public static SenseKey valueOf(int key) { return KEYS[key]; @@ -121,16 +121,10 @@ return (key == 14); } - /** - * @see java.lang.Object#hashCode() - */ public int hashCode() { return key; } - /** - * @see java.lang.Object#toString() - */ public final String toString() { return name; } Modified: trunk/fs/src/fs/org/jnode/fs/iso9660/ISO9660FileSystemType.java =================================================================== --- trunk/fs/src/fs/org/jnode/fs/iso9660/ISO9660FileSystemType.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/fs/org/jnode/fs/iso9660/ISO9660FileSystemType.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -27,6 +27,7 @@ import org.jnode.driver.block.FSBlockDeviceAPI; import org.jnode.fs.BlockDeviceFileSystemType; import org.jnode.fs.FileSystemException; +import org.jnode.fs.FileSystemType; import org.jnode.partitions.PartitionTableEntry; /** @@ -39,10 +40,6 @@ return "ISO9660"; } - /** - * @see org.jnode.fs.FileSystemType#supports(PartitionTableEntry, byte[], - * FSBlockDeviceAPI) - */ public boolean supports(PartitionTableEntry pte, byte[] firstSector, FSBlockDeviceAPI devApi) { if (pte != null) { // CD-ROM's do not have a partition table. @@ -67,9 +64,6 @@ } } - /** - * @see org.jnode.fs.FileSystemType#create(Device, boolean) - */ public ISO9660FileSystem create(Device device, boolean readOnly) throws FileSystemException { return new ISO9660FileSystem(device, readOnly, this); } Modified: trunk/fs/src/fs/org/jnode/fs/iso9660/SupplementaryVolumeDescriptor.java =================================================================== --- trunk/fs/src/fs/org/jnode/fs/iso9660/SupplementaryVolumeDescriptor.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/fs/org/jnode/fs/iso9660/SupplementaryVolumeDescriptor.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -136,7 +136,7 @@ /** * Is the used encoding known to this system. - * @return + * @return {@code true} if the encoding known, otherwise {@code false}. */ public final boolean isEncodingKnown() { return encodingKnown; Modified: trunk/fs/src/fs/org/jnode/fs/smbfs/Format.java =================================================================== --- trunk/fs/src/fs/org/jnode/fs/smbfs/Format.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/fs/org/jnode/fs/smbfs/Format.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -336,10 +336,9 @@ /** * Formats a character into a string (like sprintf in C) * - * @param x the value to format + * @param c the value to format * @return the formatted string */ - public String form(char c) { if (fmt != 'c') throw new java.lang.IllegalArgumentException(); @@ -351,10 +350,9 @@ /** * Formats a string into a larger string (like sprintf in C) * - * @param x the value to format + * @param s the value to format * @return the formatted string */ - public String form(String s) { if (fmt != 's') throw new java.lang.IllegalArgumentException(); @@ -363,11 +361,9 @@ return pad(s); } - /** * a test stub for the format class */ - public static void main(String[] a) { double x = 1.23456789012; double y = 123; Modified: trunk/fs/src/fs/org/jnode/fs/util/FSUtils.java =================================================================== --- trunk/fs/src/fs/org/jnode/fs/util/FSUtils.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/fs/org/jnode/fs/util/FSUtils.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -58,9 +58,9 @@ } /** - * @param path - * @param separator - * @return + * @param path a pathname + * @param separator the pathname separator used in the pathname + * @return the parent part of a pathname */ public static String getParentName(String path, char separator) { int idx = path.lastIndexOf(separator); @@ -73,9 +73,9 @@ } /** - * @param entry - * @param deep - * @return + * @param entry an FSEntry to be rendered + * @param deep if {@code true}, include details of the FS object that the entry refers to. + * @return a human readable rendering of the FSEntry */ public static String toString(FSEntry entry, boolean deep) { if (entry == null) @@ -122,8 +122,8 @@ } /** - * @param dir - * @return + * @param dir an FSDirectory + * @return a human readable rendering of the FSDirectory * @throws IOException */ public static String toString(FSDirectory dir) throws IOException { @@ -131,9 +131,9 @@ } /** - * @param dir - * @param deep - * @return + * @param dir an FSDirectory + * @param deep if {@code true} also render the directory's entries + * @return a human readable rendering of the FSDirectory * @throws IOException */ public static String toString(FSDirectory dir, boolean deep) throws IOException { @@ -148,8 +148,8 @@ } /** - * @param file - * @return + * @param file an FSFile + * @return a human readable rendering of the FSFile */ public static String toString(FSFile file) { if (file == null) @@ -164,36 +164,38 @@ } /** - * @param str - * @param date - * @return + * @param str a description + * @param date a date/time expressed as milliseconds since the UNIX epoch + * @return the concatenation of the description and the system default + * rendering of the date. */ public static String toStringDate(String str, long date) { return toString(str, new Date(date)); } /** - * @param str - * @param date - * @return + * @param str a description + * @param date a date/time value + * @return the concatenation of the description and the system default + * rendering of the date. */ public static String toString(String str, Date date) { return str + dateFormat.format(date); } /** - * @param data - * @return + * @param data bytes to be rendered + * @return a rendering of the bytes */ public static String toString(byte[] data) { return toString(data, 0, data.length); } /** - * @param data - * @param offset - * @param length - * @return + * @param data an array of bytes + * @param offset the start position of the first byte to be rendered + * @param length the number of bytes to be rendered + * @return a rendering of the bytes */ public static String toString(byte[] data, int offset, int length) { StringBuilder sb = new StringBuilder(1024); @@ -225,9 +227,9 @@ } /** - * @param str - * @param size - * @return + * @param str the string to be padded + * @param size pad to this size + * @return the supplied string padded to the left with spaces. */ public static String lpad(String str, int size) { if (str.length() >= size) @@ -242,10 +244,12 @@ } /** - * @param data - * @param offset - * @param length - * @return + * Render bytes as a String by 'converting' each byte into a character + * in the range 0 to 255. + * @param data an array of bytes + * @param offset the start position of the first byte to be rendered + * @param length the number of bytes to be rendered + * @return a rendering of the bytes */ public static String toStringAsChars(byte[] data, int offset, int length) { int l = Math.min(offset + length, data.length); Modified: trunk/fs/src/fs/org/jnode/partitions/PartitionTableType.java =================================================================== --- trunk/fs/src/fs/org/jnode/partitions/PartitionTableType.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/fs/org/jnode/partitions/PartitionTableType.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -38,6 +38,7 @@ * blockdevice? * * @param devApi + * @param firstSector */ public boolean supports(byte[] firstSector, BlockDeviceAPI devApi); @@ -45,7 +46,7 @@ * Create a partition table for a given device. * * @param device - * @param readOnly + * @param firstSector */ public PartitionTable create(byte[] firstSector, Device device) throws PartitionTableException; Modified: trunk/fs/src/fs/org/jnode/partitions/ibm/IBMPartitionTableType.java =================================================================== --- trunk/fs/src/fs/org/jnode/partitions/ibm/IBMPartitionTableType.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/fs/org/jnode/partitions/ibm/IBMPartitionTableType.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -33,23 +33,14 @@ */ public class IBMPartitionTableType implements PartitionTableType { - /** - * @see org.jnode.partitions.PartitionTableType#create(org.jnode.driver.Device) - */ public PartitionTable create(byte[] firstSector, Device device) throws PartitionTableException { return new IBMPartitionTable(this, firstSector, device); } - /** - * @see org.jnode.partitions.PartitionTableType#getName() - */ public String getName() { return "IBM"; } - /** - * @see org.jnode.partitions.PartitionTableType#supports(org.jnode.driver.block.BlockDeviceAPI) - */ public boolean supports(byte[] firstSector, BlockDeviceAPI devApi) { // TODO Make a suitable implementation return true; Modified: trunk/fs/src/fs/org/jnode/partitions/ibm/MasterBootRecord.java =================================================================== --- trunk/fs/src/fs/org/jnode/partitions/ibm/MasterBootRecord.java 2009-03-25 11:00:27 UTC (rev 5152) +++ trunk/fs/src/fs/org/jnode/partitions/ibm/MasterBootRecord.java 2009-03-25 13:09:26 UTC (rev 5153) @@ -73,18 +73,18 @@ /** * Write the contents of this bootsector to the given device. * - * @param device + * @param api */ - public final synchronized void write(BlockDeviceAPI devApi) throws IOException { - devApi.write(0, mbr); - devApi.flush(); + public final synchronized void write(BlockDeviceAPI api) throws IOException { + api.write(0, mbr); + api.flush(); dirty = false; } /** * Read the contents of this bootsector from the given device. * - * @param device + * @param api */ public final synchronized void read(BlockDeviceAPI api) throws IOException { api.read(0, mbr); @@ -93,7 +93,7 @@ /** * TODO remove the temporary workaround : internal array shouldn't be exposed - * @return + * @return the MBR array */ public byte[] array() { return mbr.array(); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |