Automatically generated XML-comment stubs are added.

linksplatform · Aug 22, 2021 · 116a3e5 · 116a3e5
1 parent 00c6606
commit 116a3e5
Show file tree

Hide file tree

Showing 12 changed files with 115 additions and 11 deletions.
diff --git a/csharp/Platform.Memory.Tests/HeapResizableDirectMemoryTests.cs b/csharp/Platform.Memory.Tests/HeapResizableDirectMemoryTests.cs
@@ -2,8 +2,20 @@
 
 namespace Platform.Memory.Tests
 {
+    /// <summary>
+    /// <para>
+    /// Represents the heap resizable direct memory tests.
+    /// </para>
+    /// <para></para>
+    /// </summary>
     public unsafe class HeapResizableDirectMemoryTests
     {
+        /// <summary>
+        /// <para>
+        /// Tests that correct memory reallocation test.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         [Fact]
         public void CorrectMemoryReallocationTest()
         {
@@ -15,6 +27,20 @@ public void CorrectMemoryReallocationTest()
             Assert.Equal(0, value1);
         }
 
+        /// <summary>
+        /// <para>
+        /// Gets the last byte using the specified heap memory.
+        /// </para>
+        /// <para></para>
+        /// </summary>
+        /// <param name="heapMemory">
+        /// <para>The heap memory.</para>
+        /// <para></para>
+        /// </param>
+        /// <returns>
+        /// <para>The byte</para>
+        /// <para></para>
+        /// </returns>
         private static byte GetLastByte(HeapResizableDirectMemory heapMemory)
         {
             var pointer1 = (void*)heapMemory.Pointer;

diff --git a/csharp/Platform.Memory/ArrayMemory.cs b/csharp/Platform.Memory/ArrayMemory.cs
@@ -1,4 +1,4 @@
-using System.Runtime.CompilerServices;
+using System.Runtime.CompilerServices;
 
 namespace Platform.Memory
 {
@@ -11,6 +11,12 @@ public class ArrayMemory<TElement> : IArrayMemory<TElement>
     {
         #region Fields
 
+        /// <summary>
+        /// <para>
+        /// The array.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         private readonly TElement[] _array;
 
         #endregion

diff --git a/csharp/Platform.Memory/DirectMemoryAsArrayMemoryAdapter.cs b/csharp/Platform.Memory/DirectMemoryAsArrayMemoryAdapter.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Runtime.CompilerServices;
 using Platform.Disposables;
 using Platform.Exceptions;
@@ -16,6 +16,12 @@ public class DirectMemoryAsArrayMemoryAdapter<TElement> : DisposableBase, IArray
     {
         #region Fields
 
+        /// <summary>
+        /// <para>
+        /// The memory.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         private readonly IDirectMemory _memory;
 
         #endregion

diff --git a/csharp/Platform.Memory/FileArrayMemory.cs b/csharp/Platform.Memory/FileArrayMemory.cs
@@ -1,4 +1,4 @@
-using System.IO;
+using System.IO;
 using System.Runtime.CompilerServices;
 using Platform.Disposables;
 using Platform.Unsafe;
@@ -16,6 +16,12 @@ public class FileArrayMemory<TElement> : DisposableBase, IArrayMemory<TElement>
     {
         #region Fields
 
+        /// <summary>
+        /// <para>
+        /// The file.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         private readonly FileStream _file;
 
         #endregion

diff --git a/csharp/Platform.Memory/FileMappedResizableDirectMemory.cs b/csharp/Platform.Memory/FileMappedResizableDirectMemory.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.IO;
 using System.IO.MemoryMappedFiles;
 using System.Runtime.CompilerServices;
@@ -17,7 +17,19 @@ public unsafe class FileMappedResizableDirectMemory : ResizableDirectMemoryBase
     {
         #region Fields
 
+        /// <summary>
+        /// <para>
+        /// The file.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         private MemoryMappedFile _file;
+        /// <summary>
+        /// <para>
+        /// The accessor.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         private MemoryMappedViewAccessor _accessor;
 
         /// <summary>
@@ -73,6 +85,16 @@ public FileMappedResizableDirectMemory(string path) : this(path, MinimumCapacity
 
         #region Methods
 
+        /// <summary>
+        /// <para>
+        /// Maps the file using the specified capacity.
+        /// </para>
+        /// <para></para>
+        /// </summary>
+        /// <param name="capacity">
+        /// <para>The capacity.</para>
+        /// <para></para>
+        /// </param>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         private void MapFile(long capacity)
         {
@@ -87,6 +109,12 @@ private void MapFile(long capacity)
             Pointer = new IntPtr(pointer);
         }
 
+        /// <summary>
+        /// <para>
+        /// Unmaps the file.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         private void UnmapFile()
         {
@@ -96,6 +124,20 @@ private void UnmapFile()
             }
         }
 
+        /// <summary>
+        /// <para>
+        /// Determines whether this instance unmap file.
+        /// </para>
+        /// <para></para>
+        /// </summary>
+        /// <param name="pointer">
+        /// <para>The pointer.</para>
+        /// <para></para>
+        /// </param>
+        /// <returns>
+        /// <para>The bool</para>
+        /// <para></para>
+        /// </returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         private bool UnmapFile(IntPtr pointer)
         {

diff --git a/csharp/Platform.Memory/HeapResizableDirectMemory.cs b/csharp/Platform.Memory/HeapResizableDirectMemory.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 using Platform.Unsafe;

diff --git a/csharp/Platform.Memory/IArrayMemory.cs b/csharp/Platform.Memory/IArrayMemory.cs
@@ -1,4 +1,4 @@
-using System.Runtime.CompilerServices;
+using System.Runtime.CompilerServices;
 
 namespace Platform.Memory
 {

diff --git a/csharp/Platform.Memory/IDirectMemory.cs b/csharp/Platform.Memory/IDirectMemory.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Runtime.CompilerServices;
 
 namespace Platform.Memory

diff --git a/csharp/Platform.Memory/IMemory.cs b/csharp/Platform.Memory/IMemory.cs
@@ -1,4 +1,4 @@
-using System.Runtime.CompilerServices;
+using System.Runtime.CompilerServices;
 
 namespace Platform.Memory
 {

diff --git a/csharp/Platform.Memory/IResizableDirectMemory.cs b/csharp/Platform.Memory/IResizableDirectMemory.cs
@@ -1,4 +1,4 @@
-using System.Runtime.CompilerServices;
+using System.Runtime.CompilerServices;
 
 namespace Platform.Memory
 {

diff --git a/csharp/Platform.Memory/ResizableDirectMemoryBase.cs b/csharp/Platform.Memory/ResizableDirectMemoryBase.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Threading;
 using System.Runtime.CompilerServices;
 using Platform.Exceptions;
@@ -25,8 +25,26 @@ public abstract class ResizableDirectMemoryBase : DisposableBase, IResizableDire
 
         #region Fields
 
+        /// <summary>
+        /// <para>
+        /// The pointer.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         private IntPtr _pointer;
+        /// <summary>
+        /// <para>
+        /// The reserved capacity.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         private long _reservedCapacity;
+        /// <summary>
+        /// <para>
+        /// The used capacity.
+        /// </para>
+        /// <para></para>
+        /// </summary>
         private long _usedCapacity;
 
         #endregion

diff --git a/csharp/Platform.Memory/TemporaryFileMappedResizableDirectMemory.cs b/csharp/Platform.Memory/TemporaryFileMappedResizableDirectMemory.cs
@@ -1,4 +1,4 @@
-using System.IO;
+using System.IO;
 using System.Runtime.CompilerServices;
 
 namespace Platform.Memory