From 87f4964df55dc29ba0254e018089f2f17bd52ac5 Mon Sep 17 00:00:00 2001
From: Gary Talent <gtalent2@gmail.com>
Date: Thu, 3 May 2018 01:20:59 -0500
Subject: [PATCH] [ox/std] Add some notable missing comments
---
deps/ox/src/ox/std/new.hpp | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/deps/ox/src/ox/std/new.hpp b/deps/ox/src/ox/std/new.hpp
index 175c0a9d..67d0e12b 100644
--- a/deps/ox/src/ox/std/new.hpp
+++ b/deps/ox/src/ox/std/new.hpp
@@ -33,6 +33,9 @@ constexpr auto MallocaStackLimit = 1024;
}
+/**
+ * @return an ox::MallocaPtr of the given type pointing to the requested size memory allocation
+ */
#if defined(OX_USE_STDLIB)
#define ox_malloca(size, Type, ...) ox::MallocaPtr<Type>(size, new (size > MallocaStackLimit ? new uint8_t[size] : ox_alloca(size)) Type(__VA_ARGS__))
#else
@@ -41,6 +44,10 @@ constexpr auto MallocaStackLimit = 1024;
namespace ox {
+/**
+ * MallocaPtr will automatically cleanup the pointed to address upon
+ * destruction if the size of the allocation is greater than MallocaStackLimit.
+ */
template<typename T>
class MallocaPtr {