From: Joel Holdsworth <redacted>
Date: Fri, 17 Jan 2014 18:48:39 +0000 (+0000)
Subject: pv::view::View::set_zoom: Added doxygen comment
X-Git-Tag: pulseview-0.2.0~141
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=3925091ab254d42f1ce29ee0df042d343b4113e0;p=pulseview.git

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

diff --git a/pv/view/view.h b/pv/view/view.h
index 62157eed..06616376 100644
--- 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();