queue/Playlist: document that current/queued are "order number"

This commit is contained in:
Max Kellermann 2016-03-18 17:35:29 +01:00
parent 7e096ee2c5
commit 7b70153068

View File

@ -73,16 +73,17 @@ struct playlist {
unsigned error_count; unsigned error_count;
/** /**
* The "current song pointer". This is the song which is * The "current song pointer" (the order number). This is the
* played when we get the "play" command. It is also the song * song which is played when we get the "play" command. It is
* which is currently being played. * also the song which is currently being played.
*/ */
int current; int current;
/** /**
* The "next" song to be played, when the current one * The "next" song to be played (the order number), when the
* finishes. The decoder thread may start decoding and * current one finishes. The decoder thread may start
* buffering it, while the "current" song is still playing. * decoding and buffering it, while the "current" song is
* still playing.
* *
* This variable is only valid if #playing is true. * This variable is only valid if #playing is true.
*/ */