[Bf-blender-cvs] [abe1a061f8a] master: Docs: add doc-string for TransDataContainer

[Campbell Barton]

Commit: abe1a061f8aab5c9357ff92fd6b579a8a9553f0d
Author: Campbell Barton
Date:   Sat Mar 13 03:12:24 2021 +1100
Branches: master
https://developer.blender.org/rBabe1a061f8aab5c9357ff92fd6b579a8a9553f0d

Docs: add doc-string for TransDataContainer

===================================================================

M	source/blender/editors/transform/transform.h

===================================================================

diff --git a/source/blender/editors/transform/transform.h b/source/blender/editors/transform/transform.h
index 24335b6b6b7..4b43592165b 100644
--- a/source/blender/editors/transform/transform.h
+++ b/source/blender/editors/transform/transform.h
@@ -429,6 +429,20 @@ typedef struct TransCustomDataContainer {
 } TransCustomDataContainer;
 #define TRANS_CUSTOM_DATA_ELEM_MAX (sizeof(TransCustomDataContainer) / sizeof(TransCustomData))
 
+/**
+ * Container for Transform Data
+ *
+ * Used to implement multi-object modes, so each object can have it's
+ * own data array as well as object matrix, local center etc.
+ *
+ * Anything that can't be shared between all objects
+ * and doesn't make sense to store for every vertex (in the #TransDataContainer.data).
+ *
+ * \note at some point this could be used to store non object containers
+ * although this only makes sense if each container has it's own matrices,
+ * otherwise all elements may as well be stored in one array (#TransDataContainer.data),
+ * as is already done for curve-objects, f-curves. etc.
+ */
 typedef struct TransDataContainer {
   /** Transformed data (array). */
   TransData *data;