From abffaf6ff75f9ecb4eceedd80fe80fb039761b2e Mon Sep 17 00:00:00 2001
From: Eric Severance <esev@esev.com>
Date: Tue, 17 Dec 2024 00:25:20 -0800
Subject: [PATCH] Document deleter

---
 src/mesh/MemoryPool.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/mesh/MemoryPool.h b/src/mesh/MemoryPool.h
index 795e768ea..c4af3c4ac 100644
--- a/src/mesh/MemoryPool.h
+++ b/src/mesh/MemoryPool.h
@@ -56,7 +56,7 @@ template <class T> class Allocator
     /// std::unique_ptr wrapped variant of allocZeroed(TickType_t maxWait).
     UniqueAllocation allocUniqueZeroed(TickType_t maxWait) { return UniqueAllocation(allocZeroed(maxWait), deleter); }
     /// Return a queable object which is a copy of some other object
-    // std::unique_ptr wrapped variant of allocCopy(const T &src, TickType_t maxWait).
+    /// std::unique_ptr wrapped variant of allocCopy(const T &src, TickType_t maxWait).
     UniqueAllocation allocUniqueCopy(const T &src, TickType_t maxWait = portMAX_DELAY)
     {
         return UniqueAllocation(allocCopy(src, maxWait), deleter);
@@ -70,6 +70,7 @@ template <class T> class Allocator
     virtual T *alloc(TickType_t maxWait) = 0;
 
   private:
+    // std::unique_ptr Deleter function; calls release().
     const std::function<void(T *)> deleter;
 };