From 808b21530a6e0b4882f2a01f3aac9b6de88d0bbf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?L=C3=A9o=20Lam?= <leo@leolam.fr>
Date: Wed, 9 Feb 2022 02:59:34 +0100
Subject: [PATCH] ksys: Document safeDelete and safeDeleteArray

---
 src/KingSystem/Utils/SafeDelete.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/KingSystem/Utils/SafeDelete.h b/src/KingSystem/Utils/SafeDelete.h
index ddaf3fb7..d5bca0b5 100644
--- a/src/KingSystem/Utils/SafeDelete.h
+++ b/src/KingSystem/Utils/SafeDelete.h
@@ -4,6 +4,9 @@
 
 namespace ksys::util {
 
+/// Deletes an object that was allocatd with a new expression and sets the pointer to nullptr,
+/// preventing it from being accidentally reused.
+/// It is safe for the pointer to be already nullptr.
 template <typename T>
 inline void safeDelete(T*& pointer) {
     if (pointer)
@@ -11,6 +14,9 @@ inline void safeDelete(T*& pointer) {
     pointer = nullptr;
 }
 
+/// Deletes an array that was allocatd with a new[] expression and sets the pointer to nullptr,
+/// preventing it from being accidentally reused.
+/// It is safe for the pointer to be already nullptr.
 template <typename T>
 inline void safeDeleteArray(T*& pointer) {
     if (pointer)