Generators: add documentation for attributes

Clement Champetier · Clement Champetier · commit 1c786365de8c · 2014-10-31T18:46:25.000+01:00
diff --git a/src/AvTranscoder/essenceStream/GeneratorAudio.hpp b/src/AvTranscoder/essenceStream/GeneratorAudio.hpp
@@ -24,8 +24,8 @@ class AvExport GeneratorAudio : public IInputEssence
 	bool readNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
 
 private:
-	const AudioCodec* _codec;
-	Frame*         _inputFrame;
+	const AudioCodec* _codec;  ///< Has link (no ownership)
+	Frame* _inputFrame;  ///< Has link (no ownership)
 	AudioFrameDesc _frameDesc;
 };
 
diff --git a/src/AvTranscoder/essenceStream/GeneratorVideo.hpp b/src/AvTranscoder/essenceStream/GeneratorVideo.hpp
@@ -25,8 +25,8 @@ class AvExport GeneratorVideo : public IInputEssence
 	bool readNextFrame( Frame& frameBuffer, const size_t subStreamIndex );
 
 private:
-	const VideoCodec* _codec;
-	Frame* _inputFrame;
+	const VideoCodec* _codec;  ///< Has link (no ownership)
+	Frame* _inputFrame;  ///< Has link (no ownership)
 	VideoFrameDesc _videoFrameDesc;
 
 	size_t         _numberOfView;
