From e9ab6f4635ca61967888022106d32befcb012c7e Mon Sep 17 00:00:00 2001
From: Ray Greenwell <ray@threerings.net>
Date: Wed, 11 Jun 2008 22:50:27 +0000
Subject: [PATCH] Added a bit of documentation about what makes OidLists
 special; I myself couldn't even remember and had to trace through code.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5179 542714f4-19e9-0310-aa3c-eee0fc999fb1
---
 src/java/com/threerings/presents/dobj/OidList.java | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/java/com/threerings/presents/dobj/OidList.java b/src/java/com/threerings/presents/dobj/OidList.java
index 9482e0f30..84d0cfd64 100644
--- a/src/java/com/threerings/presents/dobj/OidList.java
+++ b/src/java/com/threerings/presents/dobj/OidList.java
@@ -28,6 +28,12 @@ import com.threerings.io.Streamable;
  * allow duplicate ids. This class is not synchronized, with the
  * expectation that all modifications of instances will take place on the
  * dobjmgr thread.
+ *
+ * <ul>
+ * <li> Do not use an OidList to store a set of ints. OidList has special meaning inside
+ * of the dobj system, namely:
+ * <li> When an object is destroyed, its oid is automagically removed from any OidLists.
+ * </ul>
  */
 public class OidList implements Streamable
 {