From f61c7c36cb3592c1989aba71b0959f6477d6d8a9 Mon Sep 17 00:00:00 2001
From: Jose Celano <josecelano@gmail.com>
Date: Mon, 1 Jul 2024 13:05:11 +0100
Subject: [PATCH] docs: add commments to core::Tracker struct fields

---
 src/core/mod.rs | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/src/core/mod.rs b/src/core/mod.rs
index 4136966d..9a64826c 100644
--- a/src/core/mod.rs
+++ b/src/core/mod.rs
@@ -481,15 +481,26 @@ use crate::CurrentClock;
 /// > Typically, the `Tracker` is used by a higher application service that handles
 /// > the network layer.
 pub struct Tracker {
-    // The tracker configuration.
+    /// The tracker configuration.
     config: Core,
+
     /// A database driver implementation: [`Sqlite3`](crate::core::databases::sqlite)
     /// or [`MySQL`](crate::core::databases::mysql)
     database: Arc<Box<dyn Database>>,
+
+    /// Tracker users' keys. Only for private trackers.
     keys: tokio::sync::RwLock<std::collections::HashMap<Key, auth::ExpiringKey>>,
+
+    /// The list of allowed torrents. Only for listed trackers.
     whitelist: tokio::sync::RwLock<std::collections::HashSet<InfoHash>>,
+
+    /// The in-memory torrents repository.
     torrents: Arc<Torrents>,
+
+    /// Service to send stats events.
     stats_event_sender: Option<Box<dyn statistics::EventSender>>,
+
+    /// The in-memory stats repo.
     stats_repository: statistics::Repo,
 }