Obsolete playing_isscratch. The constant still exists as a transition

[disorder] / lib / queue.h

diff --git a/lib/queue.h b/lib/queue.h
index 6baf9162c6b265173938e6b4b1f363f12634c6e2..17a6d2270c0af3114364977a520e260915bbf9c0 100644 (file)
--- a/lib/queue.h
+++ b/lib/queue.h
@@ -31,9 +31,10 @@ enum playing_state {
   /** @brief Track failed to play */
   playing_failed,
 
-  /** @brief Track is a scratch and has not been played yet
+  /** @brief OBSOLETE
    *
-   * Going to become obsolete.
+   * Formerly denoted an unplayed scratch.  This is now indicated by @p
+   * playing_unplayed and @p origin_scratch.
    */
   playing_isscratch,
 
@@ -60,10 +61,11 @@ enum playing_state {
   /** @brief Track is playing but the server is quitting */
   playing_quitting,
 
-  /** @brief Track was randomly chosen and has not been played
+  /** @brief OBSOLETE
    *
-   * This is going to become obsolete eventually; it's equivalent to @ref
-   * playing_unplayed but for tracks with a different origin.
+   * Formerly this meant a track that was picked at random and has not yet been
+   * played.  This situation is now indicated by @p playing_unplayed and @p
+   * origin_random (or @p origin_adopted).
    */
   playing_random,