Menu
▾
▴
[Jnode-svn-commits] SF.net SVN: jnode:[5150] trunk/fs/src/fs/org/jnode/fs
|
From: <cr...@us...> - 2009-03-24 14:08:43
|
Revision: 5150
http://jnode.svn.sourceforge.net/jnode/?rev=5150&view=rev
Author: crawley
Date: 2009-03-24 14:08:37 +0000 (Tue, 24 Mar 2009)
Log Message:
-----------
Javadoc fixes
Modified Paths:
--------------
trunk/fs/src/fs/org/jnode/fs/iso9660/Descriptor.java
trunk/fs/src/fs/org/jnode/fs/iso9660/ISO9660File.java
trunk/fs/src/fs/org/jnode/fs/iso9660/SupplementaryVolumeDescriptor.java
trunk/fs/src/fs/org/jnode/fs/iso9660/VolumeDescriptor.java
trunk/fs/src/fs/org/jnode/fs/jarfs/JarFSFile.java
trunk/fs/src/fs/org/jnode/fs/jarfs/JarFileSystem.java
trunk/fs/src/fs/org/jnode/fs/jfat/BootSector.java
trunk/fs/src/fs/org/jnode/fs/jifs/files/JIFSFthread.java
trunk/fs/src/fs/org/jnode/fs/ntfs/NTFSAttribute.java
trunk/fs/src/fs/org/jnode/fs/ntfs/NTFSVolume.java
trunk/fs/src/fs/org/jnode/fs/service/FileSystemService.java
trunk/fs/src/fs/org/jnode/fs/service/def/FileSystemPlugin.java
Modified: trunk/fs/src/fs/org/jnode/fs/iso9660/Descriptor.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/iso9660/Descriptor.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/iso9660/Descriptor.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -38,7 +38,7 @@
*
* @param buffer
* @param bp
- * @return
+ * @return an unsigned byte
*/
protected static final int getUInt8(byte[] buffer, int bp) {
return LittleEndian.getUInt8(buffer, bp - 1);
@@ -49,7 +49,7 @@
*
* @param buffer
* @param bp
- * @return
+ * @return a signed byte
*/
protected static final int getInt8(byte[] buffer, int bp) {
return LittleEndian.getInt8(buffer, bp - 1);
@@ -60,7 +60,7 @@
*
* @param buffer
* @param bp
- * @return
+ * @return an unsigned little-endian short
*/
protected static final int getUInt16LE(byte[] buffer, int bp) {
return LittleEndian.getUInt16(buffer, bp - 1);
@@ -71,7 +71,7 @@
*
* @param buffer
* @param bp
- * @return
+ * @return an unsigned big-endian short
*/
protected static final int getUInt16BE(byte[] buffer, int bp) {
return BigEndian.getUInt16(buffer, bp - 1);
@@ -82,7 +82,7 @@
*
* @param buffer
* @param bp
- * @return
+ * @return an unsigned short
*/
protected static final int getUInt16Both(byte[] buffer, int bp) {
return LittleEndian.getUInt16(buffer, bp - 1);
@@ -93,7 +93,7 @@
*
* @param buffer
* @param bp
- * @return
+ * @return an unsigned little-endian int
*/
protected static final long getUInt32LE(byte[] buffer, int bp) {
return LittleEndian.getUInt32(buffer, bp - 1);
@@ -104,7 +104,7 @@
*
* @param buffer
* @param bp
- * @return
+ * @return an unsigned big-endian int
*/
protected static final long getUInt32BE(byte[] buffer, int bp) {
return BigEndian.getUInt32(buffer, bp - 1);
@@ -115,7 +115,7 @@
*
* @param buffer
* @param bp
- * @return
+ * @return an unsigned int
*/
protected static final long getUInt32Both(byte[] buffer, int bp) {
return LittleEndian.getUInt32(buffer, bp - 1);
@@ -127,7 +127,7 @@
* @param buffer
* @param bp
* @param length
- * @return
+ * @return the String representation
*/
protected static final String getAChars(byte[] buffer, int bp, int length) {
return new String(buffer, bp - 1, length).trim();
@@ -139,7 +139,7 @@
* @param buffer
* @param bp
* @param length
- * @return
+ * @return the String representation
*/
protected static final String getDChars(byte[] buffer, int bp, int length) {
return new String(buffer, bp - 1, length).trim();
@@ -151,7 +151,8 @@
* @param buffer
* @param bp
* @param length
- * @return
+ * @param encoding
+ * @return the String representation
*/
protected static final String getAChars(byte[] buffer, int bp, int length, String encoding)
throws UnsupportedEncodingException {
@@ -164,7 +165,7 @@
* @param buffer
* @param bp
* @param length
- * @return
+ * @return the String representation
*/
protected static final String getDChars(byte[] buffer, int bp, int length, String encoding)
throws UnsupportedEncodingException {
Modified: trunk/fs/src/fs/org/jnode/fs/iso9660/ISO9660File.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/iso9660/ISO9660File.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/iso9660/ISO9660File.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -57,9 +57,8 @@
}
/**
- * @see org.jnode.fs.FSFile#read(long, byte[], int, int)
+ * @see org.jnode.fs.FSFile#read(long, ByteBuffer)
*/
- // public void read(long fileOffset, byte[] dest, int off, int len)
public void read(long fileOffset, ByteBuffer destBuf) throws IOException {
//TODO optimize it also to use ByteBuffer at lower level
final ByteBufferUtils.ByteArray destBA = ByteBufferUtils.toByteArray(destBuf);
@@ -69,9 +68,8 @@
}
/**
- * @see org.jnode.fs.FSFile#write(long, byte[], int, int)
+ * @see org.jnode.fs.FSFile#write(long, ByteBuffer)
*/
- //public void write(long fileOffset, byte[] src, int off, int len)
public void write(long fileOffset, ByteBuffer src) throws IOException {
throw new UnsupportedOperationException("Not yet implemented");
}
Modified: trunk/fs/src/fs/org/jnode/fs/iso9660/SupplementaryVolumeDescriptor.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/iso9660/SupplementaryVolumeDescriptor.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/iso9660/SupplementaryVolumeDescriptor.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -116,7 +116,7 @@
/**
* Gets a derived encoding name from the given escape sequences.
* @param escapeSequences
- * @return
+ * @return the encoding name
*/
private String getEncoding(String escapeSequences) throws UnsupportedEncodingException {
if (escapeSequences.equals("%/@")) {
Modified: trunk/fs/src/fs/org/jnode/fs/iso9660/VolumeDescriptor.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/iso9660/VolumeDescriptor.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/iso9660/VolumeDescriptor.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -60,10 +60,10 @@
}
/**
- * Gets the type of volume descriptor from the buffer.
+ * Gets the type of the volume descriptor in the supplied buffer.
*
* @param buffer
- * @return
+ * @return the type
*/
public static final int getType(byte[] buffer) {
return getUInt8(buffer, 1);
Modified: trunk/fs/src/fs/org/jnode/fs/jarfs/JarFSFile.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/jarfs/JarFSFile.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/jarfs/JarFSFile.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -60,7 +60,7 @@
}
/**
- * @see org.jnode.fs.FSFile#read(long, byte[], int, int)
+ * @see org.jnode.fs.FSFile#read(long, ByteBuffer)
*/
public void read(long fileOffset, ByteBuffer destBuf) throws IOException {
final JarFileSystem fs = (JarFileSystem) getFileSystem();
@@ -74,7 +74,7 @@
}
/**
- * @see org.jnode.fs.FSFile#write(long, byte[], int, int)
+ * @see org.jnode.fs.FSFile#write(long, ByteBuffer)
*/
public void write(long fileOffset, ByteBuffer src) throws IOException {
throw new ReadOnlyFileSystemException("Not yet implemented");
Modified: trunk/fs/src/fs/org/jnode/fs/jarfs/JarFileSystem.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/jarfs/JarFileSystem.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/jarfs/JarFileSystem.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -56,24 +56,15 @@
return jarFile;
}
- /**
- *
- */
protected FSFile createFile(FSEntry entry) {
return new JarFSFile((JarFSEntry) entry);
}
- /**
- *
- */
protected FSDirectory createDirectory(FSEntry entry) {
Map<String, JarFSEntry> entries = cache.getChildEntries((JarFSEntry) entry);
return new JarFSDirectory((JarFSEntry) entry, entries);
}
- /**
- *
- */
protected JarFSEntry createRootEntry() {
return rootEntry;
}
Modified: trunk/fs/src/fs/org/jnode/fs/jfat/BootSector.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/jfat/BootSector.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/jfat/BootSector.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -342,8 +342,7 @@
}
/**
- *
- * @return
+ * @return the FAT size / type
*/
public int fatSize() {
return type;
Modified: trunk/fs/src/fs/org/jnode/fs/jifs/files/JIFSFthread.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/jifs/files/JIFSFthread.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/jifs/files/JIFSFthread.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -39,8 +39,8 @@
/**
* Creates the file, which contains information about the given Thread.
*
- * @param String name Filename.
- * @param Thread t The Thread, whose information is presented via this file.
+ * @param name file's name
+ * @param t the Thread whose information is presented via this file.
* @param parent Parent FSEntry, in this case it is an instance of
* JIFSDplugins.
*/
Modified: trunk/fs/src/fs/org/jnode/fs/ntfs/NTFSAttribute.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ntfs/NTFSAttribute.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/ntfs/NTFSAttribute.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -135,10 +135,6 @@
}
/**
- * @return Returns the volume.
- */
-
- /**
* @return Returns the fileRecord.
*/
public FileRecord getFileRecord() {
@@ -155,7 +151,7 @@
/**
* Gets the length of this attribute in bytes.
*
- * @return
+ * @return the length
*/
public int getSize() {
return getUInt32AsInt(4);
@@ -166,7 +162,7 @@
*
* @param fileRecord
* @param offset
- * @return
+ * @return the attribute
*/
public static NTFSAttribute getAttribute(FileRecord fileRecord, int offset) {
final boolean resident = (fileRecord.getUInt8(offset + 0x08) == 0);
Modified: trunk/fs/src/fs/org/jnode/fs/ntfs/NTFSVolume.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ntfs/NTFSVolume.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/ntfs/NTFSVolume.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -106,7 +106,7 @@
/**
* Gets the size of a cluster.
*
- * @return
+ * @return the size
*/
public int getClusterSize() {
return clusterSize;
@@ -140,7 +140,7 @@
/**
* Gets the root directory on this volume.
*
- * @return
+ * @return the root directory record
* @throws IOException
*/
public FileRecord getRootDirectory() throws IOException {
Modified: trunk/fs/src/fs/org/jnode/fs/service/FileSystemService.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/service/FileSystemService.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/service/FileSystemService.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -74,13 +74,12 @@
* Gets the filesystem registered on the given device.
*
* @param device
- * @return null if no filesystem was found.
+ * @return {@code null} if no filesystem was found.
*/
public FileSystem<?> getFileSystem(Device device);
/**
- * Gets all registered filesystems. All instances of the returned collection
- * are instanceof FileSystem.
+ * Gets all registered filesystems.
*/
public Collection<FileSystem<?>> fileSystems();
@@ -104,7 +103,7 @@
/**
* Return a map of devices and their mount points.
*
- * @return
+ * @return the map
*/
public Map<String, String> getDeviceMountPoints();
@@ -112,7 +111,7 @@
* Is the given directory a mount.
*
* @param fullPath
- * @return
+ * @return {@code true} if the directory is a mount, otherwise {@code false}
*/
public boolean isMount(String fullPath);
Modified: trunk/fs/src/fs/org/jnode/fs/service/def/FileSystemPlugin.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/service/def/FileSystemPlugin.java 2009-03-24 13:40:22 UTC (rev 5149)
+++ trunk/fs/src/fs/org/jnode/fs/service/def/FileSystemPlugin.java 2009-03-24 14:08:37 UTC (rev 5150)
@@ -128,8 +128,7 @@
}
/**
- * Gets all registered filesystems. All instances of the returned collection
- * are instanceof FileSystem.
+ * Gets all registered filesystems.
*/
public Collection<FileSystem<?>> fileSystems() {
return fsm.fileSystems();
@@ -158,10 +157,6 @@
return api.getMountPoints();
}
- /*
- * (non-Javadoc)
- * @see org.jnode.fs.service.FileSystemService#getDeviceMountPoints()
- */
public Map<String, String> getDeviceMountPoints() {
Map<String, FileSystem<?>> mounts = api.getMountPoints();
Map<String, String> result = new TreeMap<String, String>();
@@ -175,7 +170,7 @@
/**
* Is the given directory a mount.
* @param fullPath
- * @return
+ * @return {@code true} if the director is a mount, otherwise {@code false}.
*/
public boolean isMount(String fullPath) {
return api.isMount(VMFile.getNormalizedPath(fullPath));
@@ -224,9 +219,6 @@
}
}
- /**
- * @see org.jnode.fs.service.FileSystemService#getFileSystemType(java.lang.String)
- */
public <T extends FileSystemType<?>> T getFileSystemType(Class<T> name)
throws FileSystemException {
T result = fsTypeManager.getSystemType(name);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|