From d286b51cde81fe36697f6caa5f11c4b1933550e1 Mon Sep 17 00:00:00 2001
From: Julian Ospald <hasufell@posteo.de>
Date: Fri, 14 Jul 2017 17:23:42 +0200
Subject: [PATCH] Start documentation

---
 src/alsa_card.rs    | 7 +++++++
 src/support_alsa.rs | 7 +++++++
 2 files changed, 14 insertions(+)

diff --git a/src/alsa_card.rs b/src/alsa_card.rs
index 9e3e47216..bf96f4a34 100644
--- a/src/alsa_card.rs
+++ b/src/alsa_card.rs
@@ -1,3 +1,10 @@
+//! Alsa audio subsystem.
+//!
+//! This mod mainly defines the `AlsaCard` struct, which is the only data
+//! structure interacting directly with the alsa library.
+//! No other struct should directly interact with the alsa bindings.
+
+
 use alsa::card::Card;
 use alsa::mixer::SelemChannelId::*;
 use alsa::mixer::{Mixer, Selem, SelemId};
diff --git a/src/support_alsa.rs b/src/support_alsa.rs
index 1fb85c95a..a4e30f7ba 100644
--- a/src/support_alsa.rs
+++ b/src/support_alsa.rs
@@ -1,3 +1,10 @@
+//! Alsa audio helper functions.
+//!
+//! This mod wraps around a few low-level alsa functions and abstracts
+//! out the details we don't care about. Mainly used by the
+//! [alsa_card mod](./alsa_card.html).
+
+
 use alsa::card::Card;
 use alsa::mixer::{Mixer, Selem, SelemId, Elem};
 use alsa;