Javadoc fixes and cleanups.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@623 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2001-11-18 04:27:56 +00:00
parent 0eb01dae9f
commit cc21ad8679
8 changed files with 38 additions and 37 deletions
@@ -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; package com.threerings.crowd.server;
@@ -39,6 +39,21 @@ import com.threerings.crowd.data.*;
public class PlaceManager public class PlaceManager
implements MessageListener, OidListListener, ObjectDeathListener 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. * Returns a reference to our place configuration object.
*/ */
@@ -336,21 +351,6 @@ public class PlaceManager
buf.append(", config=").append(_config); 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. */ /** A reference to the place object that we manage. */
protected PlaceObject _plobj; protected PlaceObject _plobj;
@@ -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; 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 * Constructs a uniform tileset rule set that will match tilesets with
* the specified prefix. See the documentation for {@link * 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) public SwissArmyTileSetRuleSet (String prefix)
{ {
@@ -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; 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 * When a <tileset> element is encountered, this method is
* called to create a new instance of {@link TileSet}. Though the * called to create a new instance of {@link TileSet}. Though the
* attributes are supplied (in case an attribute is needed to * attributes are supplied (in case an attribute is needed to
* determine which derived instance of {@link TileSet} to create, this * determine which derived instance of {@link TileSet} to create),
* method should not configure the created tileset object. It should * this method should not configure the created tileset object. It
* instead rely on the set properties rule that will be executed after * should instead rely on the set properties rule that will be
* this object is created or to custom set property rules registered * executed after this object is created or to custom set property
* in {@link #addDigesterRules}. * rules registered in {@link #addRuleInstances}.
*/ */
protected abstract TileSet createTileSet (Attributes attributes); protected abstract TileSet createTileSet (Attributes attributes);
@@ -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; 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 * Constructs a uniform tileset rule set that will match tilesets with
* the specified prefix. See the documentation for {@link * 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) public UniformTileSetRuleSet (String prefix)
{ {
@@ -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; 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 * compiler should inline, and prevents the caller from having to do the
* indexing multiplication by hand every time. * indexing multiplication by hand every time.
* *
* <p> This is equivalent to {@link TileLayer} except that it contains * <p> This is equivalent to {@link com.threerings.media.tile.TileLayer}
* {@link MisoTile} instances. For efficiency's sake, we don't extend * except that it contains {@link MisoTile} instances. For efficiency's
* that class but instead provide a direct implementation. * sake, we don't extend that class but instead provide a direct
* implementation.
*/ */
public final class MisoTileLayer public final class MisoTileLayer
{ {
@@ -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; 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 * Constructs a uniform tileset rule set that will match tilesets with
* the specified prefix. See the documentation for {@link * 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) public MisoTileSetRuleSet (String prefix)
{ {
@@ -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; package com.threerings.media.tile.xml;
@@ -13,7 +13,7 @@ import com.threerings.miso.scene.MisoSceneModel;
/** /**
* Used to parse a {@link MisoSceneModel} from XML. * 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 * Constructs a miso scene rule set which will match scenes with the
@@ -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; package com.threerings.presents.dobj;
@@ -67,8 +67,8 @@ public abstract class DEvent
* Events with associated listener interfaces should implement this * Events with associated listener interfaces should implement this
* function and notify the supplied listener if it implements their * function and notify the supplied listener if it implements their
* event listening interface. For example, the {@link * event listening interface. For example, the {@link
* AttributeChangedEvent} will notify listeners that implement * AttributeChangedEvent} will notify listeners that implement {@link
* {@AttributeChangeListener}. * AttributeChangeListener}.
*/ */
protected void notifyListener (Object listener) protected void notifyListener (Object listener)
{ {