Don't return valid time() for the cursor pair

[pulseview.git] / pv / views / trace / timeitem.hpp

diff --git a/pv/views/trace/timeitem.hpp b/pv/views/trace/timeitem.hpp
index c9b322c7703c1d44287e9f14232e98697f1ca24d..e0114a5aca8e36a9434c1fe3b92aec8d2f487d37 100644 (file)
--- a/pv/views/trace/timeitem.hpp
+++ b/pv/views/trace/timeitem.hpp
@@ -49,6 +49,10 @@ public:
         */
        virtual void set_time(const pv::util::Timestamp& time) = 0;
 
+       /**
+        * Returns the time this time item is set to.
+        * @return 0 in case there is no valid time (e.g. for a cursor pair)
+        */
        virtual const pv::util::Timestamp time() const = 0;
 
        virtual float get_x() const = 0;