Fix comment

diff --git a/pv/data/decode/rowdata.hpp b/pv/data/decode/rowdata.hpp
index 07cc41bf3eb1f8febf04c06595d8da2f142eb7da..f2c6793bbbb789c286aa5e90b3519ddad8753a2c 100644 (file)
--- a/pv/data/decode/rowdata.hpp
+++ b/pv/data/decode/rowdata.hpp
@@ -41,7 +41,9 @@ public:
        uint64_t get_max_sample() const;
 
        /**
        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,
         */
        void get_annotation_subset(
                vector<pv::data::decode::Annotation> &dest,

diff --git a/pv/data/decodesignal.hpp b/pv/data/decodesignal.hpp
index 2d41e5003e57c391d492e80430b380cb22df2fc7..4a1e7f005c671a3bf553a42c407b0eee4fc327a2 100644 (file)
--- a/pv/data/decodesignal.hpp
+++ b/pv/data/decodesignal.hpp
@@ -125,7 +125,9 @@ public:
        vector<decode::Row> visible_rows() const;
 
        /**
        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,
         */
        void get_annotation_subset(
                vector<pv::data::decode::Annotation> &dest,