adding comment

vlntb · Jan 3, 2025 · f371d88 · f371d88
1 parent 2cdabe6
commit f371d88
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/include/xrpl/basics/IntrusivePointer.h b/include/xrpl/basics/IntrusivePointer.h
@@ -320,6 +320,9 @@ class WeakIntrusive
 template <class T>
 class SharedWeakUnion
 {
+    // Tagged pointer. Low bit determines if this is a strong or a weak
+    // pointer. The low bit must be masked to zero when converting back to a
+    // pointer. If the low bit is '1', this is a weak pointer.
     static_assert(
         alignof(T) >= 2,
         "Bad alignment: Combo pointer requires low bit to be zero");