diff options
author | vnugent <public@vaughnnugent.com> | 2024-02-29 21:22:38 -0500 |
---|---|---|
committer | vnugent <public@vaughnnugent.com> | 2024-02-29 21:22:38 -0500 |
commit | 016a96a80cce025a86c6cf26707738f6a2eb2658 (patch) | |
tree | 2648ea3f111493253c2c7bd635784daab393f609 /lib/VNLib.Data.Caching.ObjectCache/src/ICacheEntryMemoryManager.cs | |
parent | 456ead9bc8b0f61357bae93152ad0403c4940101 (diff) |
feat: add future support for memory diagnostics, and some docs
Diffstat (limited to 'lib/VNLib.Data.Caching.ObjectCache/src/ICacheEntryMemoryManager.cs')
-rw-r--r-- | lib/VNLib.Data.Caching.ObjectCache/src/ICacheEntryMemoryManager.cs | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/VNLib.Data.Caching.ObjectCache/src/ICacheEntryMemoryManager.cs b/lib/VNLib.Data.Caching.ObjectCache/src/ICacheEntryMemoryManager.cs index dffbfa2..dd57931 100644 --- a/lib/VNLib.Data.Caching.ObjectCache/src/ICacheEntryMemoryManager.cs +++ b/lib/VNLib.Data.Caching.ObjectCache/src/ICacheEntryMemoryManager.cs @@ -1,5 +1,5 @@ /* -* Copyright (c) 2023 Vaughn Nugent +* Copyright (c) 2024 Vaughn Nugent * * Library: VNLib * Package: VNLib.Data.Caching.ObjectCache @@ -57,9 +57,9 @@ namespace VNLib.Data.Caching /// Pins the handle to the specified offset and returns a /// <see cref="MemoryHandle"/> to the pinned memory block. /// </summary> - /// <param name="handle"></param> - /// <param name="offset"></param> - /// <returns></returns> + /// <param name="handle">A referrence to the existing handle</param> + /// <param name="offset">The number of bytes from the base to offset the returned pointer</param> + /// <returns>A memory handle pointing to the first byte in the segment given by the offset</returns> MemoryHandle PinHandle(object handle, int offset); /// <summary> |