Improve documentation of SoundDecoder

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

diff --git a/source/oggdecoder.h b/source/oggdecoder.h
index 3bf33b8bec32b8440ce0feef9df96afd9039d129..e194736a40207a09710fccec8ce37a72d4b512cc 100644 (file)
--- a/source/oggdecoder.h
+++ b/source/oggdecoder.h
@@ -18,6 +18,10 @@ private:
 };
 
 
+/**
+Decoder for Ogg Vorbis files.  Normally you should use one of the
+SoundDecoder::open_* functions to create a decoder.
+*/
 class OggDecoder: public SoundDecoder
 {
 private: