Trace View: Add doxygen comments to some classes

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

diff --git a/pv/views/trace/triggermarker.hpp b/pv/views/trace/triggermarker.hpp
index 09017c0b882a10e57c2219c4e756e38adaa06687..f2cee265c5514579fa05f17a329f0210c658720e 100644 (file)
--- a/pv/views/trace/triggermarker.hpp
+++ b/pv/views/trace/triggermarker.hpp
@@ -26,6 +26,10 @@ namespace pv {
 namespace views {
 namespace trace {
 
+/**
+ * The TriggerMarker class is used to show to the user at what point in time
+ * a trigger occured. It is not editable by the user.
+ */
 class TriggerMarker : public TimeItem
 {
        Q_OBJECT
@@ -67,7 +71,7 @@ public:
         * Gets the arrow-tip point of the time marker.
         * @param rect the rectangle of the ruler area.
         */
-       QPoint point(const QRect &rect) const override;
+       QPoint drag_point(const QRect &rect) const override;
 
        /**
         * Paints the foreground layer of the item with a QPainter