Setting since_tizen 3/4 on Tizen.NET API
[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia / MediaTool / ContainerMediaFormat.cs
index 0669184..f7e89c8 100644 (file)
@@ -22,13 +22,15 @@ namespace Tizen.Multimedia
     /// <summary>
     /// Represents a container media format. This class cannot be inherited.
     /// </summary>
+    /// <since_tizen> 3 </since_tizen>
     public sealed class ContainerMediaFormat : MediaFormat
     {
         /// <summary>
         /// Initializes a new instance of the ContainerMediaFormat class.
         /// </summary>
         /// <param name="mimeType">The mime type of the container format.</param>
-        /// <exception cref="ArgumentException">mimeType is invalid(i.e. undefined value).</exception>
+        /// <exception cref="ArgumentException"><paramref name="mimeType"/> is invalid (i.e. undefined value).</exception>
+        /// <since_tizen> 3 </since_tizen>
         public ContainerMediaFormat(MediaFormatContainerMimeType mimeType)
             : base(MediaFormatType.Container)
         {
@@ -63,10 +65,8 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the mime type of the current format.
         /// </summary>
-        public MediaFormatContainerMimeType MimeType
-        {
-            get;
-        }
+        /// <since_tizen> 3 </since_tizen>
+        public MediaFormatContainerMimeType MimeType { get; }
 
         internal override void AsNativeHandle(IntPtr handle)
         {
@@ -77,11 +77,19 @@ namespace Tizen.Multimedia
             MultimediaDebug.AssertNoError(ret);
         }
 
-        public override string ToString()
-        {
-            return $"MimeType={ MimeType.ToString() }";
-        }
+        /// <summary>
+        /// Returns a string that represents the current object.
+        /// </summary>
+        /// <returns>A string that represents the current object.</returns>
+        /// <since_tizen> 3 </since_tizen>
+        public override string ToString() => $"MimeType={ MimeType.ToString() }";
 
+        /// <summary>
+        /// Compares an object to an instance of <see cref="ContainerMediaFormat"/> for equality.
+        /// </summary>
+        /// <param name="obj">A <see cref="Object"/> to compare.</param>
+        /// <returns>true if the formats are equal; otherwise, false.</returns>
+        /// <since_tizen> 3 </since_tizen>
         public override bool Equals(object obj)
         {
             var rhs = obj as ContainerMediaFormat;
@@ -93,9 +101,12 @@ namespace Tizen.Multimedia
             return MimeType == rhs.MimeType;
         }
 
+        /// <summary>
+        /// Gets the hash code for this instance of <see cref="ContainerMediaFormat"/>.
+        /// </summary>
+        /// <returns>The hash code for this instance of <see cref="ContainerMediaFormat"/>.</returns>
+        /// <since_tizen> 3 </since_tizen>
         public override int GetHashCode()
-        {
-            return (int)MimeType;
-        }
+            => (int)MimeType;
     }
 }