From 9bc750b564d68650b95d1059eef91214ff34cb71 Mon Sep 17 00:00:00 2001
From: Christopher Eby <kreed@kreed.org>
Date: Tue, 11 May 2010 22:48:17 -0500
Subject: [PATCH] Better document getSong

---
 src/org/kreed/vanilla/SongTimeline.java | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/org/kreed/vanilla/SongTimeline.java b/src/org/kreed/vanilla/SongTimeline.java
index 171c26d3..485990d4 100644
--- a/src/org/kreed/vanilla/SongTimeline.java
+++ b/src/org/kreed/vanilla/SongTimeline.java
@@ -258,7 +258,15 @@ public final class SongTimeline {
 
 	/**
 	 * Returns the song <code>delta</code> places away from the current
-	 * position.
+	 * position. If there is no song at the given position, a random
+	 * song will be placed in that position.
+	 *
+	 * Note: This returns songs based on their position in the playback
+	 * sequence, not necessarily the stored timeline. When repeat is enabled,
+	 * the two will differ.
+	 *
+	 * @param delta The offset from the current position. Should be -1, 0, or
+	 * 1.
 	 */
 	public Song getSong(int delta)
 	{