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

[Mark Evenson]

Author: mevenson
Date: Mon Mar 15 06:57:44 2010
New Revision: 12541

Log:
Document INSPECT protocol for getParts().


Modified:
   trunk/abcl/src/org/armedbear/lisp/LispObject.java

Modified: trunk/abcl/src/org/armedbear/lisp/LispObject.java
==============================================================================
--- trunk/abcl/src/org/armedbear/lisp/LispObject.java	(original)
+++ trunk/abcl/src/org/armedbear/lisp/LispObject.java	Mon Mar 15 06:57:44 2010
@@ -71,6 +71,15 @@
     return new SimpleString(sb);
   }
 
+  /** 
+   *  Implementing the getParts() protocol will allow INSPECT to
+   *  return information about the substructure of a descendent of
+   *  LispObject.
+   *  
+   *  The protocol is to return a List of Cons pairs, where the car of
+   *  each pair contains a decriptive string, and the cdr returns a
+   *  subobject for inspection.
+   */
   public LispObject getParts()
   {
     return NIL;