Kernel: Add a little explainer comment to ListedRefCounted

akimdi · Aug 16, 2021 · 45a5cf9 · 45a5cf9
1 parent ea09294
commit 45a5cf9
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/Kernel/Library/ListedRefCounted.h b/Kernel/Library/ListedRefCounted.h
@@ -10,6 +10,11 @@
 
 namespace Kernel {
 
+// ListedRefCounted<T> is a slot-in replacement for RefCounted<T> to use in classes
+// that add themselves to a SpinLockProtectedValue<IntrusiveList> when constructed.
+// The custom unref() implementation here ensures that the the list is locked during
+// unref(), and that the T is removed from the list before ~T() is invoked.
+
 template<typename T>
 class ListedRefCounted : public RefCountedBase {
 public: