[armedbear-cvs] r13146 - trunk/abcl/src/org/armedbear/lisp

[Erik Huelsmann]

Author: ehuelsmann
Date: Fri Jan 14 04:43:43 2011
New Revision: 13146

Log:
Add class documentation for recently added classes.

Modified:
   trunk/abcl/src/org/armedbear/lisp/IntegrityError.java
   trunk/abcl/src/org/armedbear/lisp/ProcessingTerminated.java

Modified: trunk/abcl/src/org/armedbear/lisp/IntegrityError.java
==============================================================================
--- trunk/abcl/src/org/armedbear/lisp/IntegrityError.java	(original)
+++ trunk/abcl/src/org/armedbear/lisp/IntegrityError.java	Fri Jan 14 04:43:43 2011
@@ -33,6 +33,10 @@
 
 package org.armedbear.lisp;
 
+/** This error is invoked in situations where the code can't continue
+ * because some precondition isn't met, although it's not an assertion
+ * error per se.
+ */
 public class IntegrityError extends Error
 {
     public IntegrityError()

Modified: trunk/abcl/src/org/armedbear/lisp/ProcessingTerminated.java
==============================================================================
--- trunk/abcl/src/org/armedbear/lisp/ProcessingTerminated.java	(original)
+++ trunk/abcl/src/org/armedbear/lisp/ProcessingTerminated.java	Fri Jan 14 04:43:43 2011
@@ -33,6 +33,12 @@
 
 package org.armedbear.lisp;
 
+/** This error is thrown when the EXT:EXIT or EXT:QUIT function
+ * is being invoked.  In the stand-alone case, it terminates the
+ * entire JVM, if caught in Interpreter.run().
+ *
+ * In the embedding case, it's up to the embedder what to do with it.
+ */
 public class ProcessingTerminated extends Error
 {
     private int status;