From 931475fd043007bae11a6be1d669cf0ae55ab233 Mon Sep 17 00:00:00 2001
From: coderhyme <jhyo.kim@samsung.com>
Date: Thu, 28 Sep 2017 12:46:37 +0900
Subject: [PATCH] [Multimedia] Added missing comments and fixed comment errors
 in MediaCodec.

Change-Id: I1171073143ef640251e9053fdb30f49dcb33c0a1
Signed-off-by: coderhyme <jhyo.kim@samsung.com>
---
 .../MediaCodec/MediaCodec.cs                          | 15 ++++++++++++---
 .../MediaCodec/MediaCodecError.cs                     | 19 +++++++++++++++++++
 2 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs
index b01f245..f4b3f1f 100644
--- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs
+++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs
@@ -53,6 +53,12 @@ namespace Tizen.Multimedia.MediaCodec
         #region IDisposable-support
         private bool _isDisposed = false;
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="MediaCodec"/> object.
+        /// </summary>
+        /// <param name="disposing">
+        /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (!_isDisposed)
@@ -72,6 +78,9 @@ namespace Tizen.Multimedia.MediaCodec
             Dispose(false);
         }
 
+        /// <summary>
+        /// Releases all resources used by the <see cref="MediaCodec"/> object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
@@ -343,7 +352,7 @@ namespace Tizen.Multimedia.MediaCodec
         /// Adds the packet to the internal queue of the codec.
         /// </summary>
         /// <param name="packet">The packet to be encoded or decoded.</param>
-        /// <exception cref="ArgumentNullException"><paramref="packet"/> is null.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="packet"/> is null.</exception>
         /// <exception cref="InvalidOperationException">The current codec is not prepared yet.</exception>
         /// <remarks>Any attempts to modify the packet will fail until the <see cref="InputProcessed"/> event for the packet is invoked.</remarks>
         public void ProcessInput(MediaPacket packet)
@@ -385,7 +394,7 @@ namespace Tizen.Multimedia.MediaCodec
         /// <param name="encoder">The value indicating encoder or decoder.</param>
         /// <param name="type">The mime type to query.</param>
         /// <returns>The values indicating which codec types are supported on the current device.</returns>
-        /// <exception cref="ArgumentException"><paramref="type"/> is invalid.</exception>
+        /// <exception cref="ArgumentException"><paramref name="type"/> is invalid.</exception>
         public MediaCodecTypes GetCodecType(bool encoder, MediaFormatVideoMimeType type)
         {
             ValidateNotDisposed();
@@ -404,7 +413,7 @@ namespace Tizen.Multimedia.MediaCodec
         /// <param name="encoder">The value indicating encoder or decoder.</param>
         /// <param name="type">The mime type to query.</param>
         /// <returns>The values indicating which codec types are supported on the current device.</returns>
-        /// <exception cref="ArgumentException"><paramref="type"/> is invalid.</exception>
+        /// <exception cref="ArgumentException"><paramref name="type"/> is invalid.</exception>
         public MediaCodecTypes GetCodecType(bool encoder, MediaFormatAudioMimeType type)
         {
             ValidateNotDisposed();
diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecError.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecError.cs
index 14508f2..6a3c8a1 100644
--- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecError.cs
+++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecError.cs
@@ -44,11 +44,30 @@ namespace Tizen.Multimedia.MediaCodec
         OverflowInBuffer = CodecDefinedBase | 0x0d,
     }
 
+    /// <summary>
+    /// Specifies the errors of <see cref="MediaCodec"/>.
+    /// </summary>
+    /// <seealso cref="MediaCodec.ErrorOccurred"/>
     public enum MediaCodecError
     {
+        /// <summary>
+        /// The format is not supported.
+        /// </summary>
         NotSupportedFormat = MediaCodecErrorCode.NotSupportedFormat,
+
+        /// <summary>
+        /// An internal error.
+        /// </summary>
         InternalError = MediaCodecErrorCode.Internal,
+
+        /// <summary>
+        /// Not enough storage.
+        /// </summary>
         OutOfStorage = MediaCodecErrorCode.OutOfStorage,
+
+        /// <summary>
+        /// The stream is invalid.
+        /// </summary>
         InvalidStream = MediaCodecErrorCode.InvalidStream,
     }
 }
-- 
2.7.4