Javadocs

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk@140378 13f79535-47bb-0310-9956-ffa450edef68

Author: jmaerki

src/java/org/apache/commons/io/HexDump.java

@@ -1,7 +1,7 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//io/src/java/org/apache/commons/io/HexDump.java,v 1.1 2002/02/22 06:12:38 bayard Exp $
- * $Revision: 1.1 $
- * $Date: 2002/02/22 06:12:38 $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//io/src/java/org/apache/commons/io/HexDump.java,v 1.2 2003/07/27 17:20:59 jeremias Exp $
+ * $Revision: 1.2 $
+ * $Date: 2003/07/27 17:20:59 $
  *
  * ====================================================================
  *
@@ -56,28 +56,22 @@
  * individuals on behalf of the Apache Software Foundation.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
- *
  */
-
-
 package org.apache.commons.io;
 
-
 import java.io.IOException;
 import java.io.OutputStream;
 
-
 /**
- * dump data in hexadecimal format; derived from a HexDump utility I
+ * Dump data in hexadecimal format; derived from a HexDump utility I
  * wrote in June 2001
  *
  * Taken from the POI project
  *
  * @author Scott Sanders (sanders at apache dot org)
  * @author Marc Johnson
- * @version $Revision: 1.1 $ $Date: 2002/02/22 06:12:38 $
+ * @version $Revision: 1.2 $ $Date: 2003/07/27 17:20:59 $
  */
-
 public class HexDump {
 
     // all static methods, so no need for a public constructor
@@ -146,6 +140,7 @@ public static void dump(final byte[] data, final long offset,
         }
     }
 
+    /** line-separator (initializes to "line.separator" system property. */
     public static final String EOL =
             System.getProperty("line.separator");
     private static final StringBuffer _lbuffer = new StringBuffer(8);

src/java/org/apache/commons/io/IOUtils.java

@@ -111,16 +111,8 @@
  * (or three if the destination stream is also buffered) is pointless, and the unnecessary buffer
  * management hurts performance slightly (about 3%, according to some simple experiments).</p>
  *
- * <p>Origin of code: Apache Avalon (Excalibur)</p>
- *
- * @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @author <a href="mailto:jefft@apache.org">Jeff Turner</a>
- * @version CVS $Revision: 1.2 $ $Date: 2003/07/25 08:17:10 $
- */
-
-/*
- * Behold, intrepid explorers; a map of this class:
- *
+ * <p>Behold, intrepid explorers; a map of this class:</p>
+ * <pre>
  *       Method      Input               Output          Dependency
  *       ------      -----               ------          -------
  * 1     copy        InputStream         OutputStream    (primitive)
@@ -141,12 +133,18 @@
  * 12    copy        byte[]              Writer          3
  * 13    toString    byte[]              String          12
  * 14    copy        byte[]              OutputStream    (trivial)
+ * </pre>
  *
+ * <p>Note that only the first two methods shuffle bytes; the rest use these 
+ * two, or (if possible) copy using native Java copy methods. As there are 
+ * method variants to specify buffer size and encoding, each row may 
+ * correspond to up to 4 methods.</p>
  *
- * Note that only the first two methods shuffle bytes; the rest use these two, or (if possible) copy
- * using native Java copy methods. As there are method variants to specify buffer size and encoding,
- * each row may correspond to up to 4 methods.
+ * <p>Origin of code: Apache Avalon (Excalibur)</p>
  *
+ * @author <a href="mailto:peter@apache.org">Peter Donald</a>
+ * @author <a href="mailto:jefft@apache.org">Jeff Turner</a>
+ * @version CVS $Revision: 1.3 $ $Date: 2003/07/27 17:21:27 $
  */
 public final class IOUtils
 {