Fix comment
[pulseview.git] / pv / data / decode / rowdata.hpp
index 21543c5c1141a9e95ecbd9513d90a6145f21d8cf..f2c6793bbbb789c286aa5e90b3519ddad8753a2c 100644 (file)
@@ -22,6 +22,8 @@
 
 #include <vector>
 
+#include <libsigrokdecode/libsigrokdecode.h>
+
 #include "annotation.hpp"
 
 using std::vector;
@@ -39,20 +41,22 @@ 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,
                uint64_t start_sample, uint64_t end_sample) const;
 
-       void push_annotation(const Annotation &a);
+       void emplace_annotation(srd_proto_data *pdata);
 
 private:
        vector<Annotation> annotations_;
 };
 
-}
-} // data
-} // pv
+}  // namespace decode
+}  // namespace data
+}  // namespace pv
 
 #endif // PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP