use see

y-scope · Nov 7, 2024 · 119de6c · 119de6c
1 parent 72bdf6e
commit 119de6c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp b/src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp
@@ -60,6 +60,13 @@ class UnstructuredIrStreamReader : public StreamReader {
 
     void filter_log_events(LogLevelFilterTsType const& log_level_filter) override;
 
+    /**
+     * @see StreamReader::deserialize_stream
+     *
+     * After the stream has been exhausted, it will be deallocated.
+     *
+     * @return @see StreamReader::deserialize_stream
+     */
     [[nodiscard]] auto deserialize_stream() -> size_t override;
 
     [[nodiscard]] auto decode_range(size_t begin_idx, size_t end_idx, bool use_filter) const