From 2aafe6967e38851d56f747cb3e615da7e9fa9bf1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= <gustav@sornas.net>
Date: Tue, 8 Jun 2021 09:46:59 +0200
Subject: doc

---
 mumlib/src/command.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'mumlib')

diff --git a/mumlib/src/command.rs b/mumlib/src/command.rs
index 818fd70..fff921a 100644
--- a/mumlib/src/command.rs
+++ b/mumlib/src/command.rs
@@ -4,6 +4,7 @@ use chrono::NaiveDateTime;
 use serde::{Deserialize, Serialize};
 use std::fmt;
 
+/// Something that happened in our channel at a point in time.
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct MumbleEvent {
     pub timestamp: NaiveDateTime,
@@ -16,12 +17,12 @@ impl fmt::Display for MumbleEvent {
     }
 }
 
+/// The different kinds of events that can happen.
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub enum MumbleEventKind {
     UserConnected(String, Option<String>),
     UserDisconnected(String, Option<String>),
-    /// This logic is kinda weird so we only store the rendered message.
-    UserMuteStateChanged(String),
+    UserMuteStateChanged(String),  // This logic is kinda weird so we only store the rendered message.
     TextMessageReceived(String),
     UserJoinedChannel(String, String),
     UserLeftChannel(String, String),
-- 
cgit v1.2.1