[Multimedia] Added missing comments and fixed comment errors.

Change-Id: Iaee8d0366fea702edd9ceb34554e065ec4895762
Signed-off-by: coderhyme <jhyo.kim@samsung.com>

diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs
index bbe05b5..8460e7b 100755 (executable)
--- a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs
+++ b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs
@@ -249,7 +249,7 @@ namespace Tizen.Multimedia
         ///     -or-\n
         ///     An internal error occurs.
         /// </exception>
-        /// <exception cref="ArgumentNullException"><paramref name="device"> is null.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="device"/> is null.</exception>
         /// <exception cref="AudioPolicyException"><see cref="AudioStreamType"/> of <paramref name="device"/> is unavailable for this.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="AudioStreamPolicy"/> has already been disposed of.</exception>
         /// <seealso cref="AudioManager.GetConnectedDevices()"/>
@@ -279,7 +279,7 @@ namespace Tizen.Multimedia
         /// The available <see cref="AudioStreamType"/> is <see cref="AudioStreamType.Voip"/> and <see cref="AudioStreamType.MediaExternalOnly"/>.
         /// </remarks>
         /// <exception cref="InvalidOperationException">An internal error occurs.</exception>
-        /// <exception cref="ArgumentNullException"><paramref name="device"> is null.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="device"/> is null.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="AudioStreamPolicy"/> has already been disposed of.</exception>
         /// <seealso cref="AudioManager.GetConnectedDevices()"/>
         public void RemoveDeviceForStreamRouting(AudioDevice device)

diff --git a/src/Tizen.Multimedia/Common/IMediaBuffer.cs b/src/Tizen.Multimedia/Common/IMediaBuffer.cs
index dfa4275..9407d36 100644 (file)
--- a/src/Tizen.Multimedia/Common/IMediaBuffer.cs
+++ b/src/Tizen.Multimedia/Common/IMediaBuffer.cs
@@ -48,7 +48,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the value indicating whether the <see cref="IMediaBuffer"/> is read-only.
         /// </summary>
-        /// <value> true if the <see cref="IMediaBuffer"/> is read-only; otherwise, false.
+        /// <value> true if the <see cref="IMediaBuffer"/> is read-only; otherwise, false.</value>
         bool IsReadOnly { get; }
 
         /// <summary>

diff --git a/src/Tizen.Multimedia/MediaTool/AudioMediaFormat.cs b/src/Tizen.Multimedia/MediaTool/AudioMediaFormat.cs
index b70894e..43cff47 100644 (file)
--- a/src/Tizen.Multimedia/MediaTool/AudioMediaFormat.cs
+++ b/src/Tizen.Multimedia/MediaTool/AudioMediaFormat.cs
@@ -248,12 +248,19 @@ namespace Tizen.Multimedia
         /// </summary>
         public MediaFormatAacType AacType { get; }
 
+        /// <summary>
+        /// Returns a string that represents the current object.
+        /// </summary>
+        /// <returns>A string that represents the current object.</returns>
         public override string ToString()
-        {
-            return $@"MimeTyp={ MimeType.ToString() }, Channel={ Channel.ToString() }, SampleRate=
+            => $@"MimeType={ MimeType.ToString() }, Channel={ Channel.ToString() }, SampleRate=
                 { SampleRate }, Bit={ Bit.ToString() }, BitRate={ BitRate.ToString() }, AacType={ AacType.ToString() }";
-        }
 
+        /// <summary>
+        /// Compares an object to an instance of <see cref="AudioMediaFormat"/> for equality.
+        /// </summary>
+        /// <param name="obj">A <see cref="Object"/> to compare.</param>
+        /// <returns>true if the formats are equal; otherwise, false.</returns>
         public override bool Equals(object obj)
         {
             var rhs = obj as AudioMediaFormat;
@@ -266,9 +273,11 @@ namespace Tizen.Multimedia
                 Bit == rhs.Bit && BitRate == rhs.BitRate;
         }
 
+        /// <summary>
+        /// Gets the hash code for this instance of <see cref="AudioMediaFormat"/>.
+        /// </summary>
+        /// <returns>The hash code for this instance of <see cref="AudioMediaFormat"/>.</returns>
         public override int GetHashCode()
-        {
-            return new { MimeType, Channel, SampleRate, Bit, BitRate }.GetHashCode();
-        }
+            => new { MimeType, Channel, SampleRate, Bit, BitRate }.GetHashCode();
     }
 }

diff --git a/src/Tizen.Multimedia/MediaTool/ContainerMediaFormat.cs b/src/Tizen.Multimedia/MediaTool/ContainerMediaFormat.cs
index 8efa929..10946aa 100644 (file)
--- a/src/Tizen.Multimedia/MediaTool/ContainerMediaFormat.cs
+++ b/src/Tizen.Multimedia/MediaTool/ContainerMediaFormat.cs
@@ -63,10 +63,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the mime type of the current format.
         /// </summary>
-        public MediaFormatContainerMimeType MimeType
-        {
-            get;
-        }
+        public MediaFormatContainerMimeType MimeType { get; }
 
         internal override void AsNativeHandle(IntPtr handle)
         {
@@ -77,11 +74,17 @@ 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>
+        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>
         public override bool Equals(object obj)
         {
             var rhs = obj as ContainerMediaFormat;
@@ -93,9 +96,11 @@ 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>
         public override int GetHashCode()
-        {
-            return (int)MimeType;
-        }
+            => (int)MimeType;
     }
 }

diff --git a/src/Tizen.Multimedia/MediaTool/TextMediaFormat.cs b/src/Tizen.Multimedia/MediaTool/TextMediaFormat.cs
index 1c5ef6b..f8a7f85 100644 (file)
--- a/src/Tizen.Multimedia/MediaTool/TextMediaFormat.cs
+++ b/src/Tizen.Multimedia/MediaTool/TextMediaFormat.cs
@@ -112,11 +112,18 @@ namespace Tizen.Multimedia
         /// </summary>
         public MediaFormatTextType TextType { get; }
 
+        /// <summary>
+        /// Returns a string that represents the current object.
+        /// </summary>
+        /// <returns>A string that represents the current object.</returns>
         public override string ToString()
-        {
-            return $"MimeType={ MimeType.ToString() }, TextType={ TextType.ToString() }";
-        }
+            => $"MimeType={ MimeType.ToString() }, TextType={ TextType.ToString() }";
 
+        /// <summary>
+        /// Compares an object to an instance of <see cref="TextMediaFormat"/> for equality.
+        /// </summary>
+        /// <param name="obj">A <see cref="Object"/> to compare.</param>
+        /// <returns>true if the formats are equal; otherwise, false.</returns>
         public override bool Equals(object obj)
         {
             var rhs = obj as TextMediaFormat;
@@ -128,9 +135,10 @@ namespace Tizen.Multimedia
             return MimeType == rhs.MimeType && TextType == rhs.TextType;
         }
 
-        public override int GetHashCode()
-        {
-            return new { MimeType, TextType }.GetHashCode();
-        }
+        /// <summary>
+        /// Gets the hash code for this instance of <see cref="TextMediaFormat"/>.
+        /// </summary>
+        /// <returns>The hash code for this instance of <see cref="TextMediaFormat"/>.</returns>
+        public override int GetHashCode() => new { MimeType, TextType }.GetHashCode();
     }
 }

diff --git a/src/Tizen.Multimedia/MediaTool/VideoMediaFormat.cs b/src/Tizen.Multimedia/MediaTool/VideoMediaFormat.cs
index ca74d18..d4cc88f 100644 (file)
--- a/src/Tizen.Multimedia/MediaTool/VideoMediaFormat.cs
+++ b/src/Tizen.Multimedia/MediaTool/VideoMediaFormat.cs
@@ -259,12 +259,19 @@ namespace Tizen.Multimedia
         /// </summary>
         public int BitRate { get; }
 
+        /// <summary>
+        /// Returns a string that represents the current object.
+        /// </summary>
+        /// <returns>A string that represents the current object.</returns>
         public override string ToString()
-        {
-            return $@"MimeType={ MimeType.ToString() }, Size=({ Size.ToString() }), FrameRate=
+            => $@"MimeType={ MimeType.ToString() }, Size=({ Size.ToString() }), FrameRate=
                 { FrameRate.ToString() }, BitRate={ BitRate.ToString() }";
-        }
 
+        /// <summary>
+        /// Compares an object to an instance of <see cref="VideoMediaFormat"/> for equality.
+        /// </summary>
+        /// <param name="obj">A <see cref="Object"/> to compare.</param>
+        /// <returns>true if the formats are equal; otherwise, false.</returns>
         public override bool Equals(object obj)
         {
             var rhs = obj as VideoMediaFormat;
@@ -277,9 +284,11 @@ namespace Tizen.Multimedia
                 FrameRate == rhs.FrameRate && BitRate == rhs.BitRate;
         }
 
+        /// <summary>
+        /// Gets the hash code for this instance of <see cref="VideoMediaFormat"/>.
+        /// </summary>
+        /// <returns>The hash code for this instance of <see cref="VideoMediaFormat"/>.</returns>
         public override int GetHashCode()
-        {
-            return new { MimeType, Size, FrameRate, BitRate }.GetHashCode();
-        }
+            => new { MimeType, Size, FrameRate, BitRate }.GetHashCode();
     }
 }

diff --git a/src/Tizen.Multimedia/MediaView/MediaView.cs b/src/Tizen.Multimedia/MediaView/MediaView.cs
index de18be5..89dedf3 100755 (executable)
--- a/src/Tizen.Multimedia/MediaView/MediaView.cs
+++ b/src/Tizen.Multimedia/MediaView/MediaView.cs
@@ -42,6 +42,9 @@ namespace Tizen.Multimedia
         {
         }
 
+        /// <summary>
+        /// This method is used by the infrastructure and is not intended to be used directly from application code.
+        /// </summary>
         protected override IntPtr CreateHandle(EvasObject parent)
         {
             IntPtr evas = Interop.EvasObject.evas_object_evas_get(parent);