improve javadoc comments in Fleet.java

diff --git a/src/edu/berkeley/fleet/api/Fleet.java b/src/edu/berkeley/fleet/api/Fleet.java
index 299f59d..ca06e08 100644 (file)
--- a/src/edu/berkeley/fleet/api/Fleet.java
+++ b/src/edu/berkeley/fleet/api/Fleet.java
@@ -37,16 +37,16 @@ public abstract class Fleet implements Iterable<Ship> {
     public abstract int getSetWidth();
     
     /**
-     *  Read a machine-formatted instruction from a file.
-     *   @is           The stream to read from.
-     *   @dispatchFrom The dock from which the instructions being read are to be dispatched (required for decoding)
+     *  Encodes an instruction as a BitVector
+     *   @instruction  The instruction to encode
+     *   @dispatchFrom The dock from which the instruction being written is to be dispatched (required for encoding)
      */
     public abstract Instruction readInstruction(DataInputStream is, Dock dispatchFrom) throws IOException;
 
     /**
-     *  Write a machine-formatted instruction to a file.
-     *   @os           The stream to write to.
-     *   @dispatchFrom The dock from which the instruction being written is to be dispatched (required for encoding)
+     *  Decodes an instruction from a BitVector
+     *   @instruction  The instruction to decode
+     *   @dispatchFrom The dock from which the instructions being read are to be dispatched (required for decoding)
      */
     public abstract void        writeInstruction(DataOutputStream os, Dock dispatchFrom, Instruction instr) throws IOException;