added some more documentation on command-object
authorRyan Davis <ryan@acceleration.net>
Tue, 15 Nov 2011 15:54:24 +0000 (10:54 -0500)
committerRyan Davis <ryan@acceleration.net>
Tue, 15 Nov 2011 15:54:24 +0000 (10:54 -0500)
sql/command-object.lisp

index 3b752ef3ca003a902c79b696eb4b8838a3d3773b..d931bac46ed4fd63240c5ada0b0003844b4804a0 100644 (file)
 (in-package #:clsql-sys)
 
 (defclass command-object ()
-  ((expression :accessor expression :initarg :expression :initform nil)
-   (parameters :accessor parameters :initarg :parameters :initform nil)
+  ((expression :accessor expression :initarg :expression :initform nil
+               :documentation "query that refers to parameters using \"$1\", \"$2\", \"$n\".
+       These match positions in the parameters list.")
+   (parameters :accessor parameters :initarg :parameters :initform nil
+               :documentation "list of parameters")
    (prepared-name :accessor prepared-name :initarg :prepared-name :initform ""
     :documentation "If we want this to be a prepared statement, give it a name
        to identify it to this session")
    (has-been-prepared :accessor has-been-prepared :initarg :has-been-prepared :initform nil
-                     :documentation "Have we already prepared this command object")
+                     :documentation "Have we already prepared this command object?")
    ))
 
 (defmethod initialize-instance :after ((o command-object) &key &allow-other-keys )