From 7b2e3331f23dc756a250c09f0c66cb17f6daa558 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Fri, 22 Oct 2021 19:53:47 +0200
Subject: [PATCH] output/Filtered: improve API docs

---
 src/output/Filtered.hxx | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/output/Filtered.hxx b/src/output/Filtered.hxx
index 4482fddb0..8219896a6 100644
--- a/src/output/Filtered.hxx
+++ b/src/output/Filtered.hxx
@@ -181,7 +181,8 @@ public:
 	void Disable() noexcept;
 
 	/**
-	 * Invoke OutputPlugin::close().
+	 * Close everything: the output (via CloseOutput()) and the
+	 * software mixer (via CloseSoftwareMixer()).
 	 *
 	 * Caller must not lock the mutex.
 	 */
@@ -200,7 +201,7 @@ public:
 	void OpenOutputAndConvert(AudioFormat audio_format);
 
 	/**
-	 * Close the output plugin.
+	 * Invoke AudioOutput::Close(), but nothing else.
 	 *
 	 * Mutex must not be locked.
 	 */