Changeset 13908 for trunk/abcl/src/org/armedbear/lisp/java.lisp

Timestamp:

04/06/12 11:59:48 (12 years ago)

Author:

Mark Evenson

Message:

docstrings: document JAVA:JNEW-ARRAY-FROM-LIST and some friends.

File:

• trunk/abcl/src/org/armedbear/lisp/java.lisp (modified) (5 diffs)

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

@@ -195 +195 @@
 
 (defun jarray-length (java-array)
+  "Returns the length of a Java primitive array."
   (jstatic "getLength" "java.lang.reflect.Array" java-array)  )
 
@@ -202 +203 @@
 (defun jnew-array-from-array (element-type array)
   "Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
-   initialized from ARRAY"
+   initialized from ARRAY."
   (flet
     ((row-major-to-index (dimensions n)
@@ -221 +222 @@
 
 (defun jnew-array-from-list (element-type list)
+  "Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
+   initialized from a Lisp list."
   (let ((jarray (jnew-array element-type (length list)))
   (i 0))
@@ -368 +371 @@
       (error "Unknown load-form for ~A" class-name)))))
 
-(defun jproperty-value (obj prop)
-  (%jget-property-value obj prop))
+(defun jproperty-value (object property)
+  "setf-able access on the Java Beans notion of property named PROPETRY on OBJECT."
+  (%jget-property-value object property))
 
 (defun (setf jproperty-value) (value obj prop)
@@ -452 +456 @@
 
 (defun ensure-java-class (jclass)
+  "Attempt to ensure that the Java class referenced by JCLASS exists in the current process of the implementation."
   (let ((class (%find-java-class jclass)))
     (if class