Changeset 13146

Timestamp:

01/14/11 09:43:43 (12 years ago)

Author:

ehuelsmann

Message:

Add class documentation for recently added classes.

Location:

trunk/abcl/src/org/armedbear/lisp

Files:

• IntegrityError.java (modified) (1 diff)
• ProcessingTerminated.java (modified) (1 diff)

trunk/abcl/src/org/armedbear/lisp/IntegrityError.java

@@ -34 +34 @@
 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
 {

trunk/abcl/src/org/armedbear/lisp/ProcessingTerminated.java

@@ -34 +34 @@
 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
 {