Add C# level description in metadata

Change-Id: If3875610010e9262c209dfcb8011c390bdf67877
Signed-off-by: Jiyong Min <jiyong.min@samsung.com>

diff --git a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
old mode 100644 (file)
new mode 100755 (executable)
index d27d196..18bdaf6
--- a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
+++ b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
@@ -55,6 +55,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Initializes a new instance of the <see cref="MetadataEditor"/> class with the specified path.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="path"> The path of the media file to edit metadata </param>
         /// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
         /// <exception cref="NotSupportedException">The file is unsupported format.</exception>
@@ -108,6 +109,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Artist of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Artist
         {
             get
@@ -124,6 +126,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Title of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Title
         {
             get
@@ -140,6 +143,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Album name of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Album
         {
             get
@@ -156,6 +160,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Genre of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Genre
         {
             get
@@ -172,6 +177,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Author of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Author
         {
             get
@@ -188,6 +194,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Copyright of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Copyright
         {
             get
@@ -204,6 +211,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Date of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <remarks>
         /// If the added media contains ID3 tag, This parameter refers to the recording time.
         /// If the added media is a mp4 format, This parameter refers to the year.
@@ -224,6 +232,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Description of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Description
         {
             get
@@ -240,6 +249,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Comment of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Comment
         {
             get
@@ -256,6 +266,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Track number of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string TrackNumber
         {
             get
@@ -272,6 +283,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Album art count of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string PictureCount
         {
             get
@@ -283,6 +295,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Conductor of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Conductor
         {
             get
@@ -299,6 +312,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Unsynchronized lyric of media
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string UnsyncLyrics
         {
             get
@@ -315,6 +329,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Writes the modified metadata to a media file
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <exception cref="InvalidOperationException"> When internal process error is occured</exception>
         public void Commit()
         {
@@ -325,6 +340,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the artwork image in a media file
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="index"> Index of picture to import </param>
         /// <returns> Artwork included in the media file</returns>
         /// <exception cref="InvalidOperationException"> When internal process error is occured</exception>
@@ -372,6 +388,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Appends the picture to the media file.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="path">The path of picture for adding to the metadata.</param>
         /// <exception cref="InvalidOperationException">Internal error occurs.</exception>
         /// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
@@ -389,6 +406,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Removes the picture from the media file.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="index"> Index of picture to remove </param>
         /// <exception cref="InvalidOperationException"> When internal process error is occured</exception>
         /// <exception cref="ArgumentOutOfRangeException"> Wrong index number </exception>
@@ -406,6 +424,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Metadata Editor destructor
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         ~MetadataEditor()
         {
             Dispose(false);

diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs
old mode 100644 (file)
new mode 100755 (executable)
index 4dba9cf..e1fcb83
--- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs
+++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs
@@ -24,6 +24,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Initializes a new instance of the Artwork class with the specified data and mimeType.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="data">The data of the artwork to set metadata.</param>
         /// <param name="mimeType">The mime type of the data of the artwork.</param>
         public Artwork(byte[] data, string mimeType)
@@ -35,11 +36,13 @@ namespace Tizen.Multimedia
         /// <summary>
         /// The encoded artwork image.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public byte[] Data { get; }
 
         /// <summary>
         /// The mime type of artwork.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string MimeType { get; }
     }
 }

diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs
old mode 100644 (file)
new mode 100755 (executable)
index c9eb9f8..561bb8b
--- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs
+++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs
@@ -51,36 +51,42 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the bitrate.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the bitrate, or null if the information does not exists.</value>
         public string Bitrate { get; }
 
         /// <summary>
         /// Gets the video FPS.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the fps, or null if the information does not exists.</value>
         public string Fps { get; }
 
         /// <summary>
         /// Gets the width of the video.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the width, or null if the information does not exists.</value>
         public string Width { get; }
 
         /// <summary>
         /// Gets the height of the video.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the height, or null if the information does not exists.</value>
         public string Height { get; }
 
         /// <summary>
         /// Get the codec type of the video.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the codec type, or null if the information does not exists.</value>
         public string Codec { get; }
 
         /// <summary>
         /// Gets the video stream count.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the video stream count, or null if the information does not exists.</value>
         public string StreamCount { get; }
 
@@ -124,36 +130,42 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the audio bitrate.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the bitrate, or null if the information does not exists.</value>
         public string Bitrate { get; }
 
         /// <summary>
         /// Gets the audio channels.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the audio channels, or null if the information does not exists.</value>
         public string Channels { get; }
 
         /// <summary>
         /// Gets the audio sample rate.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the sample rate, or null if the information does not exists.</value>
         public string Samplerate { get; }
 
         /// <summary>
         /// Gets the bit per sample of the audio.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the bit oer sample, or null if the information does not exists.</value>
         public string BitPerSample { get; }
 
         /// <summary>
         /// Gets the audio stream count.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the audio stream count, or null if the information does not exists.</value>
         public string StreamCount { get; }
 
         /// <summary>
         /// Gets the audio codec type.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Codec { get; }
 
         private Lazy<string> _description;
@@ -211,148 +223,173 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the duration of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the duration, or null if the information does not exists.</value>
         public string Duration { get; }
 
         /// <summary>
         /// Gets the video metadata.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public VideoMetadata Video { get; }
 
         /// <summary>
         /// Gets the audio metadata.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public AudioMetadata Audio { get; }
 
         /// <summary>
         /// Gets the artist of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the artist, or null if the information does not exists.</value>
         public string Artist { get; }
 
         /// <summary>
         /// Gets the title of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the title, or null if the information does not exists.</value>
         public string Title { get; }
 
         /// <summary>
         /// Gets the album name of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the album name, or null if the information does not exists.</value>
         public string Album { get; }
 
         /// <summary>
         /// Gets the album artist of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the album artist, or null if the information does not exists.</value>
         public string AlbumArtist { get; }
 
         /// <summary>
         /// Gets the genre of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the genre, or null if the information does not exists.</value>
         public string Genre { get; }
 
         /// <summary>
         /// Gets the author of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the author, or null if the information does not exists.</value>
         public string Author { get; }
 
         /// <summary>
         /// Gets the copyright of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the copyright, or null if the information does not exists.</value>
         public string Copyright { get; }
 
         /// <summary>
         /// Gets the release date of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the release date, or null if the information does not exists.</value>
         public string ReleaseDate { get; }
 
         /// <summary>
         /// Gets the description of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the description, or null if the information does not exists.</value>
         public string Description { get; }
 
         /// <summary>
         /// Gets the comment of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the comment, or null if the information does not exists.</value>
         public string Comment { get; }
 
         /// <summary>
         /// Gets the track number of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the track number, or null if the information does not exists.</value>
         public string TrackNumber { get; }
 
         /// <summary>
         /// Gets the classification of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the classification, or null if the information does not exists.</value>
         public string Classification { get; }
 
         /// <summary>
         /// Gets the rating of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the rating, or null if the information does not exists.</value>
         public string Rating { get; }
 
         /// <summary>
         /// Gets the longitude of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the longitude, or null if the information does not exists.</value>
         public string Longitude { get; }
 
         /// <summary>
         /// Gets the latitude of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the latitude, or null if the information does not exists.</value>
         public string Latitude { get; }
 
         /// <summary>
         /// Gets the altitude of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the altitude, or null if the information does not exists.</value>
         public string Altitude { get; }
 
         /// <summary>
         /// Gets the conductor of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the conductor, or null if the information does not exists.</value>
         public string Conductor { get; }
 
         /// <summary>
         /// Gets the unsynchronized lyrics of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the unsynchronized lyrics, or null if the information does not exists.</value>
         public string UnsyncLyric { get; }
 
         /// <summary>
         /// Gets the number of synchronized lyrics of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the number of the synchronized lyrics, or null if the information does not exists.</value>
         public string SyncLyricCount { get; }
 
         /// <summary>
         /// Gets the recording date of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the recording date, or null if the information does not exists.</value>
         public string RecordingDate { get; }
 
         /// <summary>
         /// Gets the rotate(orientation) information of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the rotation information, or null if the information does not exists.</value>
         public string Rotation { get; }
 
         /// <summary>
         /// Gets the information for 360 content of the media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>A string representing the information for 360 content, or null if the information does not exists.</value>
         public string Content360 { get; }
 

diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs
old mode 100644 (file)
new mode 100755 (executable)
index 2c0dc00..7b49cdf
--- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs
+++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs
@@ -54,6 +54,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Initializes a new instance of the MetadataExtractor class with the specified path.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="path">The path for the file to extract metadata.</param>
         /// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
         /// <exception cref="FileNotFoundException"><paramref name="path"/> is not exist.</exception>
@@ -70,6 +71,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Initializes a new instance of the MetadataExtractor class with the specified buffer.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="buffer">The buffer to extract metadata.</param>
         /// <exception cref="ArgumentNullException"><paramref name="buffer"/> is null.</exception>
         /// <exception cref="ArgumentException">The length of <paramref name="buffer"/> is zero.</exception>
@@ -117,6 +119,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Retrieves the <see cref="Metadata"/>.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <returns>A <see cref="Metadata"/> for the given source.</returns>
         /// <exception cref="InvalidOperationException">Internal process error is occurred.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="MetadataExtractor"/> has been already disposed of.</exception>
@@ -133,6 +136,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the artwork image in the source.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <returns>A <see cref="Artwork"/> if it exists, otherwise null.</returns>
         /// <exception cref="InvalidOperationException">Internal process error is occurred.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="MetadataExtractor"/> has been already disposed of.</exception>
@@ -168,6 +172,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the sync lyrics of the source.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="index">The index of lyrics to retrieve.</param>
         /// <returns>A <see cref="SyncLyrics"/> object if <paramref name="index"/> is valid, otherwise null.</returns>
         /// <exception cref="InvalidOperationException">Internal process error is occurred.</exception>
@@ -199,6 +204,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the frame of a video media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <returns>The raw thumbnail data in RGB888 if it exists, otherwise null.</returns>
         /// <exception cref="InvalidOperationException">Internal process error is occurred.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="MetadataExtractor"/> has been already disposed of.</exception>
@@ -232,6 +238,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the frame of a video media.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="timeStamp">The timestamp in milliseconds.</param>
         /// <param name="accurate">true to get an accurate frame for the given timestamp,
         ///     otherwise false to get the nearest i-frame of the video rapidly.</param>
@@ -268,6 +275,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Metadata Extractor destructor
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         ~MetadataExtractor()
         {
             Dispose(false);

diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs
old mode 100644 (file)
new mode 100755 (executable)
index 7d9b68f..a12d730
--- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs
+++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs
@@ -24,6 +24,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Initialize a new instance of the MetadataExtractor class with the specified lyrics and timestamp.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="lyrics">The text of synclyrics to set.</param>
         /// <param name="timestamp">The timestamp of synclyrics to set.</param>
         public SyncLyrics(string lyrics, uint timestamp)
@@ -35,11 +36,13 @@ namespace Tizen.Multimedia
         /// <summary>
         /// The text representation of the lyrics.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public string Lyrics { get; }
 
         /// <summary>
         /// The time information of the lyrics.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public uint Timestamp { get; }
     }
 }