From f76583a08a676f785f7d3cbb78815e73ca00571d Mon Sep 17 00:00:00 2001
From: Max Kellermann <mk@cm4all.com>
Date: Wed, 13 Sep 2023 19:48:12 +0200
Subject: [PATCH] util/IntrusiveList: document the erase() return value

---
 src/util/IntrusiveList.hxx | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/util/IntrusiveList.hxx b/src/util/IntrusiveList.hxx
index a004759a0..6b0ab25a3 100644
--- a/src/util/IntrusiveList.hxx
+++ b/src/util/IntrusiveList.hxx
@@ -487,6 +487,9 @@ public:
 		return {&ToNode(t)};
 	}
 
+	/**
+	 * @return an iterator to the item following the specified one
+	 */
 	iterator erase(iterator i) noexcept {
 		auto result = std::next(i);
 		ToHook(*i).unlink();
@@ -494,6 +497,9 @@ public:
 		return result;
 	}
 
+	/**
+	 * @return an iterator to the item following the specified one
+	 */
 	iterator erase_and_dispose(iterator i,
 				   Disposer<value_type> auto disposer) noexcept {
 		auto result = erase(i);