From 58fbf8b7fe051cef6ce668a80d560e4c6e6d06bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= <joakim.frostegard@gmail.com>
Date: Wed, 8 Apr 2020 21:50:23 +0200
Subject: [PATCH] aquatic: add comments to many config fields

---
 aquatic/src/lib/config.rs | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/aquatic/src/lib/config.rs b/aquatic/src/lib/config.rs
index fbc62a3..5a67152 100644
--- a/aquatic/src/lib/config.rs
+++ b/aquatic/src/lib/config.rs
@@ -3,6 +3,7 @@ use std::net::SocketAddr;
 
 #[derive(Clone)]
 pub struct Config {
+    /// Spawn this number of threads for workers
     pub num_threads: usize,
     pub network: NetworkConfig,
     pub statistics: StatisticsConfig,
@@ -12,11 +13,15 @@ pub struct Config {
 
 #[derive(Clone)]
 pub struct NetworkConfig {
+    /// Bind to this address
     pub address: SocketAddr,
+    /// Maximum number of torrents to accept in scrape request
     pub max_scrape_torrents: u8,
+    /// Maximum number of peers to return in announce response
     pub max_response_peers: usize,
+    /// Ask peers to announce this often (seconds)
     pub peer_announce_interval: i32,
-    /// When value is zero, use OS default (don't set on socket)
+    /// Setting on socket. When value is zero, don't set (use OS default)
     pub recv_buffer_size: usize,
     pub poll_event_capacity: usize,
 }
@@ -24,14 +29,18 @@ pub struct NetworkConfig {
 
 #[derive(Clone)]
 pub struct StatisticsConfig {
+    /// Print statistics this often (seconds). Don't print when set to zero.
     pub interval: u64,
 }
 
 
 #[derive(Clone)]
 pub struct CleaningConfig {
+    /// Clean torrents and connections this often (seconds)
     pub interval: u64,
+    /// Remove peers that haven't announced for this long (seconds)
     pub max_peer_age: u64,
+    /// Remove connections that are older than this (seconds)
     pub max_connection_age: u64,
 }