stating documentation, describe InputFile

MarcAntoine-Arnaud · MarcAntoine-Arnaud · commit ca6d8d26b1ac · 2014-06-17T05:35:48.000-04:00
diff --git a/doc/code/Doxyfile b/doc/code/Doxyfile
@@ -168,7 +168,7 @@ IGNORE_PREFIX          =
 GENERATE_HTML          = YES
 HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html
-HTML_HEADER            = 
+HTML_HEADER            =
 HTML_FOOTER            = 
 HTML_STYLESHEET        = 
 HTML_ALIGN_MEMBERS     = YES
@@ -182,6 +182,9 @@ DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 4
 GENERATE_TREEVIEW      = YES
 TREEVIEW_WIDTH         = 250
+HTML_COLORSTYLE_HUE    = 100
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
diff --git a/src/AvTranscoder/InputFile.hpp b/src/AvTranscoder/InputFile.hpp
@@ -22,33 +22,80 @@ namespace avtranscoder
 class AvExport InputFile
 {
 public:
+	/**
+	 * @brief Open a media file
+	 * @param filename resource to access
+	 * \exception runtime_error launched if unable to open file
+	**/
 	InputFile( const std::string& filename );
+
 	~InputFile();
 
+	/**
+	 * @return Return the resource to access
+	**/
 	std::string getFilename() const { return m_filename; }
 
-	// *** Metadatas section ***
-	// run the analyse on the file after a setup.
+	/**
+	 * @brief Run the analyse on the file after a setup.
+	 *        call this function before getProperties().
+	 **/
 	InputFile& analyse();
 	
-	/// get file properties
+	/**
+	 * @brief Return media properties on the current InputFile.
+	 * @note require to launch analyse() before to fill the property struture
+	 * @return structure of media metadatas
+	 **/
 	const Properties& getProperties() const { return m_properties; }
 
 	void getProperties( Properties& properties ) const { properties = m_properties; }
 
+	/**
+	 * @brief Get media file properties using static method.
+	 * @return structure of media metadatas
+	 **/
 	static Properties analyseFile( const std::string& filename );
 
+	/**
+	 * @brief Get stream type: video, audio, subtitle, etc.
+	 * @param index stream index
+	 * @return media stream type of specified index stream
+	 **/
 	AVMediaType getStreamType( size_t index );
 
+	/**
+	 * @brief Get stream type: video, audio, subtitle, etc.
+	 * @param index stream index
+	 * @return media stream type of specified index stream
+	 **/
 	AvInputStream& getStream( size_t index );
 
+	/**
+	 * @brief Get LibAV/FFmpeg AVFormatContext
+	 * @return format context on current InputFile
+	 **/
 	AVFormatContext& getFormatContext() const { return *m_formatContext; }
 
+	/**
+	 * @brief Read the next packet for the specified stream
+	 * @note For performances, each readed stream needs to be bufferized using the readStream() method.
+	 * @return if next packet was succefully readed
+	 **/
 	bool readNextPacket( const size_t streamIndex );
 
+	/**
+	 * @brief Seek input stream at specified frame
+	 * @note clean also buffers in each InputStream
+	 * @return if next packet was succefully readed
+	 **/
 	void seekAtFrame( const size_t frame );
 
-	/// @brief Indicate that the stream should be bufferized
+	/** 
+	 * @brief Indicate that the stream should be bufferized
+	 * @param streamIndex index of the stream need to be read 
+	 * @param readStream specify if the stream need to be buffurized 
+	 **/
 	void readStream( const size_t streamIndex, const bool readStream = true );
 
 protected:
