Add generic "Create marker here" context menu entry

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

diff --git a/pv/views/trace/timemarker.hpp b/pv/views/trace/timemarker.hpp
index 24ba9b0341bb331b4026f2285a08f423a5aa2059..48afc16bb77e9c346ec75e80c06ab3564873ecc1 100644 (file)
--- a/pv/views/trace/timemarker.hpp
+++ b/pv/views/trace/timemarker.hpp
@@ -41,6 +41,10 @@ namespace trace {
 
 class View;
 
+/**
+ * The TimeMarker class represents items on the @ref Ruler that highlight a
+ * single point in time to the user. Aside from this, it is generic in nature.
+ */
 class TimeMarker : public TimeItem
 {
        Q_OBJECT
@@ -52,10 +56,10 @@ protected:
        /**
         * Constructor.
         * @param view A reference to the view that owns this marker.
-        * @param colour A reference to the colour of this cursor.
+        * @param color A reference to the color of this cursor.
         * @param time The time to set the flag to.
         */
-       TimeMarker(View &view, const QColor &colour, const pv::util::Timestamp& time);
+       TimeMarker(View &view, const QColor &color, const pv::util::Timestamp& time);
 
 public:
        /**
@@ -116,7 +120,7 @@ private Q_SLOTS:
        void on_value_changed(const pv::util::Timestamp& value);
 
 protected:
-       const QColor &colour_;
+       const QColor &color_;
 
        pv::util::Timestamp time_;