From 21210eae62890a4eee60bd90c3918d4eb7de9af0 Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Sun, 4 May 2003 18:50:23 +0000 Subject: [PATCH] Documentation clarification. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@2541 542714f4-19e9-0310-aa3c-eee0fc999fb1 --- src/java/com/threerings/media/sprite/PathObserver.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/java/com/threerings/media/sprite/PathObserver.java b/src/java/com/threerings/media/sprite/PathObserver.java index 22f1f0fc8..54981d95e 100644 --- a/src/java/com/threerings/media/sprite/PathObserver.java +++ b/src/java/com/threerings/media/sprite/PathObserver.java @@ -1,5 +1,5 @@ // -// $Id: PathObserver.java,v 1.1 2003/04/30 00:44:36 mdb Exp $ +// $Id: PathObserver.java,v 1.2 2003/05/04 18:50:23 mdb Exp $ package com.threerings.media.sprite; @@ -20,6 +20,12 @@ public interface PathObserver /** * Called when a sprite completes its traversal of a path. + * + * @param sprite the sprite that completed its path. + * @param path the path that was completed. + * @param when the tick stamp of the media tick on which the path was + * completed (see {@link SpriteManager#tick}) (this may not be in the + * same time domain as {@link System#currentTimeMillis}). */ public void pathCompleted (Sprite sprite, Path path, long when); }