From dd56dd6e29c251226a4dde9f4c1f72958f009f28 Mon Sep 17 00:00:00 2001
From: Lynix <lynix680@gmail.com>
Date: Sun, 1 Mar 2015 00:08:34 +0100
Subject: [PATCH] (MemoryPool) Added some DOC comments

Former-commit-id: 5ddd0414541e59623956716739bf19827ce68049
---
 include/Nazara/Core/MemoryPool.inl | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/Nazara/Core/MemoryPool.inl b/include/Nazara/Core/MemoryPool.inl
index bba414cfe..7ee79dfa1 100644
--- a/include/Nazara/Core/MemoryPool.inl
+++ b/include/Nazara/Core/MemoryPool.inl
@@ -34,6 +34,7 @@ NzMemoryPool(pool->m_blockSize, pool->m_size, pool->m_canGrow)
 
 inline void* NzMemoryPool::Allocate(unsigned int size)
 {
+	///DOC: Si la taille est supérieure à celle d'un bloc du pool, l'opérateur new est utilisé
 	if (size <= m_blockSize)
 	{
 		if (m_freeCount > 0)
@@ -53,6 +54,7 @@ inline void* NzMemoryPool::Allocate(unsigned int size)
 template<typename T>
 inline void NzMemoryPool::Delete(T* ptr)
 {
+	///DOC: Va appeler le destructeur de l'objet avant de le libérer
 	if (ptr)
 	{
 		ptr->~T();
@@ -62,6 +64,7 @@ inline void NzMemoryPool::Delete(T* ptr)
 
 inline void NzMemoryPool::Free(void* ptr)
 {
+	///DOC: Si appelé avec un pointeur ne faisant pas partie du pool, l'opérateur delete est utilisé
 	if (ptr)
 	{
 		// Le pointeur nous appartient-il ?
@@ -111,6 +114,7 @@ inline unsigned int NzMemoryPool::GetSize() const
 template<typename T, typename... Args>
 inline T* NzMemoryPool::New(Args&&... args)
 {
+	///DOC: Permet de construire un objet directement dans le pook
 	T* object = static_cast<T*>(Allocate(sizeof(T)));
 	NzPlacementNew<T>(object, std::forward<Args>(args)...);