Don't leave internal edit mode when clicking on an automation region view (#4747).

[ardour.git] / libs / evoral / evoral / TimeConverter.hpp

diff --git a/libs/evoral/evoral/TimeConverter.hpp b/libs/evoral/evoral/TimeConverter.hpp
index 3f30570905d558ed4d93ee803decab9152ea8aeb..da765c4b78c6e0c6ebc3424f9fa0a335b8d8a521 100644 (file)
--- a/libs/evoral/evoral/TimeConverter.hpp
+++ b/libs/evoral/evoral/TimeConverter.hpp
@@ -25,6 +25,12 @@ namespace Evoral {
  *
  * Think of the conversion method names as if they are written in-between
  * the two template parameters (i.e. "A <name> B").
+ *
+ * _origin_b should be the origin for conversion in the units of B.
+ * That is, there is some point in time _origin_b, such that:
+ *
+ *    to()   converts a time _origin_b + a into an offset from _origin_b in units of B.
+ *    from() converts a time _origin_b + b into an offset from _origin_b in units of A.
  */
 template<typename A, typename B>
 class TimeConverter {
@@ -52,7 +58,10 @@ protected:
 };
 
 
-/** A stub TimeConverter that simple statically casts between types. */
+/** A stub TimeConverter that simple statically casts between types.
+ *  _origin_b has no bearing here, as there is no time conversion
+ *  going on.
+ */
 template<typename A, typename B>
 class IdentityConverter : public TimeConverter<A,B> {
   public: