From b542ed3afc74f476936d9d5d2ba7e4131f4c1a57 Mon Sep 17 00:00:00 2001
From: Ray Greenwell <ray@threerings.net>
Date: Fri, 11 Jan 2008 19:16:12 +0000
Subject: [PATCH] Added @eventType tags to the event type constants. AsDoc is
 crappy: the @eventType tag has two different syntaxes, depending on whether
 you're using it to comment an [Event] declared by a class, or the type
 constant. Also: this is pointless, asdoc should be able to get this value
 using the other @eventType tag, but instead we have to be redundant, possibly
 making a mistake.

git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@547 c613c5cb-e716-0410-b11b-feb51c14d237
---
 .../threerings/ezgame/MessageReceivedEvent.as |  6 +++-
 .../threerings/ezgame/OccupantChangedEvent.as |  7 +++++
 .../threerings/ezgame/PropertyChangedEvent.as |  6 +++-
 .../com/threerings/ezgame/SizeChangedEvent.as |  6 +++-
 .../threerings/ezgame/StateChangedEvent.as    | 31 ++++++++++++++-----
 src/as/com/threerings/ezgame/UserChatEvent.as |  5 ++-
 6 files changed, 50 insertions(+), 11 deletions(-)

diff --git a/src/as/com/threerings/ezgame/MessageReceivedEvent.as b/src/as/com/threerings/ezgame/MessageReceivedEvent.as
index cebde320..a48fcd4e 100644
--- a/src/as/com/threerings/ezgame/MessageReceivedEvent.as
+++ b/src/as/com/threerings/ezgame/MessageReceivedEvent.as
@@ -28,7 +28,11 @@ import flash.events.Event;
  */
 public class MessageReceivedEvent extends EZEvent
 {
-    /** The type of all MessageReceivedEvents. */
+    /**
+     * The type of all MessageReceivedEvents.
+     *
+     * @eventType msgReceived
+     */
     public static const MESSAGE_RECEIVED :String = "msgReceived";
 
     /**
diff --git a/src/as/com/threerings/ezgame/OccupantChangedEvent.as b/src/as/com/threerings/ezgame/OccupantChangedEvent.as
index 77b7efdf..d01836e5 100644
--- a/src/as/com/threerings/ezgame/OccupantChangedEvent.as
+++ b/src/as/com/threerings/ezgame/OccupantChangedEvent.as
@@ -25,7 +25,14 @@ import flash.events.Event;
 
 public class OccupantChangedEvent extends EZEvent
 {
+    /**
+     * @eventType OccupantEntered
+     */
     public static const OCCUPANT_ENTERED :String = "OccupantEntered";
+
+    /**
+     * @eventType OccupantLeft
+     */
     public static const OCCUPANT_LEFT :String = "OccupantLeft";
 
     /** The occupantId of the occupant that entered or left. */
diff --git a/src/as/com/threerings/ezgame/PropertyChangedEvent.as b/src/as/com/threerings/ezgame/PropertyChangedEvent.as
index 6ea444a6..66f44028 100644
--- a/src/as/com/threerings/ezgame/PropertyChangedEvent.as
+++ b/src/as/com/threerings/ezgame/PropertyChangedEvent.as
@@ -29,7 +29,11 @@ import flash.events.Event;
  */
 public class PropertyChangedEvent extends EZEvent
 {
-    /** The type of a property change event. */
+    /**
+     * The type of a property change event.
+     *
+     * @eventType PropChanged
+     */
     public static const PROPERTY_CHANGED :String = "PropChanged";
 
     /**
diff --git a/src/as/com/threerings/ezgame/SizeChangedEvent.as b/src/as/com/threerings/ezgame/SizeChangedEvent.as
index 4b820025..0fef929e 100644
--- a/src/as/com/threerings/ezgame/SizeChangedEvent.as
+++ b/src/as/com/threerings/ezgame/SizeChangedEvent.as
@@ -31,7 +31,11 @@ import flash.geom.Point;
  */
 public class SizeChangedEvent extends EZEvent
 {
-    /** The type of this event. */
+    /**
+     * The type of this event.
+     *
+     * @eventType SizeChanged
+     */
     public static const SIZE_CHANGED :String = "SizeChanged";
 
     /**
diff --git a/src/as/com/threerings/ezgame/StateChangedEvent.as b/src/as/com/threerings/ezgame/StateChangedEvent.as
index 13054874..e78bd019 100644
--- a/src/as/com/threerings/ezgame/StateChangedEvent.as
+++ b/src/as/com/threerings/ezgame/StateChangedEvent.as
@@ -28,23 +28,40 @@ import flash.events.Event;
  */
 public class StateChangedEvent extends EZEvent
 {
-    /** Indicates that the game has transitioned to a started state. */
+    /**
+     * Indicates that the game has transitioned to a started state.
+     * @eventType GameStarted
+     */
     public static const GAME_STARTED :String = "GameStarted";
 
-    /** Indicates that the game has transitioned to a ended state. */
+    /**
+     * Indicates that the game has transitioned to a ended state.
+     * @eventType GameEnded
+     */
     public static const GAME_ENDED :String = "GameEnded";
 
-    /** Indicates that a round has started. Games that do not require multiple rounds can ignore
-     * this event. */
+    /**
+     * Indicates that a round has started. Games that do not require multiple rounds can ignore
+     * this event.
+     * @eventType RoundStarted
+     */
     public static const ROUND_STARTED :String = "RoundStarted";
 
-    /** Indicates that the current round has ended. */
+    /**
+     * Indicates that the current round has ended.
+     * @eventType RoundEnded
+     */
     public static const ROUND_ENDED :String = "RoundEnded";
 
-    /** Indicates that a new controller has been assigned. */
+    /**
+     * Indicates that a new controller has been assigned.
+     * @eventType ControlChanged
+     */
     public static const CONTROL_CHANGED :String = "ControlChanged";
 
-    /** Indicates that the turn has changed. */
+    /** Indicates that the turn has changed.
+     * @eventType TurnChanged
+     */
     // TODO: move to own event?
     public static const TURN_CHANGED :String = "TurnChanged";
 
diff --git a/src/as/com/threerings/ezgame/UserChatEvent.as b/src/as/com/threerings/ezgame/UserChatEvent.as
index 8b561abc..156b1f75 100644
--- a/src/as/com/threerings/ezgame/UserChatEvent.as
+++ b/src/as/com/threerings/ezgame/UserChatEvent.as
@@ -28,7 +28,10 @@ import flash.events.Event;
  */
 public class UserChatEvent extends EZEvent
 {
-    /** The type of a property change event. */
+    /**
+     * The type of a property change event.
+     * @eventType UserChat
+     */
     public static const USER_CHAT :String = "UserChat";
 
     /**