Setting since_tizen 3/4 on Tizen.NET API

[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia.Metadata / MetadataEditor / MetadataEditor.cs

diff --git a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
old mode 100755 (executable)
new mode 100644 (file)
index 9510cb3..e7d01b0
--- a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
+++ b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
@@ -25,10 +25,11 @@ namespace Tizen.Multimedia
     /// </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;
@@ -358,11 +359,12 @@ namespace Tizen.Multimedia
         /// 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)
@@ -381,9 +383,9 @@ namespace Tizen.Multimedia
         /// <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)
@@ -438,11 +440,11 @@ namespace Tizen.Multimedia
         /// <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>
@@ -474,14 +476,14 @@ namespace Tizen.Multimedia
         /// <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)
@@ -505,11 +507,21 @@ namespace Tizen.Multimedia
             Interop.MetadataEditor.RemovePicture(Handle, index).ThrowIfError("Failed to remove picture");
         }
 
+        /// <summary>
+        /// Finalizes an instance of the MetadataEditor class.
+        /// </summary>
         ~MetadataEditor()
         {
             Dispose(false);
         }
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="MetadataEditor"/> object.
+        /// </summary>
+        /// <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)
@@ -527,6 +539,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Releases all resources used by the <see cref="MetadataEditor"/> object.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public void Dispose()
         {
             Dispose(true);