More documentation updates.

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

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

@@ -1,5 +1,5 @@
 //
-// $Id: NamedEvent.java,v 1.2 2004/08/27 02:20:20 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -29,10 +29,10 @@ public abstract class NamedEvent extends DEvent
 {
     /**
      * Constructs a new named event for the specified target object with
-     * the supplied lock name.
+     * the supplied attribute name.
      *
      * @param targetOid the object id of the object in question.
-     * @param name the name of the lock to release.
+     * @param name the name associated with this event.
      */
     public NamedEvent (int targetOid, String name)
     {
@@ -49,7 +49,7 @@ public abstract class NamedEvent extends DEvent
     }
 
     /**
-     * Returns the name of the lock to release.
+     * Returns the name of the attribute to which this event pertains.
      */
     public String getName ()
     {

src/java/com/threerings/presents/package.html

@@ -507,8 +507,8 @@
     entries in the set (and look them up via an efficient binary search).
 
     <p> When using a <code>DSet</code> one is provided with three new
-    operations: <code>addEntry()</code>, <code>updateEntry()</code> and
+    operations: <code>addToFoo()</code>, <code>updateFoo()</code> and
-    <code>removeEntry()</code>. Once again an example is in order:
+    <code>removeFromFoo()</code>. Once again an example is in order:
 
     <pre class="example">
     public class Monkey implements DSet.Entry
@@ -539,8 +539,7 @@
         // AUTO-GENERATED: METHODS START
         /**
          * Requests that the specified entry be added to the
-         * <code>monkeys</code> set. The set will not change until the event is
+         * <code>monkeys</code> set.
-         * actually propagated through the system.
          */
         public void addToMonkeys (DSet.Entry elem)
         {
@@ -549,8 +548,7 @@
 
         /**
          * Requests that the entry matching the supplied key be removed from
-         * the <code>monkeys</code> set. The set will not change until the
+         * the <code>monkeys</code> set.
-         * event is actually propagated through the system.
          */
         public void removeFromMonkeys (Comparable key)
         {
@@ -559,8 +557,7 @@
 
         /**
          * Requests that the specified entry be updated in the
-         * <code>monkeys</code> set. The set will not change until the event is
+         * <code>monkeys</code> set.
-         * actually propagated through the system.
          */
         public void updateMonkeys (DSet.Entry elem)
         {
@@ -569,13 +566,7 @@
 
         /**
          * Requests that the <code>monkeys</code> field be set to the
-         * specified value. Generally one only adds, updates and removes
+         * specified value.
-         * entries of a distributed set, but certain situations call for a
-         * complete replacement of the set value. The local value will be
-         * updated immediately and an event will be propagated through the
-         * system to notify all listeners that the attribute did
-         * change. Proxied copies of this object (on clients) will apply the
-         * value change when they received the attribute changed notification.
          */
         public void setMonkeys (DSet value)
         {
@@ -590,6 +581,12 @@
     but more commonly one will simply add entries to the set, update those
     entries and remove them using the provided methods.
 
+    <p> In conjunction with the <code>DSet</code> there exists the {@link
+    com.threerings.presents.dobj.SetListener} which is notified when
+    changes are made to a distributed set. This functions in the same was
+    as the previously documented listeners, so I will refrain from boring
+    you with yet more sample code.
+
     <h3><a name="invocation_services">Invocation Services</a></h3>
 
     TBD