AudioFrameDesc: add documentation

Clement Champetier · Clement Champetier · commit 8dafd79417be · 2015-01-19T14:37:48.000+01:00
diff --git a/src/AvTranscoder/frame/AudioFrame.hpp b/src/AvTranscoder/frame/AudioFrame.hpp
@@ -17,12 +17,18 @@ namespace avtranscoder
 class AvExport AudioFrameDesc
 {
 public:
+	/**
+	 * @warning FPS value is set to 25 by default
+	 */
 	AudioFrameDesc( const size_t sampleRate = 0, const size_t channels = 0, const AVSampleFormat sampleFormat = AV_SAMPLE_FMT_NONE )
 		: _sampleRate( sampleRate )
 		, _channels( channels )
 		, _sampleFormat( sampleFormat )
 		, _fps( 25. )
 	{}
+	/**
+	 * @warning FPS value is set to 25 by default
+	 */
 	AudioFrameDesc( const size_t sampleRate, const size_t channels, const std::string& sampleFormat )
 		: _sampleRate( sampleRate )
 		, _channels( channels )
