Trace View: Add doxygen comments to some classes

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

diff --git a/pv/views/trace/timemarker.hpp b/pv/views/trace/timemarker.hpp
index 7c49948b497179a29a32fd22cfcc3e633c2a78f1..1a2abb3251e7bc3a8a3caa6e4d63b150141ecffd 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
@@ -74,7 +78,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;
 
        /**
         * Computes the outline rectangle of a label.