StreamTranscoder: clean documentation of attributes

Clement Champetier · Clement Champetier · commit abe853e23213 · 2014-11-03T12:17:01.000+01:00
diff --git a/src/AvTranscoder/transcoder/StreamTranscoder.hpp b/src/AvTranscoder/transcoder/StreamTranscoder.hpp
@@ -94,28 +94,15 @@ class AvExport StreamTranscoder
 
 	ITransform* _transform;
 
-	int  _subStreamIndex;
+	int  _subStreamIndex;  ///< Index of channel that is processed from the input stream (-1 if no demultiplexing).
 
-	/**
-	 * @brief How many frame processed for this StreamTranscoder.
-	 */
-	size_t _frameProcessed;
-	/**
-	 * @brief Offset, in frame, at the beginning of the StreamTranscoder.
-	 */
-	size_t _offset;
-
-	bool _takeFromGenerator;
+	size_t _frameProcessed;  ///< How many frame processed for this StreamTranscoder.
+	size_t _offset;  ///< Offset, in frame, at the beginning of the StreamTranscoder.
 
+	bool _takeFromGenerator;  ///< Is the data processed are taken from a generator.
 	bool _verbose;
-
-	bool _offsetPassed;
-
-	/**
-	 * @brief Automatic switch to a generator
-	 * @note not applicable when rewrap
-	 */
-	bool _infinityStream;
+	bool _offsetPassed;  ///< Is the offset at the beginning of the stream is finished.
+	bool _infinityStream;  ///< Automatically switch to a generator at the end of the stream (not applicable when rewrap);
 };
 
 }
