You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by sg...@apache.org on 2009/02/23 21:43:00 UTC

svn commit: r747130 - in /commons/proper/exec/trunk/src/main/java/org/apache/commons/exec: CommandLine.java PumpStreamHandler.java

Author: sgoeschl
Date: Mon Feb 23 20:42:57 2009
New Revision: 747130

URL: http://svn.apache.org/viewvc?rev=747130&view=rev
Log:
Minor javadoc improvements ....

Modified:
    commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/CommandLine.java
    commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/PumpStreamHandler.java

Modified: commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/CommandLine.java
URL: http://svn.apache.org/viewvc/commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/CommandLine.java?rev=747130&r1=747129&r2=747130&view=diff
==============================================================================
--- commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/CommandLine.java (original)
+++ commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/CommandLine.java Mon Feb 23 20:42:57 2009
@@ -395,6 +395,7 @@
      * replaced with the platform specific file seperator char
      *
      * @param executable the executable
+     * @return the platform-specific executable string
      */
     private String getExecutable(final String executable) {
         if (executable == null) {

Modified: commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/PumpStreamHandler.java?rev=747130&r1=747129&r2=747130&view=diff
==============================================================================
--- commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/PumpStreamHandler.java (original)
+++ commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/PumpStreamHandler.java Mon Feb 23 20:42:57 2009
@@ -255,6 +255,10 @@
     /**
      * Creates a stream pumper to copy the given input stream to the given
      * output stream.
+     *
+     * @param is the input stream to copy from
+     * @param os the output stream to copy into
+     * @return the stream pumper thread
      */
     protected Thread createPump(final InputStream is, final OutputStream os) {
         return createPump(is, os, false);
@@ -263,6 +267,11 @@
     /**
      * Creates a stream pumper to copy the given input stream to the given
      * output stream.
+     *
+     * @param is the input stream to copy from
+     * @param os the output stream to copy into
+     * @param closeWhenExhausted close the output stream when the input stream is exhausted
+     * @return the stream pumper thread
      */
     protected Thread createPump(final InputStream is, final OutputStream os,
             final boolean closeWhenExhausted) {