Javadoc fixes.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@1437 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2002-06-11 00:52:37 +00:00
parent 916513f306
commit c1ccaac10d
4 changed files with 11 additions and 12 deletions
@@ -1,5 +1,5 @@
// //
// $Id: FrameManager.java,v 1.9 2002/05/22 01:48:08 shaper Exp $ // $Id: FrameManager.java,v 1.10 2002/06/11 00:52:37 mdb Exp $
package com.threerings.media; package com.threerings.media;
@@ -59,11 +59,10 @@ import com.threerings.media.util.PerformanceObserver;
* buffer (if supported, an off-screen buffer if not). Updates that were * buffer (if supported, an off-screen buffer if not). Updates that were
* computed during the tick should be rendered in this call to paint. The * computed during the tick should be rendered in this call to paint. The
* paint call will propagate down to all components in the UI hierarchy, * paint call will propagate down to all components in the UI hierarchy,
* some of which may be {@link FrameParticipants} and will have prepared * some of which may be {@link FrameParticipant}s and will have prepared
* themselves for their upcoming painting in the previous call to {@link * themselves for their upcoming painting in the previous call to {@link
* FrameParticipant#tick}. When the call to paint completes, the flip * FrameParticipant#tick}. When the call to paint completes, the flip
* buffer is flipped and the process starts all over again. * buffer is flipped and the process starts all over again. </ul>
* </ul>
* *
* <p> The ticking and rendering takes place on the AWT thread so as to * <p> The ticking and rendering takes place on the AWT thread so as to
* avoid the need for complicated coordination between AWT event handler * avoid the need for complicated coordination between AWT event handler
@@ -230,8 +229,8 @@ public class FrameManager
} }
/** /**
* Called once per frame to invoke {@link FrameParticipant#paint} on * Called once per frame to invoke {@link Component#paint} on all of
* all of our frame participants. * our frame participants' components.
*/ */
protected void paintParticipants (long tickStamp) protected void paintParticipants (long tickStamp)
{ {
@@ -1,5 +1,5 @@
// //
// $Id: ManagedJFrame.java,v 1.2 2002/04/28 02:50:32 mdb Exp $ // $Id: ManagedJFrame.java,v 1.3 2002/06/11 00:52:37 mdb Exp $
package com.threerings.media; package com.threerings.media;
@@ -14,7 +14,7 @@ import com.threerings.media.Log;
/** /**
* When using the {@link FrameManager}, one must use this top-level frame * When using the {@link FrameManager}, one must use this top-level frame
* class (or the {@link ManagedFrame} class if one is not using Swing. * class.
*/ */
public class ManagedJFrame extends JFrame public class ManagedJFrame extends JFrame
{ {
@@ -1,5 +1,5 @@
// //
// $Id: MediaPanel.java,v 1.10 2002/06/11 00:05:31 mdb Exp $ // $Id: MediaPanel.java,v 1.11 2002/06/11 00:52:37 mdb Exp $
package com.threerings.media; package com.threerings.media;
@@ -628,7 +628,7 @@ public class MediaPanel extends JComponent
* (the actual dimensions of the animated panel) can override this * (the actual dimensions of the animated panel) can override this
* method and return the desired size of the view. The animated panel * method and return the desired size of the view. The animated panel
* will take this size into account and translate into the view * will take this size into account and translate into the view
* coordinate system before calling {@link #render}. * coordinate system before calling the paint methods.
*/ */
protected Dimension getViewSize () protected Dimension getViewSize ()
{ {
@@ -1,5 +1,5 @@
// //
// $Id: RegionManager.java,v 1.1 2002/04/23 01:16:27 mdb Exp $ // $Id: RegionManager.java,v 1.2 2002/06/11 00:52:37 mdb Exp $
package com.threerings.media; package com.threerings.media;
@@ -46,7 +46,7 @@ public class RegionManager
/** /**
* Returns true if dirty regions have been accumulated since the last * Returns true if dirty regions have been accumulated since the last
* call to {@link #getDirtyRects}. * call to {@link #getDirtyRegions}.
*/ */
public boolean haveDirtyRegions () public boolean haveDirtyRegions ()
{ {