Add doc for entity extensions

Deltares · Nov 26, 2024 · 92a989b · 92a989b
1 parent ad9a060
commit 92a989b
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 12 deletions.
diff --git a/libs/UGridNET/dll/src/ContactsExtensions.cs b/libs/UGridNET/dll/src/ContactsExtensions.cs
@@ -1,12 +1,12 @@
-using System;
-using System.Runtime.InteropServices;
-
 namespace UGridNET
 {
     namespace Extensions
     {
         internal static class ContactsExtensions
         {
+            /// <summary> Allocates unmanaged memory for all required properties of the <see cref="Contacts"/> instance. </summary>
+            /// <param name="contacts"> Instance of <see cref="Contacts"/>. </param>
+            /// <remarks> Memory allocated by this method must be freed by <see cref="Free"> </remarks>
             public static void Allocate(this Contacts contacts)
             {
                 try
@@ -27,6 +27,8 @@ public static void Allocate(this Contacts contacts)
                 }
             }
 
+            /// <summary> Frees unmanaged memory allocated by <see cref="Allocate"/> for all required properties of the <see cref="Contacts"/> instance. </summary>
+            /// <param name="contacts"> Instance of <see cref="Contacts"/>. </param>
             public static void Free(this Contacts contacts)
             {
                 IntPtrHelpers.Free(contacts.name);

diff --git a/libs/UGridNET/dll/src/Mesh1DExtensions.cs b/libs/UGridNET/dll/src/Mesh1DExtensions.cs
@@ -1,12 +1,12 @@
-using System;
-using System.Runtime.InteropServices;
-
 namespace UGridNET
 {
     namespace Extensions
     {
         internal static class Mesh1DExtensions
         {
+            /// <summary> Allocates unmanaged memory for all required properties of the <see cref="Mesh1D"/> instance. </summary>
+            /// <param name="mesh1D"> Instance of <see cref="Mesh1D"/>. </param>
+            /// <remarks> Memory allocated by this method must be freed by <see cref="Free"> </remarks>
             public static void Allocate(this Mesh1D mesh1D)
             {
                 try
@@ -31,6 +31,8 @@ public static void Allocate(this Mesh1D mesh1D)
                 }
             }
 
+            /// <summary> Frees unmanaged memory allocated by <see cref="Allocate"/> for all required properties of the <see cref="Mesh1D"/> instance. </summary>
+            /// <param name="mesh1D"> Instance of <see cref="Mesh1D"/>. </param>
             public static void Free(this Mesh1D mesh1D)
             {
                 IntPtrHelpers.Free(mesh1D.name);

diff --git a/libs/UGridNET/dll/src/Mesh2DExtensions.cs b/libs/UGridNET/dll/src/Mesh2DExtensions.cs
@@ -1,12 +1,12 @@
-using System;
-using System.Runtime.InteropServices;
-
 namespace UGridNET
 {
     namespace Extensions
     {
         internal static class Mesh2DExtensions
         {
+            /// <summary> Allocates unmanaged memory for all required properties of the <see cref="Mesh2D"/> instance. </summary>
+            /// <param name="mesh2D"> Instance of <see cref="Mesh2D"/>. </param>
+            /// <remarks> Memory allocated by this method must be freed by <see cref="Free"> </remarks>
             public static void Allocate(this Mesh2D mesh2D)
             {
                 try
@@ -35,6 +35,8 @@ public static void Allocate(this Mesh2D mesh2D)
                 }
             }
 
+            /// <summary> Frees unmanaged memory allocated by <see cref="Allocate"/> for all required properties of the <see cref="Mesh2D"/> instance. </summary>
+            /// <param name="mesh2D"> Instance of <see cref="Mesh2D"/>. </param>
             public static void Free(this Mesh2D mesh2D)
             {
                 IntPtrHelpers.Free(mesh2D.name);

diff --git a/libs/UGridNET/dll/src/Network1DExtensions.cs b/libs/UGridNET/dll/src/Network1DExtensions.cs
@@ -1,12 +1,12 @@
-using System;
-using System.Runtime.InteropServices;
-
 namespace UGridNET
 {
     namespace Extensions
     {
         internal static class Network1DExtensions
         {
+            /// <summary> Allocates unmanaged memory for all required properties of the <see cref="Network1D"/> instance. </summary>
+            /// <param name="network1D"> Instance of <see cref="Network1D"/>. </param>
+            /// <remarks> Memory allocated by this method must be freed by <see cref="Free"> </remarks>
             public static void Allocate(this Network1D network1D)
             {
                 try
@@ -33,6 +33,8 @@ public static void Allocate(this Network1D network1D)
                 }
             }
 
+            /// <summary> Frees unmanaged memory allocated by <see cref="Allocate"/> for all required properties of the <see cref="Network1D"/> instance. </summary>
+            /// <param name="network1D"> Instance of <see cref="Network1D"/>. </param>
             public static void Free(this Network1D network1D)
             {
                 IntPtrHelpers.Free(network1D.name);