From 6ce13646da5ef5d78c438f22d7546ef2b30e02bd Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Tue, 27 Oct 2015 21:12:20 +0100
Subject: player/Thread: more CrossFadeState documentation

---
 src/player/Thread.cxx | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/player/Thread.cxx b/src/player/Thread.cxx
index 9876ee470..8261923c8 100644
--- a/src/player/Thread.cxx
+++ b/src/player/Thread.cxx
@@ -90,11 +90,26 @@ class Player {
 	DetachedSong *song;
 
 	/**
-	 * is cross fading enabled?
+	 * Is cross-fading to the next song enabled?
 	 */
 	enum class CrossFadeState : uint8_t {
+		/**
+		 * The initial state: we don't know yet if we will
+		 * cross-fade; it will be determined soon.
+		 */
 		UNKNOWN,
+
+		/**
+		 * Cross-fading is disabled for the transition to the
+		 * next song.
+		 */
 		DISABLED,
+
+		/**
+		 * Cross-fading is enabled (but may not yet be in
+		 * progress), will start near the end of the current
+		 * song.
+		 */
 		ENABLED,
 	} xfade_state;
 
-- 
cgit v1.2.3