aboutsummaryrefslogtreecommitdiff
path: root/src/analyzers/raids/mod.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/analyzers/raids/mod.rs')
-rw-r--r--src/analyzers/raids/mod.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/analyzers/raids/mod.rs b/src/analyzers/raids/mod.rs
index 39fb823..bb3824b 100644
--- a/src/analyzers/raids/mod.rs
+++ b/src/analyzers/raids/mod.rs
@@ -36,6 +36,10 @@ pub struct GenericRaid<'log> {
}
impl<'log> GenericRaid<'log> {
+ /// Create a new [`GenericRaid`] analyzer for the given log.
+ ///
+ /// **Do not** use this method unless you know what you are doing. Instead, rely on
+ /// [`Log::analyzer`]!
pub fn new(log: &'log Log) -> Self {
GenericRaid { log }
}