commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject svn commit: r293039 - in /jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io: EndianUtils.java FileSystemUtils.java input/DemuxInputStream.java output/DemuxOutputStream.java
Date Sat, 01 Oct 2005 23:00:45 GMT
Author: scolebourne
Date: Sat Oct  1 16:00:40 2005
New Revision: 293039

URL: http://svn.apache.org/viewcvs?rev=293039&view=rev
Log:
Javadoc fixes

Modified:
    jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java
    jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java
    jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/input/DemuxInputStream.java
    jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/output/DemuxOutputStream.java

Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java?rev=293039&r1=293038&r2=293039&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/EndianUtils.java Sat Oct
 1 16:00:40 2005
@@ -460,6 +460,12 @@
         return Double.longBitsToDouble( readSwappedLong( input ) );
     }
 
+    /**
+     * Reads the next byte from the input stream.
+     * @param input  the stream
+     * @return the byte
+     * @throws IOException if the end of file is reached
+     */
     private static int read(InputStream input)
         throws IOException
     {

Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java?rev=293039&r1=293038&r2=293039&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java Sat
Oct  1 16:00:40 2005
@@ -126,6 +126,7 @@
      * It uses 'dir /-c' on Windows and 'df' on *nix.
      *
      * @param path  the path to get free space for, not null, not empty on Unix
+     * @param os  the operating system code
      * @return the amount of free drive space on the drive or volume
      * @throws IllegalArgumentException if the path is invalid
      * @throws IllegalStateException if an error occurred in initialisation
@@ -315,6 +316,7 @@
      *
      * @param params  the command parameters
      * @return a reader
+     * @throws IOException if an error occurs
      */
     BufferedReader openProcessStream(String[] params) throws IOException {
         Process proc = Runtime.getRuntime().exec(params);

Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/input/DemuxInputStream.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/input/DemuxInputStream.java?rev=293039&r1=293038&r2=293039&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/input/DemuxInputStream.java
(original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/input/DemuxInputStream.java
Sat Oct  1 16:00:40 2005
@@ -80,6 +80,8 @@
 
     /**
      * Utility method to retrieve stream bound to current thread (if any).
+     *
+     * @return the input stream
      */
     private InputStream getStream()
     {

Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/output/DemuxOutputStream.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/output/DemuxOutputStream.java?rev=293039&r1=293038&r2=293039&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/output/DemuxOutputStream.java
(original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/output/DemuxOutputStream.java
Sat Oct  1 16:00:40 2005
@@ -91,6 +91,8 @@
 
     /**
      * Utility method to retrieve stream bound to current thread (if any).
+     *
+     * @return the output stream
      */
     private OutputStream getStream()
     {



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message