FileProperties: add exception documentation about the getStreamPropertiesWithIndex method

valnoel · valnoel · commit 2e7d79110de9 · 2015-05-04T17:01:05.000+02:00
diff --git a/src/AvTranscoder/mediaProperty/FileProperties.hpp b/src/AvTranscoder/mediaProperty/FileProperties.hpp
@@ -62,6 +62,7 @@ class AvExport FileProperties
 
 	//@{
 	// @brief Get the properties at the indicated stream index
+	// @throws A runtime error if the streamIndex does not match any stream
 	const avtranscoder::StreamProperties& getStreamPropertiesWithIndex( const size_t streamIndex ) const;
 	//@}
 
