IInputEssence: add documentation

cchampet · cchampet · commit 492cd3863bbd · 2014-10-12T17:14:48.000+02:00
diff --git a/src/AvTranscoder/essenceStream/IInputEssence.hpp b/src/AvTranscoder/essenceStream/IInputEssence.hpp
@@ -11,10 +11,25 @@ class AvExport IInputEssence
 {
 public:
 	virtual ~IInputEssence() {};
-	
+
+	/**
+	 * @brief Setup the decoder
+	 */
 	virtual void setup() = 0;
 
+	/**
+	 * @brief Decode next frame
+	 * @param frameBuffer: the frame decoded
+	 * @return status of decoding
+	 */
 	virtual bool readNextFrame( Frame& frameBuffer ) = 0;
+
+	/**
+	 * @brief Decode substream of next frame
+	 * @param frameBuffer: the frame decoded
+	 * @param subStreamIndex: index of substream to extract
+	 * @return status of decoding
+	 */
 	virtual bool readNextFrame( Frame& frameBuffer, const size_t subStreamIndex ) = 0;
 };
 
