From 62c8f46ab6f16f99bcf848936a690e01f4c9e770 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Wed, 5 Aug 2015 00:21:50 +1000
Subject: Docs: comment functions in BLI & Py API

---
 source/blender/blenlib/intern/BLI_mempool.c | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'source/blender/blenlib/intern/BLI_mempool.c')

diff --git a/source/blender/blenlib/intern/BLI_mempool.c b/source/blender/blenlib/intern/BLI_mempool.c
index 8fc5f97221d..7338804c685 100644
--- a/source/blender/blenlib/intern/BLI_mempool.c
+++ b/source/blender/blenlib/intern/BLI_mempool.c
@@ -27,8 +27,15 @@
 
 /** \file blender/blenlib/intern/BLI_mempool.c
  *  \ingroup bli
+ *  \author Geoffrey Bantle
  *
  * Simple, fast memory allocator for allocating many elements of the same size.
+ *
+ * Supports:
+ *
+ * - Freeing chunks.
+ * - Iterating over allocated chunks
+ *   (optionally when using the #BLI_MEMPOOL_ALLOW_ITER flag).
  */
 
 #include <string.h>
-- 
cgit v1.2.3