Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'source/blender/blenlib/BLI_listbase_wrapper.hh')
-rw-r--r--source/blender/blenlib/BLI_listbase_wrapper.hh6
1 files changed, 4 insertions, 2 deletions
diff --git a/source/blender/blenlib/BLI_listbase_wrapper.hh b/source/blender/blenlib/BLI_listbase_wrapper.hh
index 02313d9d22d..70f3135d9e3 100644
--- a/source/blender/blenlib/BLI_listbase_wrapper.hh
+++ b/source/blender/blenlib/BLI_listbase_wrapper.hh
@@ -20,8 +20,10 @@
/** \file
* \ingroup bli
*
- * The purpose of this wrapper is just to make it more comfortable to iterate of ListBase
- * instances, that are used in many places in Blender.
+ * `BLI::ListBaseWrapper` is a typed wrapper for the ListBase struct. That makes it safer and more
+ * convenient to use in C++ in some cases. However, if you find yourself iterating over a linked
+ * list a lot, consider to convert it into a vector for further processing. This improves
+ * performance and debugability.
*/
#include "BLI_listbase.h"