From 7ec392eda3345606f0de75a432954b221cee82ce Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Wed, 13 Nov 2024 15:40:01 +0100
Subject: add doxygen + check const correctness

---
 src/crepe/facade/Sound.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src/crepe/facade/Sound.h')

diff --git a/src/crepe/facade/Sound.h b/src/crepe/facade/Sound.h
index 183bd7c..402482f 100644
--- a/src/crepe/facade/Sound.h
+++ b/src/crepe/facade/Sound.h
@@ -8,6 +8,12 @@
 
 namespace crepe {
 
+/**
+ * \brief Sound resource facade
+ *
+ * This class is a wrapper around a \c SoLoud::Wav instance, which holds a
+ * single sample. It is part of the sound facade.
+ */
 class Sound {
 public:
 	/**
-- 
cgit v1.2.3