adding doxygen documentation

MarcAntoine-Arnaud · MarcAntoine-Arnaud · commit 5acd7feef319 · 2014-06-17T08:36:19.000-04:00
diff --git a/src/AvTranscoder/OutputFile.cpp b/src/AvTranscoder/OutputFile.cpp
@@ -18,13 +18,13 @@ extern "C" {
 namespace avtranscoder
 {
 
-OutputFile::OutputFile( const std::string& file )
+OutputFile::OutputFile( const std::string& filename )
 	: outputFormat  ( NULL )
 	, formatContext ( NULL )
 	, codec         ( NULL )
 	, codecContext  ( NULL )
 	, stream        ( NULL )
-	, filename      ( file )
+	, filename      ( filename )
 	, packetCount   ( 0 )
 {
 }
diff --git a/src/AvTranscoder/OutputFile.hpp b/src/AvTranscoder/OutputFile.hpp
@@ -18,22 +18,59 @@ class AVCodecContext;
 namespace avtranscoder
 {
 
+/**
+ * Outputfile is a simple C++ API to wrap and write medias.
+ * the default implentation use avformat wrapper frome the LibAV/FFMpeg 
+ * It can be overloaded to integrate custom wrapper.
+ **/
 class AvExport OutputFile
 {
 public:
-	OutputFile( const std::string& file = "" );
+	/**
+	 * @brief Open an output media file
+	 * @param filename resource to access
+	**/
+	OutputFile( const std::string& filename = "" );
 
 	virtual ~OutputFile(){};
 
+	/**
+	 * @brief Initialize the OutputFile, create format context to wrap essences into output file.
+	 * @note call this before adding streams using addVideoStream() or addAudioStream()
+	**/
 	virtual bool setup();
 
+	/**
+	 * @brief Add an video output stream using the description.
+	 * @note call setup() before adding any stream
+	 * @param videoDesc description of output stream
+	**/
 	virtual void addVideoStream( const VideoDesc& videoDesc );
+
+	/**
+	 * @brief Add an audio output stream using the description.
+	 * @note call setup() before adding any stream
+	 * @param audioDesc description of output stream
+	**/
 	virtual void addAudioStream( const AudioDesc& audioDesc );
 
+	/**
+	 * @brief Initialise the wrapping
+	 * @note this method write the header of file if necessary
+	**/
 	virtual bool beginWrap( );
 
+	/**
+	 * @brief Wrap a packet of data in the output ressource
+	 * @param data coded packet information for the current stream
+	 * @param streamId refers to the stream in output ressource
+	**/
 	virtual bool wrap( const DataStream& data, const size_t streamId );
 
+	/**
+	 * @brief Finalize the end of the wrapping
+	 * @note this method write the footer of file if necessary
+	**/
 	virtual bool endWrap( );
 
 private:

Original file line number	Diff line number	Diff line change
`@@ -18,13 +18,13 @@ extern "C" {`
`18`	`18`	`namespace avtranscoder`
`19`	`19`	`{`
`20`	`20`
`21`		`-OutputFile::OutputFile( const std::string& file )`
	`21`	`+OutputFile::OutputFile( const std::string& filename )`
`22`	`22`	`: outputFormat ( NULL )`
`23`	`23`	`, formatContext ( NULL )`
`24`	`24`	`, codec ( NULL )`
`25`	`25`	`, codecContext ( NULL )`
`26`	`26`	`, stream ( NULL )`
`27`		`- , filename ( file )`
	`27`	`+ , filename ( filename )`
`28`	`28`	`, packetCount ( 0 )`
`29`	`29`	`{`
`30`	`30`	`}`