Browse Source

Small documentation clarification.

Vicente Penades 5 years ago
parent
commit
256c6b383d
1 changed files with 3 additions and 0 deletions
  1. 3 0
      src/SharpGLTF.Core/Memory/MemoryImage.cs

+ 3 - 0
src/SharpGLTF.Core/Memory/MemoryImage.cs

@@ -111,6 +111,9 @@ namespace SharpGLTF.Memory
 
 
         private readonly BYTES _Image;
         private readonly BYTES _Image;
 
 
+        /// <remarks>
+        /// This field must NOT be used for equality checks, it has the same face value as a code comment.
+        /// </remarks>
         [System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]
         [System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]
         private readonly String _SourcePathHint;
         private readonly String _SourcePathHint;