AvInputVideo / Audio: add documentation for attributes

Clement Champetier · Clement Champetier · commit f3989c05ffa7 · 2014-11-03T12:17:01.000+01:00
diff --git a/src/AvTranscoder/essenceStream/AvInputAudio.hpp b/src/AvTranscoder/essenceStream/AvInputAudio.hpp
@@ -25,11 +25,11 @@ class AvExport AvInputAudio : public IInputEssence
 private:
 	bool decodeNextFrame();
 
-	AvInputStream*     _inputStream;
-	AudioCodec _codec;
-	AVFrame*           _frame;
+	AvInputStream* _inputStream;  ///< Stream from which we read next frames
+	AudioCodec _codec;  ///< Audio decoder
+	AVFrame* _frame;  ///< Libav object to store decoded data
 
-	int                _selectedStream;
+	int _selectedStream;  ///< Index of the selected stream in the input file
 };
 
 }
diff --git a/src/AvTranscoder/essenceStream/AvInputVideo.hpp b/src/AvTranscoder/essenceStream/AvInputVideo.hpp
@@ -28,11 +28,12 @@ class AvExport AvInputVideo : public IInputEssence
 	void setProfile( const Profile::ProfileDesc& desc );
 	
 private:
-	AvInputStream*     _inputStream;
-	VideoCodec _codec;
-	AVFrame*           _frame;
 
-	int                _selectedStream;
+	AvInputStream* _inputStream;  ///< Stream from which we read next frames
+	VideoCodec _codec;  ///< Video decoder
+	AVFrame* _frame;  ///< Libav object to store decoded data
+
+	int _selectedStream;  ///< Index of the selected stream in the input file
 };
 
 }
