IDecoder: added doc to decodeNextFrame method

Clement Champetier · Clement Champetier · commit e89e84b407bc · 2016-04-08T15:31:57.000+02:00
diff --git a/src/AvTranscoder/decoder/IDecoder.hpp b/src/AvTranscoder/decoder/IDecoder.hpp
@@ -23,6 +23,9 @@ class AvExport IDecoder
     /**
      * @brief Decode next frame
      * @param frameBuffer: the frame decoded
+     * @warn the frameBuffer reference belongs to the decoder and is valid only until the
+     * next call to this function or until closing or flushing the
+     * decoder. The caller may not write to it.
      * @return status of decoding
      */
     virtual bool decodeNextFrame(Frame& frameBuffer) = 0;
