svn commit: r1208352 - /incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/cmdline/TerminateToolException.java

[jo...@apache.org]

Author: joern
Date: Wed Nov 30 09:58:15 2011
New Revision: 1208352

URL: http://svn.apache.org/viewvc?rev=1208352&view=rev
Log:
OPENNLP-402 Extended javadoc.  Thanks to Aliaksandr Autayeu for providing a patch.

Modified:
    incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/cmdline/TerminateToolException.java

Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/cmdline/TerminateToolException.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/cmdline/TerminateToolException.java?rev=1208352&r1=1208351&r2=1208352&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/cmdline/TerminateToolException.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/cmdline/TerminateToolException.java Wed Nov 30 09:58:15 2011
@@ -23,6 +23,11 @@ package opennlp.tools.cmdline;
  * The exception should be thrown to indicate that the VM should be terminated with
  * the specified error code, instead of just calling {@link System#exit(int)}.
  * <p>
+ * The return code convention is to return:<br>
+ * 0 in case of graceful termination<br>
+ * -1 in case of runtime errors, such as IOException<br>
+ * 1 in case of invalid parameters.
+ * <p>
  * <b>Note:</b> Do not use this class, internal use only!
  */
 public class TerminateToolException extends RuntimeException {