describe for Doxygen documentation

MarcAntoine-Arnaud · MarcAntoine-Arnaud · commit 73db17213533 · 2014-06-22T06:32:50.000-04:00
diff --git a/src/AvTranscoder/OutputStreamWriter.hpp b/src/AvTranscoder/OutputStreamWriter.hpp
@@ -21,22 +21,34 @@ class AvExport OutputStreamWriter
 {
 public:
 	OutputStreamWriter()
-	{
-	}
+	{}
 
+	/**
+	 * @brief Setup the encoder
+	 * @return status of setup
+	 */
 	virtual bool setup() = 0;
 
 	/**
-	 * @param[in]  sourceFrame
-	 * @param[out] codedFrame
+	 * @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)
+	 * @return status of encoding
 	 */
 	virtual bool encodeFrame( const Frame& sourceFrame, DataStream& codedFrame ) = 0;
 
 	/**
-	 * get delayed encoded frames
+	 * @brief Get delayed encoded frames
+	 * @param codedFrame data of the coded frame if present (first frames can be delayed)
+	 * @return status of encoding
 	 */
 	virtual bool encodeFrame( DataStream& codedFrame ) = 0;
 
+	/**
+	 * @brief Set the profile for the encoder
+	 * @note see Profile to get list of supported profiles
+	 * @param profile selected profile name
+	 */
 	virtual void setProfile( const std::string& profile ) = 0;
 
 };
