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 aeda76e..e7d01b0
--- a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
+++ b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
@@ -24,11 +24,12 @@ namespace Tizen.Multimedia
     /// Provides a means to edit the metadata of the media file.
     /// </summary>
     /// <privilege>
-    /// If you want to access only internal storage,
-    /// you should add privilege http://tizen.org/privilege/mediastorage. \n
-    /// Or if you want to access only external storage,
-    /// you should add privilege http://tizen.org/privilege/externalstorage. \n
+    /// If you want to access only an internal storage,
+    /// 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.
     /// </privilege>
+    /// <since_tizen> 3 </since_tizen>
     public class MetadataEditor : IDisposable
     {
         private bool _disposed = false;
@@ -52,12 +53,12 @@ namespace Tizen.Multimedia
         /// Initializes a new instance of the <see cref="MetadataEditor"/> class with the specified path.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
-        /// <param name="path">The path of the media file to edit metadata.</param>
+        /// <param name="path">The path of the media file to edit the metadata.</param>
         /// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
         /// <exception cref="ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space.</exception>
         /// <exception cref="FileFormatException">The file is not supported.</exception>
-        /// <exception cref="FileNotFoundException">File does not exist.</exception>
-        /// <exception cref="UnauthorizedAccessException">Caller does not have required privilege to access the file.</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>
         public MetadataEditor(string path)
         {
             if (path == null)
@@ -117,7 +118,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Artist
         {
             get
@@ -136,7 +137,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Title
         {
             get
@@ -155,7 +156,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Album
         {
             get
@@ -174,7 +175,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Genre
         {
             get
@@ -193,7 +194,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Author
         {
             get
@@ -212,7 +213,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Copyright
         {
             get
@@ -231,11 +232,11 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <remarks>
-        /// If the media contains ID3 tag, this refers to the recorded date.
-        /// If the media is a mp4 format, this refers to the year and the value to set will be converted into integer.
+        /// If the media contains the ID3 tag, this refers to the recorded date.
+        /// If the media is a mp4 format, this refers to the year, and the value to set will be converted into integer.
         /// </remarks>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Date
         {
             get
@@ -254,7 +255,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Description
         {
             get
@@ -273,7 +274,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Comment
         {
             get
@@ -292,7 +293,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string TrackNumber
         {
             get
@@ -310,7 +311,7 @@ namespace Tizen.Multimedia
         /// Gets the count of album arts of media.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public int PictureCount
         {
             get => int.TryParse(GetParam(MetadataEditorAttr.PictureCount), out var value) ? value : 0;
@@ -321,7 +322,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string Conductor
         {
             get
@@ -340,7 +341,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException">The file is read-only.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public string UnsyncLyrics
         {
             get
@@ -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.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
+        /// <since_tizen> 3 </since_tizen>
         public void Commit()
         {
             if (_isFileReadOnly)
@@ -377,16 +379,15 @@ namespace Tizen.Multimedia
         /// Gets the artwork image in the media file.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
-        /// <param name="index">The index of picture to import.</param>
-        /// <returns> Artwork included in the media file.</returns>
-        /// <returns>Artwork included in the media file.</returns>
+        /// <param name="index">The index of the picture to import.</param>
+        /// <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.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public Artwork GetPicture(int index)
         {
             if (index < 0)
@@ -437,16 +438,16 @@ namespace Tizen.Multimedia
         /// Appends the picture to the media file.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
-        /// <param name="path">The path of picture for adding to the metadata.</param>
+        /// <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"> Picture path is null</exception>
-        /// <exception cref="FileNotFoundException">File does not exist.</exception>
-        /// <exception cref="UnauthorizedAccessException">Caller does not have required privilege to access the file.</exception>
-        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed.</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>
         /// <exception cref="FileFormatException">The specified file is not supported.</exception>
         public void AddPicture(string path)
         {
@@ -473,18 +474,18 @@ namespace Tizen.Multimedia
         /// Removes the picture from the media file.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
-        /// <param name="index">The index of picture to remove.</param>
+        /// <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.</exception>
+        /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
         public void RemovePicture(int index)
         {
             if (index < 0)
@@ -506,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)
@@ -528,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);