From d6195025fb0788a4e2b412a89aae38fba2aa351e Mon Sep 17 00:00:00 2001
From: Max Kellermann <max.kellermann@gmail.com>
Date: Tue, 5 Nov 2024 12:57:50 +0100
Subject: [PATCH] filter/Filter: clarify Flush() documentation

---
 src/filter/Filter.hxx | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/filter/Filter.hxx b/src/filter/Filter.hxx
index 7196cc2d8..b533965d4 100644
--- a/src/filter/Filter.hxx
+++ b/src/filter/Filter.hxx
@@ -51,7 +51,13 @@ public:
 	 * Flush pending data and return it.  This should be called
 	 * repeatedly until it returns nullptr.
 	 *
+	 * After calling this method, this object cannot be used again
+         * (not even Reset() is allowed).
+	 *
 	 * Throws on error.
+	 *
+	 * @return pending data (will be invalidated by deleting this
+	 * object or by any call to Flush())
 	 */
 	virtual std::span<const std::byte> Flush() {
 		return {};