From cc21ad8679932938b26ad66ab627f536bd89aee5 Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Sun, 18 Nov 2001 04:27:56 +0000 Subject: [PATCH] Javadoc fixes and cleanups. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@623 542714f4-19e9-0310-aa3c-eee0fc999fb1 --- .../threerings/crowd/server/PlaceManager.java | 32 +++++++++---------- .../tools/xml/SwissArmyTileSetRuleSet.java | 4 +-- .../media/tile/tools/xml/TileSetRuleSet.java | 12 +++---- .../tile/tools/xml/UniformTileSetRuleSet.java | 4 +-- .../threerings/miso/tile/BaseTileLayer.java | 9 +++--- .../tile/tools/xml/BaseTileSetRuleSet.java | 4 +-- .../miso/tools/xml/MisoSceneRuleSet.java | 4 +-- .../com/threerings/presents/dobj/DEvent.java | 6 ++-- 8 files changed, 38 insertions(+), 37 deletions(-) diff --git a/src/java/com/threerings/crowd/server/PlaceManager.java b/src/java/com/threerings/crowd/server/PlaceManager.java index d42dac123..0558046dc 100644 --- a/src/java/com/threerings/crowd/server/PlaceManager.java +++ b/src/java/com/threerings/crowd/server/PlaceManager.java @@ -1,5 +1,5 @@ // -// $Id: PlaceManager.java,v 1.23 2001/10/26 01:40:22 mdb Exp $ +// $Id: PlaceManager.java,v 1.24 2001/11/18 04:27:56 mdb Exp $ package com.threerings.crowd.server; @@ -39,6 +39,21 @@ import com.threerings.crowd.data.*; public class PlaceManager implements MessageListener, OidListListener, ObjectDeathListener { + /** + * An interface used to allow the registration of standard message + * handlers to be invoked by the place manager when particular types + * of message events are received. + */ + public static interface MessageHandler + { + /** + * Invokes this message handler on the supplied event. + * + * @param event the message event received. + */ + public void handleEvent (MessageEvent event); + } + /** * Returns a reference to our place configuration object. */ @@ -336,21 +351,6 @@ public class PlaceManager buf.append(", config=").append(_config); } - /** - * An interface used to allow the registration of standard message - * handlers to be invoked by the place manager when particular types - * of message events are received. - */ - protected static interface MessageHandler - { - /** - * Invokes this message handler on the supplied event. - * - * @param event the message event received. - */ - public void handleEvent (MessageEvent event); - } - /** A reference to the place object that we manage. */ protected PlaceObject _plobj; diff --git a/src/java/com/threerings/media/tile/tools/xml/SwissArmyTileSetRuleSet.java b/src/java/com/threerings/media/tile/tools/xml/SwissArmyTileSetRuleSet.java index 906c36144..f8b86dd4d 100644 --- a/src/java/com/threerings/media/tile/tools/xml/SwissArmyTileSetRuleSet.java +++ b/src/java/com/threerings/media/tile/tools/xml/SwissArmyTileSetRuleSet.java @@ -1,5 +1,5 @@ // -// $Id: SwissArmyTileSetRuleSet.java,v 1.1 2001/11/18 04:09:22 mdb Exp $ +// $Id: SwissArmyTileSetRuleSet.java,v 1.2 2001/11/18 04:27:56 mdb Exp $ package com.threerings.media.tile.xml; @@ -39,7 +39,7 @@ public class SwissArmyTileSetRuleSet extends TileSetRuleSet /** * Constructs a uniform tileset rule set that will match tilesets with * the specified prefix. See the documentation for {@link - * TileSetRuleSet#TileSetruleSet} for more info on matching. + * TileSetRuleSet#TileSetRuleSet} for more info on matching. */ public SwissArmyTileSetRuleSet (String prefix) { diff --git a/src/java/com/threerings/media/tile/tools/xml/TileSetRuleSet.java b/src/java/com/threerings/media/tile/tools/xml/TileSetRuleSet.java index 7ca1b8662..2f67142d8 100644 --- a/src/java/com/threerings/media/tile/tools/xml/TileSetRuleSet.java +++ b/src/java/com/threerings/media/tile/tools/xml/TileSetRuleSet.java @@ -1,5 +1,5 @@ // -// $Id: TileSetRuleSet.java,v 1.1 2001/11/18 04:09:22 mdb Exp $ +// $Id: TileSetRuleSet.java,v 1.2 2001/11/18 04:27:56 mdb Exp $ package com.threerings.media.tile.xml; @@ -74,11 +74,11 @@ public abstract class TileSetRuleSet extends RuleSetBase * When a <tileset> element is encountered, this method is * called to create a new instance of {@link TileSet}. Though the * attributes are supplied (in case an attribute is needed to - * determine which derived instance of {@link TileSet} to create, this - * method should not configure the created tileset object. It should - * instead rely on the set properties rule that will be executed after - * this object is created or to custom set property rules registered - * in {@link #addDigesterRules}. + * determine which derived instance of {@link TileSet} to create), + * this method should not configure the created tileset object. It + * should instead rely on the set properties rule that will be + * executed after this object is created or to custom set property + * rules registered in {@link #addRuleInstances}. */ protected abstract TileSet createTileSet (Attributes attributes); diff --git a/src/java/com/threerings/media/tile/tools/xml/UniformTileSetRuleSet.java b/src/java/com/threerings/media/tile/tools/xml/UniformTileSetRuleSet.java index 803804a16..cdff953e6 100644 --- a/src/java/com/threerings/media/tile/tools/xml/UniformTileSetRuleSet.java +++ b/src/java/com/threerings/media/tile/tools/xml/UniformTileSetRuleSet.java @@ -1,5 +1,5 @@ // -// $Id: UniformTileSetRuleSet.java,v 1.1 2001/11/18 04:09:22 mdb Exp $ +// $Id: UniformTileSetRuleSet.java,v 1.2 2001/11/18 04:27:56 mdb Exp $ package com.threerings.media.tile.xml; @@ -30,7 +30,7 @@ public class UniformTileSetRuleSet extends TileSetRuleSet /** * Constructs a uniform tileset rule set that will match tilesets with * the specified prefix. See the documentation for {@link - * TileSetRuleSet#TileSetruleSet} for more info on matching. + * TileSetRuleSet#TileSetRuleSet} for more info on matching. */ public UniformTileSetRuleSet (String prefix) { diff --git a/src/java/com/threerings/miso/tile/BaseTileLayer.java b/src/java/com/threerings/miso/tile/BaseTileLayer.java index c2913ab8c..0def1bcaa 100644 --- a/src/java/com/threerings/miso/tile/BaseTileLayer.java +++ b/src/java/com/threerings/miso/tile/BaseTileLayer.java @@ -1,5 +1,5 @@ // -// $Id: BaseTileLayer.java,v 1.1 2001/11/18 04:09:22 mdb Exp $ +// $Id: BaseTileLayer.java,v 1.2 2001/11/18 04:27:56 mdb Exp $ package com.threerings.miso.tile; @@ -10,9 +10,10 @@ package com.threerings.miso.tile; * compiler should inline, and prevents the caller from having to do the * indexing multiplication by hand every time. * - *

This is equivalent to {@link TileLayer} except that it contains - * {@link MisoTile} instances. For efficiency's sake, we don't extend - * that class but instead provide a direct implementation. + *

This is equivalent to {@link com.threerings.media.tile.TileLayer} + * except that it contains {@link MisoTile} instances. For efficiency's + * sake, we don't extend that class but instead provide a direct + * implementation. */ public final class MisoTileLayer { diff --git a/src/java/com/threerings/miso/tile/tools/xml/BaseTileSetRuleSet.java b/src/java/com/threerings/miso/tile/tools/xml/BaseTileSetRuleSet.java index b9acaae11..4fdee64b4 100644 --- a/src/java/com/threerings/miso/tile/tools/xml/BaseTileSetRuleSet.java +++ b/src/java/com/threerings/miso/tile/tools/xml/BaseTileSetRuleSet.java @@ -1,5 +1,5 @@ // -// $Id: BaseTileSetRuleSet.java,v 1.1 2001/11/18 04:09:23 mdb Exp $ +// $Id: BaseTileSetRuleSet.java,v 1.2 2001/11/18 04:27:56 mdb Exp $ package com.threerings.media.tile.xml; @@ -31,7 +31,7 @@ public class MisoTileSetRuleSet extends SwissArmyTileSetRuleSet /** * Constructs a uniform tileset rule set that will match tilesets with * the specified prefix. See the documentation for {@link - * TileSetRuleSet#TileSetruleSet} for more info on matching. + * TileSetRuleSet#TileSetRuleSet} for more info on matching. */ public MisoTileSetRuleSet (String prefix) { diff --git a/src/java/com/threerings/miso/tools/xml/MisoSceneRuleSet.java b/src/java/com/threerings/miso/tools/xml/MisoSceneRuleSet.java index dc4df12ed..ef4108dd6 100644 --- a/src/java/com/threerings/miso/tools/xml/MisoSceneRuleSet.java +++ b/src/java/com/threerings/miso/tools/xml/MisoSceneRuleSet.java @@ -1,5 +1,5 @@ // -// $Id: MisoSceneRuleSet.java,v 1.1 2001/11/18 04:09:22 mdb Exp $ +// $Id: MisoSceneRuleSet.java,v 1.2 2001/11/18 04:27:56 mdb Exp $ package com.threerings.media.tile.xml; @@ -13,7 +13,7 @@ import com.threerings.miso.scene.MisoSceneModel; /** * Used to parse a {@link MisoSceneModel} from XML. */ -public abstract class MisoSceneRuleSet extends RuleSetBase +public class MisoSceneRuleSet extends RuleSetBase { /** * Constructs a miso scene rule set which will match scenes with the diff --git a/src/java/com/threerings/presents/dobj/DEvent.java b/src/java/com/threerings/presents/dobj/DEvent.java index c97dae21f..a77e32ce7 100644 --- a/src/java/com/threerings/presents/dobj/DEvent.java +++ b/src/java/com/threerings/presents/dobj/DEvent.java @@ -1,5 +1,5 @@ // -// $Id: DEvent.java,v 1.7 2001/10/12 00:03:03 mdb Exp $ +// $Id: DEvent.java,v 1.8 2001/11/18 04:27:56 mdb Exp $ package com.threerings.presents.dobj; @@ -67,8 +67,8 @@ public abstract class DEvent * Events with associated listener interfaces should implement this * function and notify the supplied listener if it implements their * event listening interface. For example, the {@link - * AttributeChangedEvent} will notify listeners that implement - * {@AttributeChangeListener}. + * AttributeChangedEvent} will notify listeners that implement {@link + * AttributeChangeListener}. */ protected void notifyListener (Object listener) {