]> git.tdb.fi Git - libs/core.git/blobdiff - source/time/timestamp.h
Added DateTime
[libs/core.git] / source / time / timestamp.h
index 984333da7a357edb51d9464c9b01baa890e5739b..1e1b275ab97a799cf8450e7c99ecb6472d37b1ed 100644 (file)
@@ -13,9 +13,10 @@ namespace Msp {
 namespace Time {
 
 /**
-Represents a moment in time, such as the last tick.  This class is NOT intended
-to be used for storing arbitary user-defined times, I'll add a DateTime class
-if the need arises.
+Represents a moment in time.  The main source of TimeStamps is the now()
+function.
+
+For representing user-specified times, use the DateTime class.
 */
 class TimeStamp
 {
@@ -33,8 +34,8 @@ public:
        explicit TimeStamp(int64_t u): usec(u) { }
 
        /**
-       Returns the raw number stored inside the TimeStamp.  This should only be used
-       for serialization and the result should not be interpreted in any way.
+       Returns the raw number stored inside the TimeStamp.  This value should be
+       considered opaque and only be used for serialization.
        */
        int64_t   raw() const { return usec; }