From: adam <adam@megacz.com>
Date: Mon, 3 Nov 2008 09:34:37 +0000 (+0100)
Subject: better comments in FleetProcess.java
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=9eb1b36978c289e7caa3137b0544c59a1e3acfe8;p=fleet.git

better comments in FleetProcess.java
---

diff --git a/src/edu/berkeley/fleet/api/FleetProcess.java b/src/edu/berkeley/fleet/api/FleetProcess.java
index 2b8f9d7..80d9f6c 100644
--- a/src/edu/berkeley/fleet/api/FleetProcess.java
+++ b/src/edu/berkeley/fleet/api/FleetProcess.java
@@ -7,8 +7,8 @@ import java.util.*;
  *  facilities controlled by the "master" JVM.
  *
  *  <p>Each Fleet which supports this API must include:
- *  <ul><li> The ability to dispatch instructions from the master, "on
- *           the fly".
+ *  <ul><li> The ability to dispatch instructions, words, and tokens
+ *           from the master, "on the fly".
  *      <li> A "debug.in" dock such that any words delivered there
  *           are sent back to the master.
  *  </ul>
@@ -32,14 +32,18 @@ public abstract class FleetProcess {
     /** Terminate the process; subclasses may be assured that this will be called exactly once. */
     protected abstract void _terminate();
 
+    /** Terminate the process. */
     public final synchronized void terminate() {
         if (terminated) return;
         terminated = true;
         _terminate();
     }
 
+    /** Returns true if the process is terminated */
     public final boolean isTerminated() { return terminated; }
+
     public synchronized void finalize() { terminate(); }
 
+    /** return the Fleet that this FleetProcess controls */
     public abstract Fleet getFleet();
 }