Documented scale, offset, set_scale_offset, _scale and _offset in pv::view::View

diff --git a/pv/view/view.h b/pv/view/view.h
index 6e5710fede733d2aa926236048d94247984dbd99..ac2835a49cb4b6157075741d436c6708bd165727 100644 (file)
--- a/pv/view/view.h
+++ b/pv/view/view.h
@@ -55,13 +55,26 @@ public:
 
        SigSession& session();
 
+       /**
+        * Returns the view time scale in seconds per pixel.
+        */
        double scale() const;
+
+       /**
+        * Returns the time offset of the left edge of the view in
+        * seconds.
+        */
        double offset() const;
        int v_offset() const;
 
        void zoom(double steps);
        void zoom(double steps, int offset);
 
+       /**
+        * Sets the scale and offset.
+        * @param scale The new view scale in seconds per pixel.
+        * @param offset The view time offset in seconds.
+        */
        void set_scale_offset(double scale, double offset);
 
        const QPoint& hover_point() const;
@@ -97,7 +110,10 @@ private:
 
        uint64_t _data_length;
 
+       /// The view time scale in seconds per pixel.
        double _scale;
+
+       /// The view time offset in seconds.
        double _offset;
 
        int _v_offset;