From a4fbeed81ef90a28022e1ae3ccb8a98baf99ab4d Mon Sep 17 00:00:00 2001
From: chme <chrstian.meffert@googlemail.com>
Date: Thu, 29 May 2014 09:45:04 +0200
Subject: [PATCH] Added comments to queue_clear and queue_empty

---
 src/player.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/player.c b/src/player.c
index fed17f0e..e2e3f7be 100644
--- a/src/player.c
+++ b/src/player.c
@@ -3565,6 +3565,9 @@ queue_remove(struct player_command *cmd)
   return 0;
 }
 
+/*
+ * queue_clear removes all items from the playqueue, playback must be stopped before calling queue_clear
+ */
 static int
 queue_clear(struct player_command *cmd)
 {
@@ -3588,6 +3591,11 @@ queue_clear(struct player_command *cmd)
   return 0;
 }
 
+/*
+ * Depending on cmd->arg.intval queue_empty removes all items from the history (arg.intval = 1),
+ * or removes all upcoming songs from the playqueue (arg.intval != 1). After calling queue_empty
+ * to remove the upcoming songs, the playqueue will only contain the current playing song.
+ */
 static int
 queue_empty(struct player_command *cmd)
 {