pv::view::View::set_zoom: Added doxygen comment

[pulseview.git] / pv / view / view.h

diff --git a/pv/view/view.h b/pv/view/view.h
index 62157eed76a5613e552571aa0a0e322be3a23c3a..06616376c96045447dcd81af766bf236f1d1e0a0 100644 (file)
--- a/pv/view/view.h
+++ b/pv/view/view.h
@@ -148,7 +148,13 @@ signals:
 
 private:
        void get_scroll_layout(double &length, double &offset) const;
-       
+
+       /**
+        * Simultaneously sets the zoom and offset.
+        * @param scale The scale to set the view to in seconds per pixel. This
+        * value is clamped between MinScale and MaxScale.
+        * @param offset The offset of the left edge of the view in seconds.
+        */
        void set_zoom(double scale, int offset);
 
        void update_scroll();