Update doc strings

tobias · Sep 26, 2012 · 5309eab · 5309eab
1 parent 8004f4d
commit 5309eab
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/debugger/src/ritz/jpda/debug.clj b/debugger/src/ritz/jpda/debug.clj
@@ -62,6 +62,7 @@
 (defn launch-vm
   "Launch and configure the vm for the debugee."
   [{:keys [classpath main] :as options}]
+  (trace "debug/launch-vm")
   (jdi/vm-event-daemon
    (jdi-clj/vm-rt
     (jdi-vm/launch-vm (or classpath (jdi-vm/current-classpath)) main options))))

diff --git a/debugger/src/ritz/jpda/jdi_vm.clj b/debugger/src/ritz/jpda/jdi_vm.clj
@@ -150,14 +150,17 @@
 
 ;;; VM Control
 (defn wrap-launch-cmd
+  "Returns a form that starts a thread for use as the control thread, and then
+executes the provided `cmd`."
   [cmd]
   `(do
      ~(start-control-thread-body control-thread-name)
      ~cmd))
 
 (defn launch-vm
   "Launch a vm and provide a control thread. Returns a context map.
-   The vm is in a suspended state when returned."
+   The vm is in a suspended state when returned. Threads are started
+   to copy the vm's in out and err streams."
   [classpath cmd {:as options}]
   (logging/trace
    "launch-vm %s\n%s" classpath (with-out-str (pprint/pprint cmd)))