commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ebo...@apache.org
Subject svn commit: r668749 - in /commons/sandbox/compress/trunk/src/java/org/apache/commons/compress: Archive.java CompressUtils.java Compressor.java compressors/bzip2/BZip2Compressor.java
Date Tue, 17 Jun 2008 17:09:48 GMT
Author: ebourg
Date: Tue Jun 17 10:09:48 2008
New Revision: 668749

URL: http://svn.apache.org/viewvc?rev=668749&view=rev
Log:
Fixed some variable and exception names in the javadoc

Modified:
    commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Archive.java
    commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/CompressUtils.java
    commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Compressor.java
    commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/compressors/bzip2/BZip2Compressor.java

Modified: commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Archive.java
URL: http://svn.apache.org/viewvc/commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Archive.java?rev=668749&r1=668748&r2=668749&view=diff
==============================================================================
--- commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Archive.java (original)
+++ commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Archive.java Tue Jun
17 10:09:48 2008
@@ -67,7 +67,7 @@
 	/**
 	 * Sets an Archive for manipulating. An archive is set if someone
 	 * saves an Archive or calls getInstance(...) with an archive.
-	 * @param archive file to manipulate
+	 * @param file the file to manipulate
 	 */
 	void setArchive(File file);
 	
@@ -81,7 +81,7 @@
 
 	/**
 	 * Unpacks to the specified directory 
-	 * @param dir to unpack
+	 * @param destinationDir to unpack
 	 * @throws UnpackException if an unpack error occurs
 	 */
 	public void unpack(File destinationDir) throws UnpackException;

Modified: commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/CompressUtils.java
URL: http://svn.apache.org/viewvc/commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/CompressUtils.java?rev=668749&r1=668748&r2=668749&view=diff
==============================================================================
--- commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/CompressUtils.java
(original)
+++ commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/CompressUtils.java
Tue Jun 17 10:09:48 2008
@@ -45,12 +45,12 @@
             output.write( buffer, 0, n );
         }
     }
-    
+
     /**
      * Compares one byte array to another
-	 * @param source- the array to compare to 
-	 * @param headerBytes - the bytearray match
-	 */
+     * @param source the array to compare to
+     * @param match  the bytearray match
+     */
 	public static boolean compareByteArrays(byte[] source, byte[] match) {
 		int i = 0;
 		while(source.length < i || i < match.length ) {

Modified: commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Compressor.java
URL: http://svn.apache.org/viewvc/commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Compressor.java?rev=668749&r1=668748&r2=668749&view=diff
==============================================================================
--- commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Compressor.java (original)
+++ commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/Compressor.java Tue
Jun 17 10:09:48 2008
@@ -89,13 +89,13 @@
 	 * @param input inputstream to decompress
 	 * @return the decompressed InputStream
 	 */
-	public InputStream decompress(InputStream inputStream) throws CompressException;;
+	public InputStream decompress(InputStream input) throws CompressException;;
 	
 	/**
 	 * Decompresses this file and writes the decompressed byte to the output file
 	 * @param input File to decompress
 	 * @param output File to write the decompressed bytes to
-	 * @throws DecompressException if the Compressor reports an error
+	 * @throws CompressException if the Compressor reports an error
 	 */
 	public void decompressTo(File input, File output) throws CompressException;
 	
@@ -103,7 +103,7 @@
 	 * Decompresses this file and writes the decompressed file to the output-stream
 	 * @param input Stream to decompress
 	 * @param output Stream to write the decompressed bytes to
-	 * @throws DecompressException if the Compressor reports an error
+	 * @throws CompressException if the Compressor reports an error
 	 */
 	public void decompressTo(InputStream input, OutputStream output) throws CompressException;
 }

Modified: commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/compressors/bzip2/BZip2Compressor.java
URL: http://svn.apache.org/viewvc/commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/compressors/bzip2/BZip2Compressor.java?rev=668749&r1=668748&r2=668749&view=diff
==============================================================================
--- commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/compressors/bzip2/BZip2Compressor.java
(original)
+++ commons/sandbox/compress/trunk/src/java/org/apache/commons/compress/compressors/bzip2/BZip2Compressor.java
Tue Jun 17 10:09:48 2008
@@ -100,7 +100,7 @@
 	 * BZip2OutputStream object ready for use, as required by the
 	 * BZip2OutputStream class.
 	 * 
-	 * @param output {@link Output} stream to add a header to
+	 * @param output {@link OutputStream} to add a header to
 	 * @return {@link BZip2OutputStream} ready to write to
 	 * @throws IOException if an IO error occurs
 	 */



Mime
View raw message