From f6717fc45188870341e9b6185ef5f3102f5a96ae Mon Sep 17 00:00:00 2001
From: Daniel Schadt <kingdread@gmx.de>
Date: Fri, 24 Jul 2020 14:09:51 +0200
Subject: more documentation

---
 src/analyzers/raids/mod.rs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/analyzers/raids/mod.rs')

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 }
     }
-- 
cgit v1.2.3