diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2015-08-04 17:21:50 +0300 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2015-08-04 19:09:03 +0300 |
| commit | 62c8f46ab6f16f99bcf848936a690e01f4c9e770 (patch) | |
| tree | 5945055a8cea5b65eccfeaa29629c942f27df575 /source/blender/blenlib/intern/BLI_memarena.c | |
| parent | 23f54076db6d241af2a8f9404ab5f5b8072a4db0 (diff) | |
Docs: comment functions in BLI & Py API
Diffstat (limited to 'source/blender/blenlib/intern/BLI_memarena.c')
| -rw-r--r-- | source/blender/blenlib/intern/BLI_memarena.c | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/source/blender/blenlib/intern/BLI_memarena.c b/source/blender/blenlib/intern/BLI_memarena.c index dd0997c8e1c..2604dbafdc0 100644 --- a/source/blender/blenlib/intern/BLI_memarena.c +++ b/source/blender/blenlib/intern/BLI_memarena.c @@ -28,6 +28,14 @@ /** \file blender/blenlib/intern/BLI_memarena.c * \ingroup bli + * \brief Memory arena ADT. + * \section aboutmemarena Memory Arena + * + * Memory arena's are commonly used when the program + * needs to quickly allocate lots of little bits of data, + * which are all freed at the same moment. + * + * \note Memory can't be freed during the arenas lifetime. */ #include <stdlib.h> |