From 75f5ce065efb6a186570b365c88e564871915d76 Mon Sep 17 00:00:00 2001
From: Daniel Schadt <kingdread@gmx.de>
Date: Thu, 23 Jul 2020 17:57:59 +0200
Subject: more documentation & adjustments

---
 src/analyzers/raids/mod.rs | 11 +++++++++++
 src/analyzers/raids/w7.rs  |  1 +
 2 files changed, 12 insertions(+)

(limited to 'src/analyzers/raids')

diff --git a/src/analyzers/raids/mod.rs b/src/analyzers/raids/mod.rs
index 33d54ce..39fb823 100644
--- a/src/analyzers/raids/mod.rs
+++ b/src/analyzers/raids/mod.rs
@@ -1,3 +1,9 @@
+//! Analyzers for raid logs.
+//!
+//! Most of the fights can use the [`GenericRaid`][GenericRaid] analyzer. The exception to this are
+//! fights which have a Challenge Mote (Wing 4, Wing 5, Wing 6, Wing 7), and fights which need to
+//! use a different method to determine their outcome (Xera, Deimos, Soulless Horror, Conjured
+//! Amalgamate, Qadim).
 use crate::{
     analyzers::{helpers, Analyzer, Outcome},
     Log,
@@ -19,6 +25,11 @@ mod w7;
 pub use w7::{CardinalAdina, CardinalSabir, QadimThePeerless};
 
 /// A generic raid analyzer that works for bosses without special interactions.
+///
+/// This analyzer always returns `false` for the Challenge Mote calculation.
+///
+/// The outcome of the fight is determined by whether the boss agent has a death event - which
+/// works for a lot of fights, but not all of them.
 #[derive(Debug, Clone, Copy)]
 pub struct GenericRaid<'log> {
     log: &'log Log,
diff --git a/src/analyzers/raids/w7.rs b/src/analyzers/raids/w7.rs
index 54073a3..480c303 100644
--- a/src/analyzers/raids/w7.rs
+++ b/src/analyzers/raids/w7.rs
@@ -70,6 +70,7 @@ impl<'log> Analyzer for CardinalSabir<'log> {
 
 pub const QADIMP_CM_HEALTH: u64 = 51_000_000;
 
+/// Analyzer for the final fight of Wing 7, Qadim The Peerless.
 #[derive(Debug, Clone, Copy)]
 pub struct QadimThePeerless<'log> {
     log: &'log Log,
-- 
cgit v1.2.3