AvInputStream: add documentation for attributes

Clement Champetier · Clement Champetier · commit 9872976ac11f · 2014-11-03T12:17:01.000+01:00
diff --git a/src/AvTranscoder/codedStream/AvInputStream.hpp b/src/AvTranscoder/codedStream/AvInputStream.hpp
@@ -42,13 +42,13 @@ class AvExport AvInputStream : public IInputStream
 	AVStream* getAVStream() const;
 
 private:
-	InputFile*       _inputFile;
-	std::vector<CodedData> _streamCache;
-
+	InputFile* _inputFile;  ///< Has link (no ownership)
 	ICodec* _codec;  ///< Has ownership
 
-	size_t           _streamIndex;
-	bool             _bufferized;
+	std::vector<CodedData> _streamCache;
+
+	size_t _streamIndex;  ///<  Index of the stream in the input file
+	bool _bufferized;  ///< If the stream is bufferized
 };
 
 }
