From 28c22ffad712eb3a2ab9d47a8cfccff006027624 Mon Sep 17 00:00:00 2001
From: Antoine Martin <antoine97.martin@gmail.com>
Date: Tue, 2 Feb 2021 06:39:05 +0100
Subject: [PATCH] document configuration

---
 src/main.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/main.rs b/src/main.rs
index 74233d4..dfaaf79 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -57,6 +57,7 @@ impl EventEmitter for AutoJoinBot {
             }
         }
     }
+
     async fn on_stripped_state_member(
         &self,
         room: RoomState,
@@ -169,11 +170,16 @@ struct Opts {
     config: PathBuf,
 }
 
+/// Holds the configuration for the bot.
 #[derive(Deserialize)]
 struct Config {
+    /// The URL for the homeserver we should connect to
     homeserver: Url,
+    /// The bot's account username
     username: String,
+    /// The bot's account password
     password: String,
+    /// Path to a directory where the bot will store Matrix state and current session information.
     state_dir: PathBuf,
 }