norohind/vanilla
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Better document getSong

Browse Source
This commit is contained in:
Christopher Eby 2010-05-11 22:48:17 -05:00
parent 8d13993613
commit 9bc750b564
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/org/kreed/vanilla/SongTimeline.java
View File

@ -258,7 +258,15 @@ public final class SongTimeline {
/** /**
* Returns the song <code>delta</code> places away from the current * 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) public Song getSong(int delta)
{ {