OutputFile: add documentation

Clement Champetier · Clement Champetier · commit c5fcc6894f40 · 2015-06-04T16:02:12.000+02:00
diff --git a/src/AvTranscoder/file/OutputFile.hpp b/src/AvTranscoder/file/OutputFile.hpp
@@ -55,8 +55,20 @@ class AvExport OutputFile : public IOutputFile
 	IOutputStream& getStream( const size_t streamId );
 
 	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; }
