svn commit: r996660 - in /commons/proper/exec/trunk/src/main/java/org/apache/commons/exec: ExecuteWatchdog.java Executor.java

[sg...@apache.org]

Author: sgoeschl
Date: Mon Sep 13 19:39:57 2010
New Revision: 996660

URL: http://svn.apache.org/viewvc?rev=996660&view=rev
Log:
[EXEC-42] Improving the documentation

Modified:
    commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
    commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/Executor.java

Modified: commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
URL: http://svn.apache.org/viewvc/commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java?rev=996660&r1=996659&r2=996660&view=diff
==============================================================================
--- commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java (original)
+++ commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java Mon Sep 13 19:39:57 2010
@@ -37,6 +37,10 @@ import org.apache.commons.exec.util.Debu
  * keeper of the process handle. In some cases it is useful not to define
  * a timeout (and pass 'INFINITE_TIMEOUT') and to kill the process explicitly
  * using 'destroyProcess()'.
+ * <p>
+ * Please note that ExecuteWatchdog is processed asynchronously, e.g. it might
+ * be still attached to a process even after the DefaultExecutor.execute 
+ * has returned.
  *
  * @see org.apache.commons.exec.Executor
  * @see org.apache.commons.exec.Watchdog

Modified: commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/Executor.java
URL: http://svn.apache.org/viewvc/commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/Executor.java?rev=996660&r1=996659&r2=996660&view=diff
==============================================================================
--- commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/Executor.java (original)
+++ commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/Executor.java Mon Sep 13 19:39:57 2010
@@ -68,7 +68,7 @@ public interface Executor {
      *  <li>null to indicate to skip checking of exit codes</li>
      * </ul>
      *
-     * If a different exit value is returned by the process then
+     * If an undefined exit value is returned by the process then
      * {@link org.apache.commons.exec.Executor#execute(CommandLine)}  will
      * throw an {@link org.apache.commons.exec.ExecuteException}.
      *