IEncoder: updated doc of encodeFrame methods

Clement Champetier · Clement Champetier · commit 1f1279552c02 · 2016-04-21T14:26:30.000+02:00
diff --git a/src/AvTranscoder/encoder/IEncoder.hpp b/src/AvTranscoder/encoder/IEncoder.hpp
@@ -23,16 +23,18 @@ class AvExport IEncoder
 
     /**
      * @brief Encode a new frame, and get coded frame
-     * @param sourceFrame frame need to be encoded
-     * @param codedFrame data of the coded frame if present (first frames can be delayed)
+     * @param sourceFrame: frame that needs to be encoded
+     * @param codedFrame: output encoded coded data (first frames can be delayed)
      * @return status of encoding
+     * @throw runtime_error if the encoded process failed.
      */
     virtual bool encodeFrame(const Frame& sourceFrame, CodedData& codedFrame) = 0;
 
     /**
      * @brief Get delayed encoded frames
-     * @param codedFrame data of the coded frame if present (first frames can be delayed)
+     * @param codedFrame: output encoded coded data of last frames
      * @return status of encoding
+     * @throw runtime_error if the encoded process failed.
      */
     virtual bool encodeFrame(CodedData& codedFrame) = 0;
 
