From: coderhyme <jhyo.kim@samsung.com>
Date: Tue, 30 May 2017 11:20:12 +0000 (+0900)
Subject: [MediaTool] Updated comments.
X-Git-Tag: submit/trunk/20170823.075128~94^2~59^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=29924d0207c0b35deb53866564c8a3a37909f54b;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

[MediaTool] Updated comments.

Added missiong punctuation marks.
Removed meaningless words.
Modified enum descriptions.

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

diff --git a/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs b/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs
index b96213f..4008484 100755
--- a/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs
+++ b/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs
@@ -17,27 +17,28 @@
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// Enumeration for media format type
+    /// Specifies the media format types.
     /// </summary>
+    /// <seealso cref="MediaFormat"/>
     public enum MediaFormatType
     {
         /// <summary>
-        /// Audio
+        /// Audio media format.
         /// </summary>
         Audio = 0x01000000,
 
         /// <summary>
-        /// Video
+        /// Video media format.
         /// </summary>
         Video = 0x02000000,
 
         /// <summary>
-        /// Container
+        /// Container media format.
         /// </summary>
         Container = 0x04000000,
 
         /// <summary>
-        /// Text
+        /// Text media format.
         /// </summary>
         Text = 0x03000000,
     }
@@ -59,102 +60,102 @@ namespace Tizen.Multimedia
     }
 
     /// <summary>
-    /// Enumeration for audio mime type
+    /// Specifies the mime types for audio media formats.
     /// </summary>
     public enum MediaFormatAudioMimeType
     {
         /// <summary>
-        /// L16, Audio
-        /// </summary>
+        /// L16, Audio.
+        /// </summary>.
         //L16 = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1010),
 
         /// <summary>
-        /// ALAW, Audio
+        /// ALAW, Audio.
         /// </summary>
         //ALaw = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1020),
 
         /// <summary>
-        /// ULAW,  Audio
+        /// ULAW, Audio.
         /// </summary>
         //ULaw = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1030),
 
         /// <summary>
-        /// AMR, Audio, Alias for AmrNB
+        /// AMR, Alias for <see cref="AmrNB"/>.
         /// </summary>
         Amr = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1040),
 
         /// <summary>
-        /// AMR-NB, Audio
+        /// AMR-NB.
         /// </summary>
         AmrNB = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1040),
 
         /// <summary>
-        /// AMR-WB, Audio
+        /// AMR-WB.
         /// </summary>
         AmrWB = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1041),
 
         /// <summary>
-        /// G729, Audio
+        /// G729.
         /// </summary>
         //G729 = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1050),
 
         /// <summary>
-        /// AAC, Audio, Alias for AacLc
+        /// AAC, Alias for <see cref="AacLC"/>.
         /// </summary>
         Aac = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1060),
 
         /// <summary>
-        /// AAC-LC (Advanced Audio Coding Low-Complexity profile), Audio
+        /// AAC-LC (Advanced Audio Coding Low-Complexity profile).
         /// </summary>
         AacLC = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1060),
 
         /// <summary>
-        /// HE-AAC (High-Efficiency Advanced Audio Coding), Audio
+        /// HE-AAC (High-Efficiency Advanced Audio Coding).
         /// </summary>
         AacHE = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1061),
 
         /// <summary>
-        /// HE-AAC-PS (High-Efficiency Advanced Audio Coding with Parametric Stereo), Audio
+        /// HE-AAC-PS (High-Efficiency Advanced Audio Coding with Parametric Stereo).
         /// </summary>
         AacHEPS = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1062),
 
         /// <summary>
-        /// MP3, Audio
+        /// MP3.
         /// </summary>
         MP3 = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1070),
 
         /// <summary>
-        /// VORBIS, Audio
+        /// VORBIS.
         /// </summary>
         Vorbis = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1080),
 
         /// <summary>
-        /// FLAC, Audio
+        /// FLAC.
         /// </summary>
         Flac = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1090),
 
         /// <summary>
-        /// Windows Media Audio 1, Audio
+        /// Windows Media Audio 1.
         /// </summary>
         Wma1 = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x10A0),
 
         /// <summary>
-        /// Windows Media Audio 2, Audio
+        /// Windows Media Audio 2.
         /// </summary>
         Wma2 = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x10A1),
 
         /// <summary>
-        /// Windows Media Audio Professional, Audio
+        /// Windows Media Audio Professional.
         /// </summary>
         WmaPro = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x10A2),
 
         /// <summary>
-        /// Windows Media Audio Lossless, Audio
+        /// Windows Media Audio Lossless.
         /// </summary>
         WmaLossless = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x10A3),
 
         /// <summary>
-        /// PCM, Audio, Alias for PcmS16LE
+        /// PCM.
         /// </summary>
         Pcm = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1510),
 
@@ -210,22 +211,22 @@ namespace Tizen.Multimedia
     }
 
     /// <summary>
-    /// Enumeration for video mime type
+    /// Specifies the mime types for video media formats.
     /// </summary>
     public enum MediaFormatVideoMimeType
     {
         /// <summary>
-        /// H261
+        /// H261.
         /// </summary>
         H261 = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2010),
 
         /// <summary>
-        /// H263
+        /// H263.
         /// </summary>
         H263 = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2020),
 
         /// <summary>
-        /// H263P
+        /// H263P.
         /// </summary>
         H263P = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2021),
 
@@ -275,17 +276,17 @@ namespace Tizen.Multimedia
         //H263Hlp = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x202A),
 
         /// <summary>
-        /// H264_SP
+        /// H264_SP.
         /// </summary>
         H264SP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2030),
 
         /// <summary>
-        /// H264_MP
+        /// H264_MP.
         /// </summary>
         H264MP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2031),
 
         /// <summary>
-        /// H264_HP
+        /// H264_HP.
         /// </summary>
         H264HP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2032),
 
@@ -315,37 +316,37 @@ namespace Tizen.Multimedia
         //H264C444P = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2037),
 
         /// <summary>
-        /// MJPEG
+        /// MJPEG.
         /// </summary>
         MJpeg = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2040),
 
         /// <summary>
-        /// MPEG1
+        /// MPEG1.
         /// </summary>
         Mpeg1 = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2050),
 
         /// <summary>
-        /// MPEG2_SP
+        /// MPEG2_SP.
         /// </summary>
         Mpeg2SP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2060),
 
         /// <summary>
-        /// MPEG2_MP
+        /// MPEG2_MP.
         /// </summary>
         Mpeg2MP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2061),
 
         /// <summary>
-        /// MPEG2_HP
+        /// MPEG2_HP.
         /// </summary>
         Mpeg2HP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2062),
 
         /// <summary>
-        /// MPEG4_SP
+        /// MPEG4_SP.
         /// </summary>
         Mpeg4SP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2070),
 
         /// <summary>
-        /// MPEG4_ASP
+        /// MPEG4_ASP.
         /// </summary>
         Mpeg4Asp = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2071),
 
@@ -380,72 +381,72 @@ namespace Tizen.Multimedia
         //VC1 = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x20B0),
 
         /// <summary>
-        /// I420
+        /// I420.
         /// </summary>
         I420 = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2510),
 
         /// <summary>
-        /// NV12
+        /// NV12.
         /// </summary>
         NV12 = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2520),
 
         /// <summary>
-        /// NV12T
+        /// NV12T.
         /// </summary>
         NV12T = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2530),
 
         /// <summary>
-        /// YV12
+        /// YV12.
         /// </summary>
         YV12 = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2540),
 
         /// <summary>
-        /// NV21
+        /// NV21.
         /// </summary>
         NV21 = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2550),
 
         /// <summary>
-        /// NV16
+        /// NV16.
         /// </summary>
         NV16 = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2560),
 
         /// <summary>
-        /// YUYV
+        /// YUYV.
         /// </summary>
         Yuyv = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2570),
 
         /// <summary>
-        /// UYVY
+        /// UYVY.
         /// </summary>
         Uyvy = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2580),
 
         /// <summary>
-        /// 422P
+        /// 422P.
         /// </summary>
         Yuv422P = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2590),
 
         /// <summary>
-        /// RGB565
+        /// RGB565.
         /// </summary>
         Rgb565 = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x25a0),
 
         /// <summary>
-        /// RGB888
+        /// RGB888.
         /// </summary>
         Rgb888 = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x25b0),
 
         /// <summary>
-        /// RGBA
+        /// RGBA.
         /// </summary>
         Rgba = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x25c0),
 
         /// <summary>
-        /// ARGB
+        /// ARGB.
         /// </summary>
         Argb = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x25d0),
 
         /// <summary>
-        /// BGRA
+        /// BGRA.
         /// </summary>
         Bgra = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x25e0),
 
@@ -456,47 +457,47 @@ namespace Tizen.Multimedia
     }
 
     /// <summary>
-    /// Enumeration for container mime type
+    /// Specifies the mime types for container media formats.
     /// </summary>
     public enum MediaFormatContainerMimeType
     {
         /// <summary>
-        /// MP4 container, Video
+        /// MP4 container, Video.
         /// </summary>
         MP4 = (MediaFormatType.Container | 0x3010),
 
         /// <summary>
-        /// AVI container, Video
+        /// AVI container, Video.
         /// </summary>
         Avi = (MediaFormatType.Container | 0x3020),
 
         /// <summary>
-        /// MPEG2TS container, Video
+        /// MPEG2TS container, Video.
         /// </summary>
         Mpeg2TS = (MediaFormatType.Container | 0x3030),
 
         /// <summary>
-        /// MPEG2PS container, Video
+        /// MPEG2PS container, Video.
         /// </summary>
         Mpeg2PS = (MediaFormatType.Container | 0x3040),
 
         /// <summary>
-        /// MATROSKA container, Video
+        /// MATROSKA container, Video.
         /// </summary>
         Matroska = (MediaFormatType.Container | 0x3050),
 
         /// <summary>
-        /// WEBM container, Video
+        /// WEBM container, Video.
         /// </summary>
         Webm = (MediaFormatType.Container | 0x3060),
 
         /// <summary>
-        /// 3GP container, Video
+        /// 3GP container, Video.
         /// </summary>
         ThreeGP = (MediaFormatType.Container | 0x3070),
 
         /// <summary>
-        /// WAV container, Audio
+        /// WAV container, Audio.
         /// </summary>
         Wav = (MediaFormatType.Container | 0x4010),
 
@@ -522,12 +523,12 @@ namespace Tizen.Multimedia
     public enum MediaFormatTextMimeType
     {
         /// <summary>
-        /// MP4
+        /// MP4.
         /// </summary>
         MP4 = (MediaFormatType.Text | MediaFormatDataType.Encoded | 0x8010),
 
         /// <summary>
-        /// 3GP
+        /// 3GP.
         /// </summary>
         ThreeGP = (MediaFormatType.Text | MediaFormatDataType.Encoded | 0x8020),
     }