Menu
▾
▴
[Jnode-svn-commits] SF.net SVN: jnode:[5149] trunk
|
From: <cr...@us...> - 2009-03-24 14:22:50
|
Revision: 5149
http://jnode.svn.sourceforge.net/jnode/?rev=5149&view=rev
Author: crawley
Date: 2009-03-24 13:40:22 +0000 (Tue, 24 Mar 2009)
Log Message:
-----------
Javadoc fixes
Modified Paths:
--------------
trunk/core/src/core/org/jnode/vm/scheduler/VmProcessor.java
trunk/fs/src/fs/org/jnode/fs/ext2/BlockReservation.java
trunk/fs/src/fs/org/jnode/fs/ext2/Ext2Directory.java
trunk/fs/src/fs/org/jnode/fs/ext2/Ext2DirectoryRecord.java
trunk/fs/src/fs/org/jnode/fs/ext2/Ext2File.java
trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystem.java
trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystemFormatter.java
trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystemType.java
trunk/fs/src/fs/org/jnode/fs/ext2/Ext2Utils.java
trunk/fs/src/fs/org/jnode/fs/ext2/GroupDescriptor.java
trunk/fs/src/fs/org/jnode/fs/ext2/INode.java
trunk/fs/src/fs/org/jnode/fs/ext2/INodeReservation.java
trunk/fs/src/fs/org/jnode/fs/ext2/Superblock.java
trunk/fs/src/fs/org/jnode/fs/fat/FatFileSystemFormatter.java
trunk/fs/src/fs/org/jnode/fs/fat/FatUtils.java
Modified: trunk/core/src/core/org/jnode/vm/scheduler/VmProcessor.java
===================================================================
--- trunk/core/src/core/org/jnode/vm/scheduler/VmProcessor.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/core/src/core/org/jnode/vm/scheduler/VmProcessor.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -205,7 +205,7 @@
/**
* Get the processor that the current thread is running on.
*
- * @return
+ * @return the current processor
*/
@Inline
@org.jnode.vm.annotation.Uninterruptible
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/BlockReservation.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/BlockReservation.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/BlockReservation.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -84,7 +84,7 @@
/**
* Returns how many free blocks are in the block group
*
- * @return
+ * @return the free block count
*/
public long getFreeBlocksCount() {
return freeBlocksCount;
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/Ext2Directory.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/Ext2Directory.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/Ext2Directory.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -415,7 +415,7 @@
* Read the entries from the device and return the result in a new
* FSEntryTable
*
- * @return
+ * @return the FSEntryTable containing the directory's entries.
*/
protected FSEntryTable readEntries() throws IOException {
Ext2FSEntryIterator it = new Ext2FSEntryIterator(iNode);
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/Ext2DirectoryRecord.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/Ext2DirectoryRecord.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/Ext2DirectoryRecord.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -43,10 +43,10 @@
private Ext2FileSystem fs;
/**
- * @param data: the data that makes up the directory block
- * @param offset: the offset where the current DirectoryRecord begins within
+ * @param data the data that makes up the directory block
+ * @param offset the offset where the current DirectoryRecord begins within
* the block
- * @param fileOffset: the offset from the beginning of the directory file
+ * @param fileOffset the offset from the beginning of the directory file
*/
public Ext2DirectoryRecord(Ext2FileSystem fs, byte[] data, int offset, int fileOffset) {
this.fs = fs;
@@ -196,8 +196,8 @@
* length. The directoryRecord's <code>fileOffset</code> will be set to
* <code>beginning</code>.
*
- * @param beginning: the offset where the record begins
- * @param end: the offset where the record should end (usually the size a
+ * @param beginning the offset where the record begins
+ * @param end the offset where the record should end (usually the size a
* filesystem block)
*/
protected synchronized void expandRecord(long beginning, long end) throws FileSystemException {
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/Ext2File.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/Ext2File.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/Ext2File.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -164,9 +164,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 {
final int len = destBuf.remaining();
final int off = 0;
@@ -234,9 +233,8 @@
* methods write(byte[], int, int), setPosition(long), setLength(long) in
* org.jnode.fs.service.def.FileHandleImpl)
*
- * @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 srcBuf) throws IOException {
final int len = srcBuf.remaining();
final int off = 0;
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystem.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystem.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystem.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -371,9 +371,9 @@
/**
* Update the block in cache, or write the block to disk
*
- * @param nr: block number
- * @param data: block data
- * @param forceWrite: if forceWrite is false, the block is only updated in
+ * @param nr block number
+ * @param data block data
+ * @param forceWrite if forceWrite is false, the block is only updated in
* the cache (if it was in the cache). If forceWrite is true, or
* the block is not in the cache, write it to disk.
* @throws IOException
@@ -416,7 +416,7 @@
}
}
- /**
+ /*
* Helper class for timedWrite
*
* @author blind
@@ -511,7 +511,7 @@
* allocates it with preallocation.
*
* @param blockNr
- * @return
+ * @return the block reservation
* @throws IOException
*/
public BlockReservation testAndSetBlock(long blockNr) throws IOException {
@@ -557,9 +557,9 @@
/**
* Create a new INode
*
- * @param preferredBlockBroup: first try to allocate the inode in this block
+ * @param preferredBlockBroup first try to allocate the inode in this block
* group
- * @return
+ * @return the INode
*/
protected INode createINode(int preferredBlockBroup, int fileFormat, int accessRights, int uid, int gid)
throws FileSystemException, IOException {
@@ -612,7 +612,7 @@
* Find a free INode in the inode bitmap and allocate it
*
* @param blockGroup
- * @return
+ * @return the INode reservation
* @throws IOException
*/
protected INodeReservation findFreeINode(int blockGroup) throws IOException {
@@ -812,7 +812,7 @@
* (S_FEATURE_RO_COMPAT)
*
* @param mask
- * @return
+ * @return {@code true} if the filesystem uses the feature, otherwise {@code false}.
*/
protected boolean hasROFeature(long mask) {
return (mask & superblock.getFeatureROCompat()) != 0;
@@ -823,7 +823,7 @@
* (S_FEATURE_INCOMPAT)
*
* @param mask
- * @return
+ * @return {@code true} if the filesystem uses the feature, otherwise {@code false}.
*/
protected boolean hasIncompatFeature(long mask) {
return (mask & superblock.getFeatureIncompat()) != 0;
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystemFormatter.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystemFormatter.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystemFormatter.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -34,8 +34,8 @@
private BlockSize blockSize;
/**
- *
- * @param blockSizeKb size of blocks in KB
+ *
+ * @param blockSize size of blocks in KB
*/
public Ext2FileSystemFormatter(BlockSize blockSize) {
super(new Ext2FileSystemType());
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystemType.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystemType.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/Ext2FileSystemType.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -54,7 +54,7 @@
}
/**
- * @see org.jnode.fs.FileSystemType#supports(PartitionTableEntry, byte[], FSBlockDeviceAPI)
+ * @see org.jnode.fs.BlockDeviceFileSystemType#supports(PartitionTableEntry, byte[], FSBlockDeviceAPI)
*/
public boolean supports(PartitionTableEntry pte, byte[] firstSector, FSBlockDeviceAPI devApi) {
if (pte != null) {
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/Ext2Utils.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/Ext2Utils.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/Ext2Utils.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -34,7 +34,7 @@
*
* @param a
* @param b
- * @return
+ * @return the result of the computation
*/
public static long ceilDiv(long a, long b) {
return (int) ((a + b - 1) / b);
@@ -109,9 +109,8 @@
}
/**
- *
- * @param time
- * @return
+ * @param time the time in seconds since the UNIX epoch
+ * @return the decoded time in a {@link Calendar}
*/
public static Calendar decodeDate(long time) {
Calendar ref = Calendar.getInstance();
@@ -122,9 +121,8 @@
}
/**
- *
- * @param time
- * @return
+ * @param date the time encoded as a {@link Date}
+ * @return the time in seconds since the UNIX epocj
*/
public static long encodeDate(Date date) {
Calendar ref = Calendar.getInstance();
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/GroupDescriptor.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/GroupDescriptor.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/GroupDescriptor.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -210,7 +210,7 @@
}
/**
- * @return
+ * @return the dirty flag for the descriptor
*/
public boolean isDirty() {
return dirty;
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/INode.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/INode.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/INode.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -94,7 +94,7 @@
setMtime(time);
setDtime(0);
setLinksCount(0);
- //TODO: set other pesistent parameters?
+ //TODO: set other persistent parameters?
setDirty(true);
@@ -144,7 +144,7 @@
/**
* Return the number of the group that contains the inode.
*
- * @return
+ * @return the group number
*/
protected long getGroup() {
return desc.getGroup();
@@ -157,7 +157,7 @@
/**
* return the number of direct blocks that an indirect block can point to
*
- * @return
+ * @return the count
*/
private final int getIndirectCount() {
return fs.getSuperblock().getBlockSize() >> 2; //a block index is 4
@@ -173,8 +173,8 @@
* direct blocks, getIndirectCount() simple indirect blocks,
* getIndirectCount()^2 double indirect blocks, 45th triple indirect block).
*
- * @param indirectionLevel:
- * 0: direct block, 1: indirect block, ...
+ * @param indirectionLevel 0 is a direct block, 1 is a simple indirect block, and
+ * so on.
*/
private final long indirectRead(long dataBlockNr, long offset, int indirectionLevel)
throws IOException {
@@ -195,7 +195,7 @@
* register the address of the <code>offset</code> th block. Also see
* indirectRead().
*
- * @param allocatedBlocks:
+ * @param allocatedBlocks
* (the number of blocks allocated so far)-1
*/
private final void indirectWrite(long dataBlockNr, long offset, long allocatedBlocks,
@@ -276,8 +276,8 @@
* a block]
*
* @param i
- * @return @throws
- * IOException
+ * @return the block number
+ * @throws IOException
*/
private long getDataBlockNr(long i) throws IOException {
final long blockCount = getAllocatedBlockCount();
@@ -324,8 +324,8 @@
* beginning of the file, and not an absolute block number)
*
* @param i
- * @return @throws
- * IOException
+ * @return the data block
+ * @throws IOException
*/
public byte[] getDataBlock(long i) throws IOException {
return fs.getBlock(getDataBlockNr(i));
@@ -585,7 +585,7 @@
* case, it is not counted by getSizeInBlocks(), because it returns the size
* of the file in blocks, counting only written bytes
*
- * @return
+ * @return the count
*/
protected long getAllocatedBlockCount() {
if (desc.getLastAllocatedBlockIndex() != -1) {
@@ -598,6 +598,7 @@
/**
* Allocate the ith data block of the inode (i is a sequential index from
* the beginning of the file, and not an absolute block number)
+ * @param i
*/
public synchronized void allocateDataBlock(long i) throws FileSystemException, IOException {
if (i < getAllocatedBlockCount()) {
@@ -625,7 +626,7 @@
* should be the one that follows the last allocated block (that's why the
* <code>index</code> parameter is needed).
*
- * @param index:
+ * @param index
* the block to be found should be around the (index-1)th block
* of the inode (which is already allocated, unless index==0)
*/
@@ -772,7 +773,7 @@
* Return the size in ext2-blocks (getBlocks() returns the size in 512-byte
* blocks, but an ext2 block can be of different size).
*
- * @return
+ * @return the size
*/
public long getSizeInBlocks() {
return Ext2Utils.ceilDiv(getSize(), getExt2FileSystem().getBlockSize());
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/INodeReservation.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/INodeReservation.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/INodeReservation.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -39,7 +39,7 @@
* Results of an attempt to reserve an inode in a block group.
*
* @param successful
- * @param index: begins at index 0 (shows the index in the inode bitmap and
+ * @param index begins at index 0 (shows the index in the inode bitmap and
* inode table). The actual inode number is
* <code>INODEX_PER_GROUP*groupNr + index + 1</code>, as
* inodes begin at 1 (this is what getInodeNr(groupNr) returns)
@@ -55,7 +55,7 @@
}
/**
- * Returns the successful.
+ * Returns the successful flag.
*
* @return boolean
*/
@@ -64,7 +64,7 @@
}
/**
- * @return
+ * @return the group number
*/
public int getGroup() {
return group;
@@ -78,7 +78,7 @@
}
/**
- * @return
+ * @return the index
*/
public int getIndex() {
return index;
Modified: trunk/fs/src/fs/org/jnode/fs/ext2/Superblock.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/ext2/Superblock.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/ext2/Superblock.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -693,7 +693,7 @@
}
/**
- * @return
+ * @return the Superblock's dirty flag
*/
public boolean isDirty() {
return dirty;
Modified: trunk/fs/src/fs/org/jnode/fs/fat/FatFileSystemFormatter.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/fat/FatFileSystemFormatter.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/fat/FatFileSystemFormatter.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -51,8 +51,8 @@
/**
*
- * @param device
- * @return
+ * @param device a device that supports the {@link FSBlockDeviceAPI}.
+ * @return the formatted FAT file system.
* @throws FileSystemException
*/
public FatFileSystem format(Device device) throws FileSystemException {
Modified: trunk/fs/src/fs/org/jnode/fs/fat/FatUtils.java
===================================================================
--- trunk/fs/src/fs/org/jnode/fs/fat/FatUtils.java 2009-03-24 12:32:31 UTC (rev 5148)
+++ trunk/fs/src/fs/org/jnode/fs/fat/FatUtils.java 2009-03-24 13:40:22 UTC (rev 5149)
@@ -89,7 +89,7 @@
* Return the name (without extension) of a full file name
*
* @param nameExt
- * @return
+ * @return the name part
*/
public static String splitName(String nameExt) {
int i = nameExt.indexOf('.');
@@ -104,7 +104,7 @@
* Return the extension (without name) of a full file name
*
* @param nameExt
- * @return
+ * @return the extension part
*/
public static String splitExt(String nameExt) {
int i = nameExt.indexOf('.');
@@ -118,9 +118,9 @@
/**
* Normalize full file name in DOS 8.3 format from the name and the ext
*
- * @param name
- * @param ext
- * @return
+ * @param name a DOS 8 name
+ * @param ext a DOS 3 extension
+ * @return the normalized DOS 8.3 name
*/
public static String normalizeName(String name, String ext) {
if (ext.length() > 0) {
@@ -133,8 +133,8 @@
/**
* Normalize full file name in DOS 8.3 format from the given full name
*
- * @param nameExt
- * @return
+ * @param nameExt a DOS 8.3 name + extension
+ * @return the normalized DOS 8.3 name
*/
public static String normalizeName(String nameExt) {
if (nameExt.equals("."))
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
