decoded data: added doc

Clement Champetier · Clement Champetier · commit ee005ba13aab · 2016-04-08T15:10:44.000+02:00
diff --git a/src/AvTranscoder/data/decoded/AudioFrame.hpp b/src/AvTranscoder/data/decoded/AudioFrame.hpp
@@ -66,6 +66,9 @@ class AvExport AudioFrame : public Frame
     void assign(const unsigned char* ptrValue);
 
 private:
+    /**
+     * @brief Allocate the audio buffer of the frame.
+     */
     void allocateAVSample(const AudioFrameDesc& ref);
 };
 }
diff --git a/src/AvTranscoder/data/decoded/Frame.hpp b/src/AvTranscoder/data/decoded/Frame.hpp
@@ -18,6 +18,7 @@ class AvExport Frame
 public:
     /**
      * @brief Allocate an empty frame.
+     * @warn This only allocates the AVFrame itself, not the data buffers.
      */
     Frame();
 
diff --git a/src/AvTranscoder/data/decoded/VideoFrame.hpp b/src/AvTranscoder/data/decoded/VideoFrame.hpp
@@ -66,6 +66,9 @@ class AvExport VideoFrame : public Frame
     void assign(const unsigned char* ptrValue);
 
 private:
+    /**
+     * @brief Allocate the image buffer of the frame.
+     */
     void allocateAVPicture(const VideoFrameDesc& desc);
 };
 }

Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,9 @@ class AvExport AudioFrame : public Frame`
`66`	`66`	`void assign(const unsigned char* ptrValue);`
`67`	`67`
`68`	`68`	`private:`
	`69`	`+ /**`
	`70`	`+ * @brief Allocate the audio buffer of the frame.`
	`71`	`+ */`
`69`	`72`	`void allocateAVSample(const AudioFrameDesc& ref);`
`70`	`73`	`};`
`71`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,9 @@ class AvExport VideoFrame : public Frame`
`66`	`66`	`void assign(const unsigned char* ptrValue);`
`67`	`67`
`68`	`68`	`private:`
	`69`	`+ /**`
	`70`	`+ * @brief Allocate the image buffer of the frame.`
	`71`	`+ */`
`69`	`72`	`void allocateAVPicture(const VideoFrameDesc& desc);`
`70`	`73`	`};`
`71`	`74`	`}`