From 402d51d25b8336c85154fa912e7dd1739fdfc55f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= <gustav@sornas.net>
Date: Sat, 19 Jun 2021 16:33:51 +0200
Subject: more doc

---
 mumd/src/audio/sound_effects.rs | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'mumd/src/audio/sound_effects.rs')

diff --git a/mumd/src/audio/sound_effects.rs b/mumd/src/audio/sound_effects.rs
index 49cb009..b6f41f1 100644
--- a/mumd/src/audio/sound_effects.rs
+++ b/mumd/src/audio/sound_effects.rs
@@ -15,6 +15,7 @@ use strum_macros::EnumIter;
 
 use crate::audio::SAMPLE_RATE;
 
+/// The different kinds of files we can open.
 enum AudioFileKind {
     Ogg,
     Wav,
@@ -32,11 +33,13 @@ impl TryFrom<&str> for AudioFileKind {
     }
 }
 
+/// A specification accompanying some audio data.
 struct AudioSpec {
     channels: u32,
     sample_rate: u32,
 }
 
+/// An event where a notification is shown and a sound effect is played.
 #[derive(Debug, Eq, PartialEq, Clone, Copy, Hash, EnumIter)]
 pub enum NotificationEvents {
     ServerConnect,
-- 
cgit v1.2.1