improved javadoc

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

Author: hen

src/java/org/apache/commons/io/input/SwappedDataInputStream.java

@@ -24,18 +24,21 @@
 
 /**
  * DataInput for systems relying on little endian data formats.
+ * When read, values will be changed from little endian to big 
+ * endian formats for internal usage. 
  *
  * <p><b>Origin of code: </b>Avalon Excalibur (IO)</p>
  *
  * @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version CVS $Revision: 1.7 $ $Date: 2004/02/23 04:38:52 $
+ * @version CVS $Revision: 1.8 $ $Date: 2004/02/23 04:56:59 $
  */
 public class SwappedDataInputStream extends ProxyInputStream
     implements DataInput
 {
 
     /**
      * Constructs a SwappedDataInputStream.
+     *
      * @param input InputStream to read from
      */
     public SwappedDataInputStream( InputStream input )
@@ -112,7 +115,11 @@ public int readInt()
         return EndianUtils.readSwappedInteger( in );
     }
 
-    /** @see java.io.DataInput#readLine() */
+    /**
+     * Not currently supported.
+     *
+     * @see java.io.DataInput#readLine()
+     */
     public String readLine()
         throws IOException, EOFException
     {
@@ -148,7 +155,11 @@ public int readUnsignedShort()
         return EndianUtils.readSwappedUnsignedShort( in );
     }
 
-    /** @see java.io.DataInput#readUTF() */
+    /**
+     * Not currently supported. 
+     *
+     * @see java.io.DataInput#readUTF() 
+     */
     public String readUTF()
         throws IOException, EOFException
     {