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/strikes.rs | |
| parent | 06590a174a4b3707b9048f3669ad17702902b601 (diff) | |
| download | evtclib-f6717fc45188870341e9b6185ef5f3102f5a96ae.tar.gz evtclib-f6717fc45188870341e9b6185ef5f3102f5a96ae.tar.bz2 evtclib-f6717fc45188870341e9b6185ef5f3102f5a96ae.zip | |
more documentation
Diffstat (limited to 'src/analyzers/strikes.rs')
| -rw-r--r-- | src/analyzers/strikes.rs | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/analyzers/strikes.rs b/src/analyzers/strikes.rs index 82fcd79..8c22c49 100644 --- a/src/analyzers/strikes.rs +++ b/src/analyzers/strikes.rs @@ -4,12 +4,20 @@ use crate::{ Log, }; +/// Analyzer for strikes. +/// +/// Since there are currently no strikes requiring special logic, this analyzer is used for all +/// strike missions. #[derive(Debug, Clone, Copy)] pub struct GenericStrike<'log> { log: &'log Log, } impl<'log> GenericStrike<'log> { + /// Create a new [`GenericStrike`] 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 { GenericStrike { log } } |