Improve documentation of SoundDecoder

[libs/al.git] / source / mp3decoder.h

diff --git a/source/mp3decoder.h b/source/mp3decoder.h
index 201d68f26e789f174041b08b3e0c97e2c8d0f1e2..01fba634de283196b860d8b2ea4f83db55f71652 100644 (file)
--- a/source/mp3decoder.h
+++ b/source/mp3decoder.h
@@ -18,6 +18,10 @@ private:
 };
 
 
+/**
+Decoder for MPEG-2 audio files, a.k.a. MP2 and MP3 files.  Normally you should
+use one of the SoundDecoder::open_* functions to create a decoder.
+*/
 class Mp3Decoder: public SoundDecoder
 {
 private: