From: Soeren Apel <soeren@apelpie.net>
Date: Thu, 14 Jun 2018 19:42:13 +0000 (+0200)
Subject: Fix comment
X-Git-Url: http://git.code-monkey.de/?p=pulseview.git;a=commitdiff_plain;h=4caaaacee32e9a8145968891eb9cd9225260530f

Fix comment
---

diff --git a/pv/data/decode/rowdata.hpp b/pv/data/decode/rowdata.hpp
index 07cc41b..f2c6793 100644
--- a/pv/data/decode/rowdata.hpp
+++ b/pv/data/decode/rowdata.hpp
@@ -41,7 +41,9 @@ public:
 	uint64_t get_max_sample() const;
 
 	/**
-	 * Extracts sorted annotations between two period into a vector.
+	 * Extracts annotations between the given sample range into a vector.
+	 * Note: The annotations are unsorted and only annotations that fully
+	 * fit into the sample range are considered.
 	 */
 	void get_annotation_subset(
 		vector<pv::data::decode::Annotation> &dest,
diff --git a/pv/data/decodesignal.hpp b/pv/data/decodesignal.hpp
index 2d41e50..4a1e7f0 100644
--- a/pv/data/decodesignal.hpp
+++ b/pv/data/decodesignal.hpp
@@ -125,7 +125,9 @@ public:
 	vector<decode::Row> visible_rows() const;
 
 	/**
-	 * Extracts sorted annotations between two period into a vector.
+	 * Extracts annotations between the given sample range into a vector.
+	 * Note: The annotations are unsorted and only annotations that fully
+	 * fit into the sample range are considered.
 	 */
 	void get_annotation_subset(
 		vector<pv::data::decode::Annotation> &dest,