[Bf-blender-cvs] [2312f5fd770] temp-sybren-usd-patch: USD: clearer explanation of when to override `get_id_name()`

[Sybren A. Stüvel]

Commit: 2312f5fd7705f431d68104266bc81574e203b001
Author: Sybren A. Stüvel
Date:   Tue Nov 26 12:42:03 2019 +0100
Branches: temp-sybren-usd-patch
https://developer.blender.org/rB2312f5fd7705f431d68104266bc81574e203b001

USD: clearer explanation of when to override `get_id_name()`

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

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 e1228fbb075..b1ef6928cd0 100644
--- a/source/blender/usd/intern/abstract_hierarchy_iterator.h
+++ b/source/blender/usd/intern/abstract_hierarchy_iterator.h
@@ -156,8 +156,8 @@ class AbstractHierarchyIterator {
    * This base implementation is a no-op; override in a concrete subclass. */
   virtual std::string make_valid_name(const std::string &name) const;
 
-  /* Return the name of this ID datablock that is valid for the exported file format.
-   * Overriding is probably not necessary if the subclass implements make_valid_name(). */
+  /* Return the name of this ID datablock that is valid for the exported file format. Overriding is
+   * only necessary if make_valid_name(id->name+2) is not suitable for the exported file format. */
   virtual std::string get_id_name(const ID *id) const;
 
   /* Given a HierarchyContext of some Object *, return an export path that is valid for its