X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=blobdiff_plain;f=source%2Ftime%2Ftimestamp.h;h=1e1b275ab97a799cf8450e7c99ecb6472d37b1ed;hp=984333da7a357edb51d9464c9b01baa890e5739b;hb=80bbee2f401b4af71cb1b80508bdb0d2bb61fa40;hpb=fe77fc6b869a71bf94d501a0762579f4ddbc5094 diff --git a/source/time/timestamp.h b/source/time/timestamp.h index 984333d..1e1b275 100644 --- a/source/time/timestamp.h +++ b/source/time/timestamp.h @@ -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; }