svn commit: r1475824 - in /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers: ArchiveOutputStream.java ArchiveStreamFactory.java

[bo...@apache.org]

Author: bodewig
Date: Thu Apr 25 15:25:04 2013
New Revision: 1475824

URL: http://svn.apache.org/r1475824
Log:
Some Javadoc fixes submitted by Andreas Krüger

Modified:
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java?rev=1475824&r1=1475823&r2=1475824&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java Thu Apr 25 15:25:04 2013
@@ -28,18 +28,21 @@ import java.io.OutputStream;
  * They should also override {@link #close()} to ensure that any necessary
  * trailers are added.
  * 
- * <p>
- * The normal sequence of calls for working with ArchiveOutputStreams is:
- * + create ArchiveOutputStream object
- * + write SFX header (optional, Zip only)
- * + repeat as needed:
- *      - putArchiveEntry() (writes entry header)
- *      - write() (writes entry data)
- *      - closeArchiveEntry() (closes entry)
- * + finish() (ends the addition of entries)
- * + write additional data if format supports it (optional)
- * + close()
- * </p>
+ * <p>The normal sequence of calls when working with ArchiveOutputStreams is:</p>
+ * <ul>
+ *   <li>Create ArchiveOutputStream object,</li>
+ *   <li>optionally write SFX header (Zip only),</li>
+ *   <li>repeat as needed:
+ *     <ul>
+ *       <li>{@link #putArchiveEntry(ArchiveEntry)} (writes entry header),
+ *       <li>{@link #write(byte[])} (writes entry data, as often as needed),
+ *       <li>{@link #closeArchiveEntry()} (closes entry),
+ *     </ul>
+ *   </li>
+ *   <li> {@link #finish()} (ends the addition of entries),</li>
+ *   <li> optionally write additional data, provided format supports it,</li>
+ *   <li>{@link #close()}.</li>
+ * </ul>
  * 
  * <p>
  * Example usage:<br/>
@@ -77,9 +80,7 @@ public abstract class ArchiveOutputStrea
      * Finishes the addition of entries to this stream, without closing it.
      * Additional data can be written, if the format supports it.
      * 
-     * The finish() method throws an Exception if the user forgets to close the entry
-     * .
-     * @throws IOException
+     * @throws IOException if the user forgets to close the entry.
      */
     public abstract void finish() throws IOException;
 
@@ -99,9 +100,9 @@ public abstract class ArchiveOutputStrea
     /**
      * Writes a byte to the current archive entry.
      *
-     * This method simply calls write( byte[], 0, 1 ).
+     * <p>This method simply calls {@code write( byte[], 0, 1 )}.
      *
-     * MUST be overridden if the {@link #write(byte[], int, int)} method
+     * <p>MUST be overridden if the {@link #write(byte[], int, int)} method
      * is not overridden; may be overridden otherwise.
      * 
      * @param b The byte to be written.
@@ -115,7 +116,7 @@ public abstract class ArchiveOutputStrea
 
     /**
      * Increments the counter of already written bytes.
-     * Doesn't increment if the EOF has been hit ({@code written} == -1)
+     * Doesn't increment if EOF has been hit ({@code written == -1}).
      * 
      * @param written the number of bytes written
      */
@@ -125,7 +126,7 @@ public abstract class ArchiveOutputStrea
 
     /**
      * Increments the counter of already written bytes.
-     * Doesn't increment if the EOF has been hit ({@code written} == -1)
+     * Doesn't increment if EOF has been hit ({@code written == -1}).
      * 
      * @param written the number of bytes written
      * @since 1.1

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java?rev=1475824&r1=1475823&r2=1475824&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java Thu Apr 25 15:25:04 2013
@@ -36,10 +36,10 @@ import org.apache.commons.compress.archi
 import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
 
 /**
- * <p>Factory to create Archive[In|Out]putStreams from names or the first bytes of
- * the InputStream. In order add other implementations you should extend
+ * Factory to create Archive[In|Out]putStreams from names or the first bytes of
+ * the InputStream. In order to add other implementations, you should extend
  * ArchiveStreamFactory and override the appropriate methods (and call their
- * implementation from super of course).</p>
+ * implementation from super of course).
  * 
  * Compressing a ZIP-File:
  *