document timefunc api

[libi2ncommon] / src / timefunc.cpp

diff --git a/src/timefunc.cpp b/src/timefunc.cpp
index e41308f..0883055 100644 (file)
--- a/src/timefunc.cpp
+++ b/src/timefunc.cpp
@@ -1143,6 +1143,14 @@ namespace clock {
         return *this;
     }
 
+    /*
+     * @note    This operator is an up-assignment from a type containing less
+     *          information than the structure assigned from. Since the
+     *          operator can only be two valued we must normalize the remaining
+     *          fields to the default clock. When assigning from non-default
+     *          clocks, use the appropriate constructor and pass it the desired
+     *          id and variant so as to assign the result.
+     */
     Time &
     Time::operator= (struct timespec ts) NOEXCEPT
     {