From: Tilman Sauerbeck <redacted>
Date: Mon, 9 Nov 2015 17:33:42 +0000 (+0100)
Subject: Session: document the purpose of sampling_mutex_.
X-Git-Tag: pulseview-0.3.0~40
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=8f6b98ff56c68f59c177f4dd662160bc48e1693f;p=pulseview.git

Session: document the purpose of sampling_mutex_.
---

diff --git a/pv/session.hpp b/pv/session.hpp
index f2f8c7c8..ac3d654c 100644
--- a/pv/session.hpp
+++ b/pv/session.hpp
@@ -163,7 +163,7 @@ private:
 
 	std::vector< std::shared_ptr<view::DecodeTrace> > decode_traces_;
 
-	mutable std::mutex sampling_mutex_;
+	mutable std::mutex sampling_mutex_; //!< Protects access to capture_state_.
 	capture_state capture_state_;
 
 	mutable boost::shared_mutex signals_mutex_;