InputFile: add documentation

Clement Champetier · Clement Champetier · commit cae95e4d7563 · 2015-06-04T16:01:06.000+02:00
diff --git a/src/AvTranscoder/file/InputFile.hpp b/src/AvTranscoder/file/InputFile.hpp
@@ -60,11 +60,6 @@ class AvExport InputFile
          * @note Activate a stream results in buffered its data when processing
 	 **/
 	void activateStream( const size_t streamIndex, const bool activate = true );
-	
-	/**
-	 * @return Return the resource to access
-	**/
-	std::string getFilename() const { return _filename; }
 
 	/**
 	 * @brief Return media properties on the current InputFile.
@@ -80,8 +75,21 @@ class AvExport InputFile
 	 **/
 	InputStream& getStream( size_t index );
 
+	std::string getFilename() const { return _filename; }
+
+	/**
+	 * @brief A comma separated list of short names for the format, or unknown.
+	 */
 	std::string getFormatName() const;
+
+	/**
+	 * @brief Descriptive name for the format, meant to be more human-readable than name, or unknown.
+	 */
 	std::string getFormatLongName() const;
+
+	/**
+	 * @brief Comma-separated list of mime types, or unknown.
+	 */
 	std::string getFormatMimeType() const;
 
 	FormatContext& getFormatContext() { return _formatContext; }
