From 3436d1bf37a0c323f16dabeb30bdc97a2bc064b7 Mon Sep 17 00:00:00 2001
From: Elia Sulimanov <eliasulimanov@gmail.com>
Date: Wed, 19 Aug 2020 16:03:58 +0300
Subject: [PATCH] Done Heap API

---
 source/Cosmos.Core/Memory/Heap.cs | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/source/Cosmos.Core/Memory/Heap.cs b/source/Cosmos.Core/Memory/Heap.cs
index 30862e887..4ba37612d 100644
--- a/source/Cosmos.Core/Memory/Heap.cs
+++ b/source/Cosmos.Core/Memory/Heap.cs
@@ -5,9 +5,15 @@ using Native = System.UInt32;
 
 namespace Cosmos.Core.Memory
 {
-
+    /// <summary>
+    /// Heap class.
+    /// </summary>
     public static unsafe class Heap
     {
+        /// <summary>
+        /// Init heap.
+        /// </summary>
+        /// <exception cref="Exception">Thrown on fatal error, contact support.</exception>
         public static void Init()
         {
             HeapSmall.Init();
@@ -15,6 +21,11 @@ namespace Cosmos.Core.Memory
             HeapLarge.Init();
         }
 
+        /// <summary>
+        /// Alloc memory block, of a given size.
+        /// </summary>
+        /// <param name="aSize">A size of block to alloc, in bytes.</param>
+        /// <returns>Byte pointer to the start of the block.</returns>
         public static byte* Alloc(Native aSize)
         {
             if (aSize <= HeapSmall.mMaxItemSize)
@@ -33,6 +44,16 @@ namespace Cosmos.Core.Memory
 
         // Keep as void* and not byte* or other. Reduces typecasting from callers
         // who may have typed the pointer to their own needs.
+        /// <summary>
+        /// Free a heap item.
+        /// </summary>
+        /// <param name="aPtr">A pointer to the heap item to be freed.</param>
+        /// <exception cref="Exception">Thrown if: 
+        /// <list type="bullet">
+        /// <item>Page type is not found.</item>
+        /// <item>Heap item not found in RAT.</item>
+        /// </list>
+        /// </exception>
         public static void Free(void* aPtr)
         {
             //TODO find a better way to remove the double look up here for GetPageType and then again in the