X-Git-Url: http://git.code-monkey.de/?a=blobdiff_plain;f=pv%2Fviews%2Ftrace%2Fruler.hpp;h=0c614c6c8bad27360b4cca6ada99dbe91320d709;hb=ffc00fdd5946593ad2a587078fd4ee9ba0a507ec;hp=661254a7280ebd3ce31d0aaac696db9cdc761031;hpb=873e80357d9622678069fcfe83b010717a68284c;p=pulseview.git

diff --git a/pv/views/trace/ruler.hpp b/pv/views/trace/ruler.hpp
index 661254a..0c614c6 100644
--- 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
@@ -152,7 +157,7 @@ private:
 	 * Calculates the major and minor tick positions.
 	 *
 	 * @param major_period The period between the major ticks.
-	 * @param offset The time at the left border of the ruler.
+	 * @param offset The virtual time at the left border of the ruler.
 	 * @param scale The scale in seconds per pixel.
 	 * @param width the Width of the ruler.
 	 * @param format_function A function used to format the major tick times.