Add warnings for ref values. Fixes #1.

Berrysoft · Apr 24, 2019 · f99c946 · f99c946
1 parent 649123b
commit f99c946
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/src/Berrysoft.Unsafe/ByReference.cs b/src/Berrysoft.Unsafe/ByReference.cs
@@ -16,6 +16,7 @@ namespace Berrysoft.Unsafe
         private readonly void* _ptr;
         /// <summary>
         /// Initialize a <see cref="ByReference{T}"/> with a <typeparamref name="T"/> reference.
+        /// Note: the storage of value should be pinned.
         /// </summary>
         /// <param name="value">The reference.</param>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]

diff --git a/src/Berrysoft.Unsafe/Pointer.cs b/src/Berrysoft.Unsafe/Pointer.cs
@@ -38,6 +38,7 @@ public Pointer(IntPtr ptr)
         }
         /// <summary>
         /// Initialize a <see cref="Pointer{T}"/> with a <typeparamref name="T"/> reference.
+        /// Note: the storage of value should be pinned.
         /// </summary>
         /// <param name="ptr">The reference.</param>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]

diff --git a/src/Berrysoft.Unsafe/UnsafeMethods.cs b/src/Berrysoft.Unsafe/UnsafeMethods.cs
@@ -18,6 +18,7 @@ public unsafe static class UnsafeMethods
         public static int GetSize<T>() => SizeOf<T>();
         /// <summary>
         /// Get a <see cref="Pointer{T}"/> with a <typeparamref name="T"/> reference.
+        /// Note: the storage of value should be pinned.
         /// </summary>
         /// <typeparam name="T">Type of the pointer pointed to.</typeparam>
         /// <param name="value">The reference.</param>
@@ -47,6 +48,7 @@ public static Pointer<char> PointerOf(string str)
         }
         /// <summary>
         /// Get a <see cref="Unsafe.ByReference{T}"/> with a <typeparamref name="T"/> reference.
+        /// Note: the storage of value should be pinned.
         /// </summary>
         /// <typeparam name="T">Type of the pointer pointed to.</typeparam>
         /// <param name="value">The reference.</param>
@@ -55,6 +57,7 @@ public static Pointer<char> PointerOf(string str)
         public static ByReference<T> ByReference<T>(ref T value) => new ByReference<T>(ref value);
         /// <summary>
         /// Get a <see cref="Unsafe.ByReference{T}"/> with a readonly <typeparamref name="T"/> reference.
+        /// Note: the storage of value should be pinned.
         /// </summary>
         /// <typeparam name="T">Type of the pointer pointed to.</typeparam>
         /// <param name="value">The reference.</param>