Merge branch 'main' of https://github.com/SoftStoneDevelop/StackMemoryCollections

Author: Vyacheslav

Documentation/Stack/CopyCount.md

@@ -1 +1,25 @@
+# Copy(in void*, in nuint) Method
 
+## Definition
+Copies a count of elements in the collection into memory, starting from the bottom of the stack.
+
+```C#
+public void Copy(in void* ptrDest, in nuint count)
+```
+
+## Parameters
+`in void* ptrDest`
+
+Pointer to the memory where the elements will be copied
+
+`in nuint count`
+
+Count of elements to copy
+
+
+## Exceptions
+
+```C#
+Exception
+```
+If the collection does not have that many elements

Documentation/Stack/CopyToStack.md

@@ -1 +1,20 @@
+# Copy(in Class.StackOf{ItemType}) Method
 
+## Definition
+Copies a elements in the collection into destination collection.
+
+```C#
+public void Copy(in Class.StackOf{ItemType} destStack)
+```
+
+## Parameters
+`in Class.StackOf{ItemType} destStack`
+
+The destination collection where the elements will be copied to
+
+## Exceptions
+
+```C#
+ArgumentException
+```
+If destination stack not enough capacity

Documentation/Stack/Dispose.md

@@ -1,31 +1,11 @@
-# FreeMemory(nuint) Method
+# Dispose() Method
 
 ## Definition
-Free memory.
+Disposed the memory used by the collection.
 
 ```C#
-public void FreeMemory(nuint reducingBytes)
+public void Dispose()
 ```
 
-## Parameters
-reducingBytes nuint
-
-Freed memory size in bytes
-
-## Returns
-void
-
-## Exceptions
-
-```C#
-ObjectDisposedException
-```
--or-
-
-```C#
-Exception
-```
-If all memory is already free
-
 ## Remark
-Shifts the Current pointer by -reducingBytes
+If the instance was created using a [constructor on a pointer](https://github.com/SoftStoneDevelop/StackMemoryCollections/blob/main/Documentation/Stack/Constructor4.md) then: do nothing.

Documentation/Stack/GetEnumerator.md

@@ -1 +1,13 @@
+# IEnumerator GetEnumerator() Method
 
+## Definition
+Returns an enumerator that iterates through the collection.
+
+```C#
+System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
+```
+
+## Returns
+`System.Collections.IEnumerator`
+
+An `IEnumerator` that can be used to iterate through the collection.

Documentation/Stack/GetEnumeratorItemType.md

@@ -1 +1,13 @@
+# IEnumerator<{ItemType}> GetEnumerator() Method
 
+## Definition
+Returns an enumerator that iterates through the collection.
+
+```C#
+public System.Collections.Generic.IEnumerator<{ItemType}> GetEnumerator()
+```
+
+## Returns
+`System.Collections.Generic.IEnumerator<{ItemType}>`
+
+An IEnumerator<{ItemType}> that can be used to iterate through the collection.

Documentation/Stack/Push.md

@@ -18,3 +18,7 @@ Inserted element
 Exception
 ```
 If there is no place for the element in the collection
+
+## Remarks
+
+If the instance was created using a constructor on a memory and no place for the element in the collection then: allocate memory from `memory`.

Documentation/Stack/PushPtr.md

@@ -21,3 +21,4 @@ If there is no place for the element in the collection
 
 ## Remarks
 For collections on primitive types then ptr is `{ItemType}*` pointer instead of `void*`
+If the instance was created using a constructor on a memory and no place for the element in the collection then: allocate memory from `memory`.

Documentation/Stack/TryPush.md

@@ -17,3 +17,4 @@ Inserted element
 `bool`
 
 True if element is successfully inserted otherwise False
+If the instance was created using a constructor on a memory and no place for the element in the collection then: try allocate memory from `memory`.

Documentation/Stack/TryPushPtr.md

@@ -19,3 +19,4 @@ True if element is successfully inserted otherwise False
 
 ## Remarks
 For collections on primitive types then ptr is `{ItemType}*` pointer instead of `void*`
+If the instance was created using a constructor on a memory and no place for the element in the collection then: try allocate memory from `memory`.