AudioFrame: add doc to warn about setNbSamplesPerChannel method

Clement Champetier · Clement Champetier · commit b460fceb58be · 2016-10-28T11:59:05.000+02:00
diff --git a/src/AvTranscoder/data/decoded/AudioFrame.hpp b/src/AvTranscoder/data/decoded/AudioFrame.hpp
@@ -56,6 +56,10 @@ class AvExport AudioFrame : public IFrame
 
     size_t getSize() const;
 
+    /**
+     * @brief This methods dynamically updates the size that the data buffer would occupy if allocated.
+     * @warning If the data buffer is already allocated, this could lead to memory leaks or seg fault.
+     */
     void setNbSamplesPerChannel(const size_t nbSamples) { _frame->nb_samples = nbSamples; }
 
     void assignBuffer(const unsigned char* ptrValue);
