From 8c7771efb9e28cca083da4d62d1568510cd763bd Mon Sep 17 00:00:00 2001
From: Ryan Fleury <ryan.j.fleury@gmail.com>
Date: Fri, 5 Nov 2021 14:29:15 -0600
Subject: [PATCH] [docs] arena temp allocation docs

---
 docs/metadesk_reference.mdesk | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/docs/metadesk_reference.mdesk b/docs/metadesk_reference.mdesk
index c17c952..d943eb7 100644
--- a/docs/metadesk_reference.mdesk
+++ b/docs/metadesk_reference.mdesk
@@ -1149,6 +1149,31 @@ MD_ParseSetRule:
         c,
 }
 
+@send(MemoryManagement)
+@see(MD_Arena)
+@see(MD_ArenaTemp)
+@see(MD_ArenaEndTemp)
+@see(MD_ArenaPush)
+@see(MD_ArenaPutBack)
+@doc("Initializes an MD_ArenaTemp instance for @code 'arena' which can be used for temporary memory allocations. MD_ArenaEndTemp should be called once with the return value of this function, to avoid leaving temporary allocations as being allocated within the memory belonging to @code 'arena'. This function, along with MD_ArenaEndTemp, can be useful for using an arena like a stack.")
+@func MD_ArenaBeginTemp:
+{
+    arena: *MD_Arena,
+    return: MD_ArenaTemp,
+}
+
+@send(MemoryManagement)
+@see(MD_Arena)
+@see(MD_ArenaTemp)
+@see(MD_ArenaBeginTemp)
+@see(MD_ArenaPush)
+@see(MD_ArenaPutBack)
+@doc("Pops all bytes allocated onto the arena stored in @code 'temp', after @code 'temp' was constructed with MD_ArenaBeginTemp.")
+@func MD_ArenaEndTemp:
+{
+    temp: MD_ArenaTemp,
+}
+
 //~ Arena Scratch Pool
 
 @send(MemoryManagement)