diff options
author | Daniel Schadt <kingdread@gmx.de> | 2020-07-24 14:09:51 +0200 |
---|---|---|
committer | Daniel Schadt <kingdread@gmx.de> | 2020-07-24 14:09:51 +0200 |
commit | f6717fc45188870341e9b6185ef5f3102f5a96ae (patch) | |
tree | 8f64fe7372de4e9254c68db54fcc1969db951052 /src/analyzers/raids/mod.rs | |
parent | 06590a174a4b3707b9048f3669ad17702902b601 (diff) | |
download | evtclib-f6717fc45188870341e9b6185ef5f3102f5a96ae.tar.gz evtclib-f6717fc45188870341e9b6185ef5f3102f5a96ae.tar.bz2 evtclib-f6717fc45188870341e9b6185ef5f3102f5a96ae.zip |
more documentation
Diffstat (limited to 'src/analyzers/raids/mod.rs')
-rw-r--r-- | src/analyzers/raids/mod.rs | 4 |
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 } } |