Whitespace

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@6126 542714f4-19e9-0310-aa3c-eee0fc999fb1

src/java/com/threerings/presents/dobj/ChangeListener.java

@@ -22,12 +22,10 @@
 package com.threerings.presents.dobj;
 
 /**
- * The various listener interfaces (e.g. {@link EventListener}, {@link
+ * The various listener interfaces (e.g. {@link EventListener}, {@link AttributeChangeListener},
- * AttributeChangeListener}, etc.) all extend this base interface so that
+ * etc.) all extend this base interface so that the distributed object can check to make sure when
- * the distributed object can check to make sure when an object is adding
+ * an object is adding itself as a listener of some sort that it actually implements at least one
- * itself as a listener of some sort that it actually implements at least
+ * of the listener interfaces. Thus, all listener interfaces must extend this one.
- * one of the listener interfaces. Thus, all listener interfaces must
- * extend this one.
  */
 public interface ChangeListener
 {

src/java/com/threerings/presents/dobj/CompoundEvent.java

@@ -28,16 +28,15 @@ import com.threerings.util.StreamableArrayList;
 import com.threerings.presents.net.Transport;
 
 /**
- * Used to manage and submit groups of events on a collection of
+ * Used to manage and submit groups of events on a collection of distributed objects in a single
- * distributed objects in a single transaction.
+ * transaction.
  *
  * @see DObject#startTransaction
  */
 public class CompoundEvent extends DEvent
 {
     /**
-     * Constructs a blank compound event in preparation for
+     * Constructs a blank compound event in preparation for unserialization.
-     * unserialization.
      */
     public CompoundEvent ()
     {
@@ -62,9 +61,8 @@ public class CompoundEvent extends DEvent
     }
 
     /**
-     * Posts an event to this transaction. The event will be delivered as
+     * Posts an event to this transaction. The event will be delivered as part of the entire
-     * part of the entire transaction if it is committed or discarded if
+     * transaction if it is committed or discarded if the transaction is cancelled.
-     * the transaction is cancelled.
      */
     public void postEvent (DEvent event)
     {
@@ -73,6 +71,7 @@ public class CompoundEvent extends DEvent
 
     /**
      * Returns the list of events contained within this compound event.
+     *
      * Don't mess with it.
      */
     public List<DEvent> getEvents ()
@@ -81,10 +80,9 @@ public class CompoundEvent extends DEvent
     }
 
     /**
-     * Commits this transaction by posting this event to the distributed
+     * Commits this transaction by posting this event to the distributed object event queue. All
-     * object event queue. All participating dobjects will have their
+     * participating dobjects will have their transaction references cleared and will go back to
-     * transaction references cleared and will go back to normal
+     * normal operation.
-     * operation.
      */
     public void commit ()
     {
@@ -111,8 +109,7 @@ public class CompoundEvent extends DEvent
     }
 
     /**
-     * Cancels this transaction. All events posted to this transaction
+     * Cancels this transaction. All events posted to this transaction will be discarded.
-     * will be discarded.
      */
     public void cancel ()
     {
@@ -184,8 +181,7 @@ public class CompoundEvent extends DEvent
         }
     }
 
-    /** The object manager that we'll post ourselves to when we're
+    /** The object manager that we'll post ourselves to when we're committed. */
-     * committed. */
     protected transient DObjectManager _omgr;
 
     /** The object for which we're managing a transaction. */

src/java/com/threerings/util/StreamableHashSet.java

@@ -56,8 +56,7 @@ public class StreamableHashSet<E> extends HashSet<E>
     }
 
     /**
-     * Constructs an empty hash set with the default number of hash
+     * Constructs an empty hash set with the default number of hash buckets.
-     * buckets.
      */
     public StreamableHashSet ()
     {