Update src/clp_ffi_js/ir/LogEventWithFilterData.hpp

Co-authored-by: kirkrodrigues <[email protected]>
y-scope · Nov 10, 2024 · 3167111 · 3167111
1 parent 8ae1fa2
commit 3167111
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/clp_ffi_js/ir/LogEventWithFilterData.hpp b/src/clp_ffi_js/ir/LogEventWithFilterData.hpp
@@ -9,8 +9,10 @@
 
 namespace clp_ffi_js::ir {
 /**
- * A class which accepts a log event type as a template parameter and provides additional members
- * for the log level and timestamp. The additional members facilitate log level filtering.
+ * A templated class that extends a log event type with processed versions of some of its fields,
+ * specifically the fields that are used for filtering in the `StreamReader` classes and their
+ * callers.
+ *
  * @tparam LogEvent The type of the log event.
  */
 template <typename LogEvent>