[Bf-blender-cvs] [fd03e8dcd63] temp-sybren-usd-patch-02: USD: clarified ownership of objects returned by create_xxxx_writer()

[Sybren A. Stüvel]

Commit: fd03e8dcd63c3ac50b6c92a5ee5f42f52dc4fd88
Author: Sybren A. Stüvel
Date:   Tue Nov 26 13:02:04 2019 +0100
Branches: temp-sybren-usd-patch-02
https://developer.blender.org/rBfd03e8dcd63c3ac50b6c92a5ee5f42f52dc4fd88

USD: clarified ownership of objects returned by create_xxxx_writer()

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

M	source/blender/usd/intern/abstract_hierarchy_iterator.h

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

diff --git a/source/blender/usd/intern/abstract_hierarchy_iterator.h b/source/blender/usd/intern/abstract_hierarchy_iterator.h
index 7e672fb355e..347fe571ddf 100644
--- a/source/blender/usd/intern/abstract_hierarchy_iterator.h
+++ b/source/blender/usd/intern/abstract_hierarchy_iterator.h
@@ -216,7 +216,10 @@ class AbstractHierarchyIterator {
    * nullptr if the object or its data should not be exported. Returning a nullptr for
    * data/hair/particle will NOT prevent the transform to be written.
    *
-   * 'Xform' is used for 'transform' to be consistent with the terminology of USD and Alembic. */
+   * 'Xform' is used for 'transform' to be consistent with the terminology of USD and Alembic.
+   *
+   * The returned writer is owned by the AbstractHierarchyWriter, and should be freed in
+   * delete_object_writer(). */
   virtual AbstractHierarchyWriter *create_xform_writer(const HierarchyContext *context) = 0;
   virtual AbstractHierarchyWriter *create_data_writer(const HierarchyContext *context) = 0;
   virtual AbstractHierarchyWriter *create_hair_writer(const HierarchyContext *context) = 0;