[cl-selenium-cvs] CVS cl-selenium

[mkennedy]

Update of /project/cl-selenium/cvsroot/cl-selenium
In directory clnet:/tmp/cvs-serv7506

Modified Files:
	ChangeLog iedoc.lisp packages.lisp selenium.lisp 
Log Message:
Add doc strings.


--- /project/cl-selenium/cvsroot/cl-selenium/ChangeLog	2008/01/20 20:01:43	1.1.1.1
+++ /project/cl-selenium/cvsroot/cl-selenium/ChangeLog	2008/01/24 15:40:40	1.2
@@ -1,3 +1,7 @@
+2008-01-24  Matthew Kennedy
+
+	* packages.lisp: Add documentation strings.
+
 2008-01-15  Matthew Kennedy
 
 	* selenium.lisp: Use define-iedoc to parse iedoc-0.8.3-1879.xml at
--- /project/cl-selenium/cvsroot/cl-selenium/iedoc.lisp	2008/01/20 20:01:43	1.1.1.1
+++ /project/cl-selenium/cvsroot/cl-selenium/iedoc.lisp	2008/01/24 15:40:40	1.2
@@ -157,5 +157,11 @@
 
 #+nil (mapcar #'convert-function (parse-iedoc #p"/selenium-core-0.8.2/core/iedoc.xml"))
 
-(defvar *selenium-driver-url* (puri:parse-uri "http://localhost:9999/selenium-server/driver/"))
-(defvar *selenium-session* nil)
+(defvar *selenium-driver-url* (puri:parse-uri "http://localhost:9999/selenium-server/driver/")
+  "The URL of the Selenium Remote Control server.")
+
+(defvar *selenium-session* nil
+  "Almost all functions take an optional argument called session which
+  defaults to this special variable.  You can bind a selenium session
+  to this variable and use those functions without providing an
+  explicit session each time.")
--- /project/cl-selenium/cvsroot/cl-selenium/packages.lisp	2008/01/20 20:01:43	1.1.1.1
+++ /project/cl-selenium/cvsroot/cl-selenium/packages.lisp	2008/01/24 15:40:40	1.2
@@ -1,11 +1,11 @@
 (defpackage #:selenium
   (:use #:common-lisp)
+  (:documentation "An interface to Selenium Remote Control.")
   (:export 
-   *selenium-session*
-   *selenium-driver-url*
-   define-iedoc
-   do-get-new-browser-session
-   do-test-complete
-   base-error
-   http-error
-   execution-error))
+   #:*selenium-session*
+   #:*selenium-driver-url*
+   #:do-get-new-browser-session
+   #:do-test-complete
+   #:base-error
+   #:http-error
+   #:execution-error))
--- /project/cl-selenium/cvsroot/cl-selenium/selenium.lisp	2008/01/20 20:01:43	1.1.1.1
+++ /project/cl-selenium/cvsroot/cl-selenium/selenium.lisp	2008/01/24 15:40:40	1.2
@@ -14,6 +14,7 @@
 		       *compile-file-pathname*))
 
 (defun do-get-new-browser-session (browser url)
+  "Create a session by using the the given browser and initial URL."
   (execute  (puri:merge-uris (make-instance 'puri:uri :query (marshall-request "getNewBrowserSession" browser url))
                              *selenium-driver-url*)))