AfflictionNetworks/narya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Big fat Bernie javadoc cleanup.

Browse Source 
git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3310 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2005-01-24 23:08:21 +00:00
parent dd04679568
commit afabea71ad
65 changed files with 158 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/java/com/threerings/media/FrameManager.java
+2 -1
View File
@@ -1,5 +1,5 @@
//
// $Id: FrameManager.java,v 1.55 2004/10/28 17:21:56 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -25,6 +25,7 @@ import java.applet.Applet;
import java.awt.Component;
import java.awt.Graphics2D;
import java.awt.GraphicsDevice;
import java.awt.KeyEventDispatcher;
import java.awt.KeyboardFocusManager;
import java.awt.Rectangle;
src/java/com/threerings/media/VirtualMediaPanel.java
+1 -1
View File
@@ -282,7 +282,7 @@ public class VirtualMediaPanel extends MediaPanel
/**
* Called during our tick when we have adjusted the view location. The
* {@link _vbounds} will already have been updated to reflect our new
* {@link #_vbounds} will already have been updated to reflect our new
* view coordinates.
*
* @param dx the delta scrolled in the x direction (in pixels).
src/java/com/threerings/media/animation/AnimationFrameSequencer.java
+2 -2
View File
@@ -1,5 +1,5 @@
//
// $Id: AnimationFrameSequencer.java,v 1.8 2004/08/27 02:12:38 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -233,7 +233,7 @@ public interface AnimationFrameSequencer extends FrameSequencer
/** The animation that we're sequencing for. */
protected Animation _animation;
/** Used to dispatch {@link AnimationObserver#frameReached}. */
/** Used to dispatch {@link SequencedAnimationObserver#frameReached}. */
protected static class FrameReachedOp implements ObserverList.ObserverOp
{
public FrameReachedOp (Animation anim, long when,
src/java/com/threerings/media/image/ImageManager.java
+8 -9
View File
@@ -1,5 +1,5 @@
//
// $Id: ImageManager.java,v 1.60 2004/08/27 02:12:38 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -189,7 +189,7 @@ public class ImageManager
* using the supplied path to identify the image.
*
* <p> Additionally the image is optimized for display in the current
* graphics configuration. Consider using {@link getMirage(String)}
* graphics configuration. Consider using {@link #getMirage(ImageKey)}
* instead of prepared images as they (some day) will automatically
* use volatile images to increase performance.
*/
@@ -203,10 +203,9 @@ public class ImageManager
* obtaining the image from the supplied resource set.
*
* <p> Additionally the image is optimized for display in the current
* graphics configuration. Consider using {@link
* getMirage(String,String)} instead of prepared images as they (some
* day) will automatically use volatile images to increase
* performance.
* graphics configuration. Consider using {@link #getMirage(ImageKey)}
* instead of prepared images as they (some day) will automatically
* use volatile images to increase performance.
*/
public BufferedImage getPreparedImage (String rset, String path)
{
@@ -220,9 +219,9 @@ public class ImageManager
*
* <p> Additionally the image is optimized for display in the current
* graphics configuration. Consider using {@link
* getMirage(String,String,Colorizationp[]} instead of prepared images
* as they (some day) will automatically use volatile images to
* increase performance.
* #getMirage(ImageKey,Colorization[])} instead of prepared images as
* they (some day) will automatically use volatile images to increase
* performance.
*/
public BufferedImage getPreparedImage (String rset, String path,
Colorization[] zations)
src/java/com/threerings/media/sound/MusicManager.java
+1 -1
View File
@@ -75,7 +75,7 @@ public class MusicManager
/**
* Sets the volume for music.
*
* @param val a volume parameter between 0f and 1f, inclusive.
* @param vol a volume parameter between 0f and 1f, inclusive.
*/
public void setMusicVolume (float vol)
{
src/java/com/threerings/media/sound/SoundManager.java
+1 -1
View File
@@ -167,7 +167,7 @@ public class SoundManager
/**
* Sets the volume for all sound clips.
*
* @param val a volume parameter between 0f and 1f, inclusive.
* @param vol a volume parameter between 0f and 1f, inclusive.
*/
public void setClipVolume (float vol)
{
src/java/com/threerings/media/sprite/SpriteIcon.java
+3 -5
View File
@@ -1,5 +1,5 @@
//
// $Id: SpriteIcon.java,v 1.6 2004/08/27 02:12:41 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -38,8 +38,7 @@ public class SpriteIcon implements Icon
* itself. This sprite should not be used for anything else while
* being used in this icon because it will be "moved" when the icon is
* rendered. The sprite's origin will be set to the bottom center of
* the label. If this is undesirable, the origin can be offset via
* {@link #setOriginOffset}.
* the label.
*/
public SpriteIcon (Sprite sprite)
{
@@ -51,8 +50,7 @@ public class SpriteIcon implements Icon
* itself. This sprite should not be used for anything else while
* being used in this icon because it will be "moved" when the icon is
* rendered. The sprite's origin will be set to the bottom center of
* the label. If this is undesirable, the origin can be offset via
* {@link #setOriginOffset}.
* the label.
*
* @param sprite the sprite to render in this label.
* @param padding the number of pixels of blank space to put on all
src/java/com/threerings/media/tile/TileSet.java
+2 -2
View File
@@ -1,5 +1,5 @@
//
// $Id: TileSet.java,v 1.62 2004/10/28 17:49:02 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -152,7 +152,7 @@ public abstract class TileSet
}
/**
* Equivalent to {@link# getTile(int,Colorizer)} with a null
* Equivalent to {@link #getTile(int,Colorizer)} with a null
* <code>Colorizer</code> argument.
*/
public Tile getTile (int tileIndex)
src/java/com/threerings/media/tile/bundle/tools/TileSetBundler.java
+4 -4
View File
@@ -1,5 +1,5 @@
//
// $Id: TileSetBundler.java,v 1.21 2004/08/27 02:12:43 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -197,7 +197,7 @@ public class TileSetBundler
*
* @param idBroker the tileset id broker that will be used to map
* tileset names to tileset ids.
* @param bundleDef a file object pointing to the bundle description
* @param bundleDesc a file object pointing to the bundle description
* file.
* @param targetPath the path of the tileset bundle file that will be
* created.
@@ -332,8 +332,8 @@ public class TileSetBundler
* Finish the creation of a tileset bundle jar file.
*
* @param target the tileset bundle file that will be created.
* @param TileSetBundle contains the tilesets we'd like to save out to
* the bundle.
* @param bundle contains the tilesets we'd like to save out to the
* bundle.
* @param improv the image provider.
* @param imageBase the base directory for getting images for non
* ObjectTileSet tilesets.
src/java/com/threerings/media/tile/tools/xml/TileSetRuleSet.java
+2 -1
View File
@@ -1,5 +1,5 @@
//
// $Id: TileSetRuleSet.java,v 1.8 2004/08/27 02:12:44 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -26,6 +26,7 @@ import org.apache.commons.digester.RuleSetBase;
import com.samskivert.util.StringUtil;
import com.samskivert.xml.ValidatedSetNextRule.Validator;
import com.samskivert.xml.ValidatedSetNextRule;
import com.threerings.media.Log;
import com.threerings.media.tile.TileSet;
src/java/com/threerings/media/util/LineSegmentPath.java
+3 -7
View File
@@ -1,5 +1,5 @@
//
// $Id: LineSegmentPath.java,v 1.30 2004/08/27 02:12:47 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -80,12 +80,8 @@ public class LineSegmentPath
}
/**
* Constructs a line segment path with the specified list of
* points. An arbitrary direction will be assigned to the
* starting node.
*
* @param x the starting node x-position.
* @param y the starting node y-position.
* Constructs a line segment path with the specified list of points.
* An arbitrary direction will be assigned to the starting node.
*/
public LineSegmentPath (List points)
{
src/java/com/threerings/media/util/Pathable.java
+3 -1
View File
@@ -1,5 +1,5 @@
//
// $Id: Pathable.java,v 1.7 2004/08/27 02:12:47 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -23,6 +23,8 @@ package com.threerings.media.util;
import java.awt.Rectangle;
import com.threerings.util.DirectionCodes;
/**
* Used in conjunction with a {@link Path}.
*/