Trace View: Add doxygen comments to some classes

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

diff --git a/pv/views/trace/ruler.hpp b/pv/views/trace/ruler.hpp
index 40aae48daa3faed09cb258b49f02599d5f942e02..e9432bd6d4208fe66489a9d1ad9963947e88467e 100644 (file)
--- a/pv/views/trace/ruler.hpp
+++ b/pv/views/trace/ruler.hpp
@@ -46,6 +46,11 @@ namespace trace {
 class TimeItem;
 class ViewItem;
 
+/**
+ * The Ruler class manages and displays the time scale above the trace canvas.
+ * It may also contain @ref TimeItem instances used to identify or highlight
+ * time-related information.
+ */
 class Ruler : public MarginWidget
 {
        Q_OBJECT
@@ -171,7 +176,7 @@ protected:
        void resizeEvent(QResizeEvent*) override;
 
 private Q_SLOTS:
-       void hover_point_changed();
+       void hover_point_changed(const QPoint &hp);
 
        // Resets the 'tick_position_cache_'.
        void invalidate_tick_position_cache();