Commit 4e1dd22b authored by Daniel Dreibrodt's avatar Daniel Dreibrodt

javadoc improvement

parent 16f6c757
......@@ -187,8 +187,6 @@ Registry
*
* @param keyName The name of the top level key.
* @return The top level RegistryKey, or null if unknown keyName.
*
* @see topLevelKeys
*/
public static RegistryKey
......
......@@ -227,12 +227,12 @@ RegistryKey
/**
* Open a Registry subkey of this key with the specified access.
*
* @param subkey The name of the subkey to open.
* @param subKey The name of the subkey to open.
* @param access The access level for the open.
* @return The newly opened RegistryKey.
*
* @exception NoSuchKeyException If the subkey does not exist.
* @exception RegistryException Any other registry API error.
* @exception NoSuchKeyException If the subkey does not exist.
* @exception RegistryException Any other registry API error.
*/
public native RegistryKey
......@@ -518,7 +518,7 @@ RegistryKey
* of System environment variables that are referenced via the
* %variable% construct. This method invokes EnvExpandStrings().
*
* @param valueName The name of the value to increment.
* @param exString The name of the value to increment.
*/
public static native String
......
......@@ -643,7 +643,7 @@ TarArchive extends Object
* and then, if the recurse flag is true, process each entry that is a
* child of the directory.
*
* @param entry The TarEntry representing the entry to write to the archive.
* @param oldEntry The TarEntry representing the entry to write to the archive.
* @param recurse If true, process the children of directory entries.
*/
......
......@@ -515,8 +515,7 @@ implements Cloneable
/**
* Set this entry's modification time.
*
* @param time This entry's new modification time.
* @return The entry's modification time
*/
public Date
getModTime()
......@@ -796,7 +795,7 @@ implements Cloneable
* Old unix-style code contributed by David Mehringer <dmehring@astro.uiuc.edu>.
*
* @param hdr The TarHeader to fill in from the buffer information.
* @param header The tar entry header buffer to get information from.
* @param headerBuf The tar entry header buffer to get information from.
*/
public void
parseTarHeader( TarHeader hdr, byte[] headerBuf )
......
......@@ -49,7 +49,7 @@ implements Enumeration
* exists then the constructor should be made <B>protected</B> and an empty
* subclass should be written in the other package.
*
* @param <B>tis</B> the <B>TarInputStream</B> on which this enumeration has
* @param tis the <B>TarInputStream</B> on which this enumeration has
* to be based.
*/
public
......
......@@ -314,9 +314,7 @@ implements Cloneable
* Contributed by Dmitri Tikhonov <dxt2431@yahoo.com>
*
* @param header The header buffer from which to parse.
* @param offset The offset into the buffer from which to parse.
* @param length The number of header bytes to parse.
* @return The header's entry name.
* @return The file name
*/
public static StringBuffer
parseFileName( byte[] header )
......@@ -428,8 +426,8 @@ implements Cloneable
/**
* Move the bytes from the name StringBuffer into the header's buffer.
*
* @param header The header buffer into which to copy the name.
* @param name The source StringBuffer
* @param buf The header buffer into which to copy the name.
* @param offset The offset into the buffer at which to store.
* @param length The number of header bytes to store.
* @return The new offset (offset + length).
......@@ -455,7 +453,8 @@ implements Cloneable
/**
* Parse an octal integer from a header buffer.
*
* @param header The header buffer from which to parse.
* @param value
* @param buf The header buffer from which to parse.
* @param offset The offset into the buffer from which to parse.
* @param length The number of header bytes to parse.
* @return The integer value of the octal bytes.
......@@ -498,7 +497,8 @@ implements Cloneable
/**
* Parse an octal long integer from a header buffer.
*
* @param header The header buffer from which to parse.
* @param value
* @param buf The header buffer from which to parse.
* @param offset The offset into the buffer from which to parse.
* @param length The number of header bytes to parse.
* @return The long value of the octal bytes.
......@@ -515,7 +515,7 @@ implements Cloneable
/**
* Parse the checksum octal integer from a header buffer.
*
* @param header The header buffer from which to parse.
* @param buf The header buffer from which to parse.
* @param offset The offset into the buffer from which to parse.
* @param length The number of header bytes to parse.
* @return The integer value of the entry's checksum.
......
......@@ -95,9 +95,8 @@ extends FilterInputStream
}
/**
* Sets the debugging flag.
*
* @param debugF True to turn on debugging.
* Sets the entry factory
* @param factory The new entry factory
*/
public void
setEntryFactory( EntryFactory factory )
......@@ -111,9 +110,9 @@ extends FilterInputStream
* @param debugF True to turn on debugging.
*/
public void
setBufferDebug( boolean debug )
setBufferDebug( boolean debugF )
{
this.buffer.setDebug( debug );
this.buffer.setDebug( debugF );
}
/**
......@@ -223,7 +222,7 @@ extends FilterInputStream
* This method returns the number of bytes that have been read
* from the current TarEntry's data.
*
* @returns The current entry offset.
* @return The current entry offset.
*/
public long
......@@ -238,7 +237,7 @@ extends FilterInputStream
* so it represents the actual position in input stream, as
* opposed to the place where the tar archive parsing is.
*
* @returns The current file pointer.
* @return The current file pointer.
*/
public long
......
......@@ -92,9 +92,9 @@ extends FilterOutputStream
* @param debugF True to turn on debugging.
*/
public void
setBufferDebug( boolean debug )
setBufferDebug( boolean debugF )
{
this.buffer.setDebug( debug );
this.buffer.setDebug( debugF );
}
/**
......@@ -242,7 +242,6 @@ extends FilterOutputStream
* This method simply calls read( byte[], int, int ).
*
* @param wBuf The buffer to write to the archive.
* @return The number of bytes read, or -1 at EOF.
*/
public void
write( byte[] wBuf )
......
......@@ -21,22 +21,8 @@ on their extension, as you archive and extract files.
The package is designed to allow you to integrate tar
archive support into any Java application.
@author Tim Endres <mailto:time@gjt.com>
@author Tim Endres <mailto:time@gjt.com> <http://www.trustice.com/java/tar/>
@version 1.2
@gjtrel $Name: $
@gjtdate $Date: 2002/02/22 01:32:41 $
@gjtjvm 1.1
@gjtreq <http://www.gjt.org/req/jaf/> JAF 1.0
@gjtcat application
@gjtcat utilitity
@gjtcat filter
@gjtcat stream
@gjtcat tar
@gjtcat archive
@gjthome <http://www.trustice.com/java/tar/> Java Tar Home Page
@gjtlicense PD
</body>
</html>
......@@ -122,11 +122,11 @@ public class Slider extends Item implements ActionListener{
* Parses a slider contained in a Playtree from a XML node
* @param n The XML node
* @param s_ The parent skin
* @param inPt The boolean value indicating whether the slider is inside a playtree or not
* @param isInPlaytree The boolean value indicating whether the slider is inside a playtree or not
*/
public Slider(Node n, Skin s_, boolean iPt) {
public Slider(Node n, Skin s_, boolean isInPlaytree) {
this(n, s_);
inPlaytree = iPt;
inPlaytree = isInPlaytree;
}
/** Creates a new instance of Slider
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment