Frame: added doc to copyData method

Clement Champetier · Clement Champetier · commit 4aaeefbc8bc0 · 2016-04-01T11:01:25.000+02:00
diff --git a/src/AvTranscoder/data/decoded/Frame.hpp b/src/AvTranscoder/data/decoded/Frame.hpp
@@ -43,8 +43,10 @@ class AvExport Frame
     int* getLineSize() const { return _frame->linesize; }
 
     /**
-    * @brief Copy the data of the given Frame.
-    */
+     * @brief Copy the data of the given Frame.
+     * @note This function does not allocate anything: the current frame must be already initialized and
+     * allocated with the same parameters as the given frame, to be ready for memcpy instructions.
+     */
     void copyData(const Frame& frameToRef);
 
     /**
