/// </summary>
/// <privilege>
/// If you want to access only an internal storage,
- /// you should add privilege http://tizen.org/privilege/mediastorage. \n
+ /// you should add privilege http://tizen.org/privilege/mediastorage.<br/>
/// Or if you want to access only an external storage,
- /// you should add privilege http://tizen.org/privilege/externalstorage. \n
+ /// you should add privilege http://tizen.org/privilege/externalstorage.
/// </privilege>
+ /// <since_tizen> 3 </since_tizen>
public class MetadataEditor : IDisposable
{
private bool _disposed = false;
/// Writes the modified metadata to the media file.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// An internal error occurs.\n
- /// -or-\n
+ /// An internal error occurs.<br/>
+ /// -or-<br/>
/// The file is read-only.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
+ /// <since_tizen> 3 </since_tizen>
public void Commit()
{
if (_isFileReadOnly)
/// <returns>The artwork included in the media file.</returns>
/// <exception cref="InvalidOperationException">An internal error occurs.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="index"/> is less than zero.\n
- /// -or-\n
- /// <paramref name="index"/> is greater than or equal to <see cref="PictureCount"/>.\n
+ /// <paramref name="index"/> is less than zero.<br/>
+ /// -or-<br/>
+ /// <paramref name="index"/> is greater than or equal to <see cref="PictureCount"/>.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
public Artwork GetPicture(int index)
/// <since_tizen> 3 </since_tizen>
/// <param name="path">The path of the picture for adding to the metadata.</param>
/// <exception cref="InvalidOperationException">
- /// An internal error occurs.\n
- /// -or-\n
+ /// An internal error occurs.<br/>
+ /// -or-<br/>
/// The media file is read-only.
/// </exception>
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is null</exception>
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// <exception cref="FileNotFoundException">The file does not exist.</exception>
/// <exception cref="UnauthorizedAccessException">The caller does not have required privilege to access the file.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
/// <since_tizen> 3 </since_tizen>
/// <param name="index">The index of the picture to remove.</param>
/// <exception cref="InvalidOperationException">
- /// An internal error occurs.\n
- /// -or-\n
+ /// An internal error occurs.<br/>
+ /// -or-<br/>
/// The media file is read-only.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="index"/> is less than zero.\n
- /// -or-\n
- /// <paramref name="index"/> is greater than or equal to <see cref="PictureCount"/>.\n
+ /// <paramref name="index"/> is less than zero.<br/>
+ /// -or-<br/>
+ /// <paramref name="index"/> is greater than or equal to <see cref="PictureCount"/>.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
public void RemovePicture(int index)
Interop.MetadataEditor.RemovePicture(Handle, index).ThrowIfError("Failed to remove picture");
}
+ /// <summary>
+ /// Finalizes an instance of the MetadataEditor class.
+ /// </summary>
~MetadataEditor()
{
Dispose(false);
/// <param name="disposing">
/// true to release both managed and unmanaged resources; false to release only unmanaged resources.
/// </param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (!_disposed)
/// <summary>
/// Releases all resources used by the <see cref="MetadataEditor"/> object.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);