Merge remote-tracking branch 'origin/master' into niels/sorting_rendering

1 files changed, 15 insertions, 12 deletions

diff --git a/src/crepe/facade/Sound.h b/src/crepe/facade/Sound.h
index 183bd7c..32b6478 100644
--- a/src/crepe/facade/Sound.h
+++ b/src/crepe/facade/Sound.h
@@ -8,34 +8,37 @@
 
 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:
 	/**
 	 * \brief Pause this sample
 	 *
-	 * Pauses this sound if it is playing, or does nothing if it is already
-	 * paused. The playhead position is saved, such that calling \c play() after
-	 * this function makes the sound resume.
+	 * Pauses this sound if it is playing, or does nothing if it is already paused. The playhead
+	 * position is saved, such that calling \c play() after this function makes the sound resume.
 	 */
 	void pause();
 	/**
 	 * \brief Play this sample
 	 *
-	 * Resume playback if this sound is paused, or start from the beginning of
-	 * the sample.
+	 * Resume playback if this sound is paused, or start from the beginning of the sample.
 	 *
-	 * \note This class only saves a reference to the most recent 'voice' of this
-	 * sound. Calling \c play() while the sound is already playing causes
-	 * multiple instances of the sample to play simultaniously. The sample
-	 * started last is the one that is controlled afterwards.
+	 * \note This class only saves a reference to the most recent 'voice' of this sound. Calling
+	 * \c play() while the sound is already playing causes multiple instances of the sample to
+	 * play simultaniously. The sample started last is the one that is controlled afterwards.
 	 */
 	void play();
 	/**
 	 * \brief Reset playhead position
 	 * 
-	 * Resets the playhead position so that calling \c play() after this function
-	 * makes it play from the start of the sample. If the sound is not paused
-	 * before calling this function, this function will stop playback.
+	 * Resets the playhead position so that calling \c play() after this function makes it play
+	 * from the start of the sample. If the sound is not paused before calling this function,
+	 * this function will stop playback.
 	 */
 	void rewind();
 	/**