From b7b4c6b4ea6860f998e3279772d9c216c6ad4b54 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max.kellermann@gmail.com>
Date: Tue, 5 Nov 2024 11:58:28 +0100
Subject: [PATCH] filter/Filter: Flush() also invalidates the returned buffer

Just API documentation.
---
 src/filter/Filter.hxx | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/filter/Filter.hxx b/src/filter/Filter.hxx
index 2b71358e3..9174076e1 100644
--- a/src/filter/Filter.hxx
+++ b/src/filter/Filter.hxx
@@ -41,9 +41,9 @@ public:
 	 * Throws on error.
 	 *
 	 * @param src the input buffer
-	 * @return the destination buffer on success (will be
-	 * invalidated by deleting this object or the next FilterPCM()
-	 * or Reset() call)
+	 * @return the output buffer (will be invalidated by deleting
+	 * this object or any call to Reset(), FilterPCM() or
+	 * Flush())
 	 */
 	virtual std::span<const std::byte> FilterPCM(std::span<const std::byte> src) = 0;