[Multimedia] Fixed errors in the doc-comments of MediaCodec, ImageUtil, and ScreenMir...

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

diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs
index 2697e15..cc1b40f 100644 (file)
--- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs
+++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs
@@ -21,7 +21,7 @@ using System.Diagnostics;
 namespace Tizen.Multimedia.MediaCodec
 {
     /// <summary>
-    /// Provides the means to encode and decode the video and the audio data.
+    /// Provides a means to encode and decode the video and the audio data.
     /// </summary>
     public class MediaCodec : IDisposable
     {

diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs
index c3024ce..407ccf7 100644 (file)
--- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs
+++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs
@@ -38,7 +38,7 @@ namespace Tizen.Multimedia.Remoting
         /// </summary>
         /// <exception cref="InvalidOperationException">
         ///     Not connected to a source.<br/>
-        ///     <br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -60,7 +60,7 @@ namespace Tizen.Multimedia.Remoting
         /// </summary>
         /// <exception cref="InvalidOperationException">
         ///     Not connected to a source.<br/>
-        ///     <br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -82,7 +82,7 @@ namespace Tizen.Multimedia.Remoting
         /// </summary>
         /// <exception cref="InvalidOperationException">
         ///     Not connected to a source.<br/>
-        ///     <br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -104,7 +104,7 @@ namespace Tizen.Multimedia.Remoting
         /// </summary>
         /// <exception cref="InvalidOperationException">
         ///     Not connected to a source.<br/>
-        ///     <br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>

diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs
index 35856f5..8acd950 100644 (file)
--- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs
+++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs
@@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Remoting
         /// </summary>
         /// <exception cref="InvalidOperationException">
         ///     Not connected to a source.<br/>
-        ///     <br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -59,7 +59,7 @@ namespace Tizen.Multimedia.Remoting
         /// </summary>
         /// <exception cref="InvalidOperationException">
         ///     Not connected to a source.<br/>
-        ///     <br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -82,7 +82,7 @@ namespace Tizen.Multimedia.Remoting
         /// </summary>
         /// <exception cref="InvalidOperationException">
         ///     Not connected to a source.<br/>
-        ///     <br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>

diff --git a/src/Tizen.Multimedia.Util/ImageUtil/GifFrame.cs b/src/Tizen.Multimedia.Util/ImageUtil/GifFrame.cs
index 6649e29..25f8f28 100644 (file)
--- a/src/Tizen.Multimedia.Util/ImageUtil/GifFrame.cs
+++ b/src/Tizen.Multimedia.Util/ImageUtil/GifFrame.cs
@@ -28,7 +28,7 @@ namespace Tizen.Multimedia.Util
         /// Initializes a new instance of the <see cref="GifFrame"/> class with a buffer and a delay.
         /// </summary>
         /// <param name="buffer">The raw image buffer to be encoded.</param>
-        /// <param name="delay">The delay for this image, in 0.001 sec units.</param>
+        /// <param name="delay">The delay for this image in milliseconds.</param>
         /// <exception cref="ArgumentNullException"><paramref name="buffer"/> is null.</exception>
         /// <exception cref="ArgumentException">The length of <paramref name="buffer"/> is zero.</exception>
         public GifFrame(byte[] buffer, uint delay)
@@ -55,7 +55,7 @@ namespace Tizen.Multimedia.Util
         /// <summary>
         /// Gets or sets the delay for this image.
         /// </summary>
-        /// <value>Time delay in 0.001 sec units.</value>
+        /// <value>Time delay in milliseconds.</value>
         public uint Delay { get; set; }
     }
 }

diff --git a/src/Tizen.Multimedia.Util/ImageUtil/ImageDecoder.cs b/src/Tizen.Multimedia.Util/ImageUtil/ImageDecoder.cs
index 502e31c..aeb2ab0 100644 (file)
--- a/src/Tizen.Multimedia.Util/ImageUtil/ImageDecoder.cs
+++ b/src/Tizen.Multimedia.Util/ImageUtil/ImageDecoder.cs
@@ -95,9 +95,7 @@ namespace Tizen.Multimedia.Util
         /// <exception cref="ArgumentException">
         ///     <paramref name="inputFilePath"/> is an empty string.<br/>
         ///     -or-<br/>
-        ///     <paramref name="inputFilePath"/> is not a image file.<br/>
-        ///     -or-<br/>
-        ///     The format of <paramref name="inputFilePath"/> is not <see cref="InputFormat"/>.
+        ///     <paramref name="inputFilePath"/> is not a image file.
         /// </exception>
         /// <exception cref="FileNotFoundException"><paramref name="inputFilePath"/> does not exists.</exception>
         /// <exception cref="UnauthorizedAccessException">The caller does not have required permission to access the path.</exception>
@@ -140,11 +138,7 @@ namespace Tizen.Multimedia.Util
         /// <returns>A task that represents the asynchronous decoding operation.</returns>
         /// <remarks>Only Graphics Interchange Format(GIF) codec returns more than one frame.</remarks>
         /// <exception cref="ArgumentNullException"><paramref name="inputBuffer"/> is null.</exception>
-        /// <exception cref="ArgumentException">
-        ///     <paramref name="inputBuffer"/> is an empty array.<br/>
-        ///     -or-<br/>
-        ///     The format of <paramref name="inputBuffer"/> is not <see cref="InputFormat"/>.
-        /// </exception>
+        /// <exception cref="ArgumentException"><paramref name="inputBuffer"/> is an empty array.</exception>
         /// <exception cref="FileFormatException">The format of <paramref name="inputBuffer"/> is not <see cref="InputFormat"/>.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ImageDecoder"/> has already been disposed of.</exception>
         public Task<IEnumerable<BitmapFrame>> DecodeAsync(byte[] inputBuffer)

diff --git a/src/Tizen.Multimedia.Util/ImageUtil/ImageTransform.cs b/src/Tizen.Multimedia.Util/ImageUtil/ImageTransform.cs
index d68c82d..3c08449 100644 (file)
--- a/src/Tizen.Multimedia.Util/ImageUtil/ImageTransform.cs
+++ b/src/Tizen.Multimedia.Util/ImageUtil/ImageTransform.cs
@@ -107,7 +107,7 @@ namespace Tizen.Multimedia.Util
         /// <exception cref="ArgumentOutOfRangeException">
         ///     index is less than 0.<br/>
         ///     -or-<br/>
-        ///     index is equal to or greater than Count.
+        ///     index is equal to or greater than <see cref="Count"/>.
         /// </exception>
         public ImageTransform this[int index]
         {
@@ -338,7 +338,7 @@ namespace Tizen.Multimedia.Util
         private Flips _flip;
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="RotateTransform"/> class.
+        /// Initializes a new instance of the <see cref="FlipTransform"/> class.
         /// </summary>
         /// <param name="flip">The value how to flip an image.</param>
         /// <exception cref="ArgumentException"><paramref name="flip"/> is invalid.</exception>
@@ -349,7 +349,7 @@ namespace Tizen.Multimedia.Util
         }
 
         /// <summary>
-        /// Gets or sets the value how to rotate an image.
+        /// Gets or sets the value how to flip an image.
         /// </summary>
         /// <exception cref="ArgumentException"><paramref name="value"/> is invalid.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is <see cref="Flips.None"/>.</exception>