[Multimedia] Fixed errors in the doc-comments of Player and AudioIO.

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

diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs
index f90ff57c4852384e9dac097d3653e9f73329e9be..fea275aa54ab62b81082467f3f05fae7749530d5 100644 (file)
--- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs
+++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs
@@ -170,9 +170,11 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the size allocated for the audio input buffer.
         /// </summary>
-        /// <exception cref="ObjectDisposedException">The AudioPlayback has already been disposed of.</exception>
+        /// <exception cref="ObjectDisposedException">The AudioCaptureBase has already been disposed of.</exception>
         public int GetBufferSize()
         {
+            ValidateNotDisposed();
+
             AudioIOUtil.ThrowIfError(AudioInput.GetBufferSize(_handle, out var size));
             return size;
         }
@@ -185,6 +187,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     The current state is not <see cref="AudioIOState.Idle"/>.
         /// </exception>
+        /// <exception cref="ObjectDisposedException">The AudioCaptureBase has already been disposed of.</exception>
         /// <seealso cref="Unprepare"/>
         public void Prepare()
         {
@@ -202,6 +205,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     The current state is <see cref="AudioIOState.Idle"/>.
         /// </exception>
+        /// <exception cref="ObjectDisposedException">The AudioCaptureBase has already been disposed of.</exception>
         /// <seealso cref="Prepare"/>
         public void Unprepare()
         {
@@ -219,6 +223,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     The method is called in the <see cref="AsyncAudioCapture.DataAvailable"/> event handler.
         /// </exception>
+        /// <exception cref="ObjectDisposedException">The AudioCaptureBase has already been disposed of.</exception>
         /// <seealso cref="Resume"/>
         public void Pause()
         {
@@ -238,6 +243,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     The method is called in the <see cref="AsyncAudioCapture.DataAvailable"/> event handler.
         /// </exception>
+        /// <exception cref="ObjectDisposedException">The AudioCaptureBase has already been disposed of.</exception>
         /// <seealso cref="Pause"/>
         public void Resume()
         {
@@ -254,6 +260,7 @@ namespace Tizen.Multimedia
         /// Flushes and discards buffered audio data from the input stream.
         /// </summary>
         /// <exception cref="InvalidOperationException">The current state is <see cref="AudioIOState.Idle"/>.</exception>
+        /// <exception cref="ObjectDisposedException">The AudioCaptureBase has already been disposed of.</exception>
         public void Flush()
         {
             ValidateState(AudioIOState.Running, AudioIOState.Paused);
@@ -268,7 +275,11 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <param name="streamPolicy">The <see cref="AudioStreamPolicy"/> to apply for the AudioCapture.</param>
         /// <exception cref="ArgumentNullException"><paramref name="streamPolicy"/> is null.</exception>
-        /// <exception cref="ObjectDisposedException"><paramref name="streamPolicy"/> has already been disposed of.</exception>
+        /// <exception cref="ObjectDisposedException">
+        ///     <paramref name="streamPolicy"/> has already been disposed of.<br/>
+        ///     -or-<br/>
+        ///     The AudioCaptureBase has already been disposed of.
+        /// </exception>
         /// <exception cref="NotSupportedException"><paramref name="streamPolicy"/> is not supported.</exception>
         /// <exception cref="ArgumentException">Not able to retrieve information from <paramref name="streamPolicy"/>.</exception>
         public void ApplyStreamPolicy(AudioStreamPolicy streamPolicy)
@@ -306,7 +317,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     <paramref name="sampleType"/> is invalid.
         /// </exception>
-        /// <exception cref="InvalidOperationException">The required privilege is not specified.</exception>
+        /// <exception cref="UnauthorizedAccessException">The required privilege is not specified.</exception>
         /// <exception cref="NotSupportedException">The system does not support microphone.</exception>
         public AudioCapture(int sampleRate, AudioChannel channel, AudioSampleType sampleType)
             : base(sampleRate, channel, sampleType)
@@ -320,6 +331,7 @@ namespace Tizen.Multimedia
         /// <returns>The buffer of audio data captured.</returns>
         /// <exception cref="InvalidOperationException">The current state is not <see cref="AudioIOState.Running"/>.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="count"/> is equal to or less than zero.</exception>
+        /// <exception cref="ObjectDisposedException">The AudioCapture has already been disposed of.</exception>
         public byte[] Read(int count)
         {
             if (count <= 0)
@@ -366,7 +378,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     <paramref name="sampleType"/> is invalid.
         /// </exception>
-        /// <exception cref="InvalidOperationException">The required privilege is not specified.</exception>
+        /// <exception cref="UnauthorizedAccessException">The required privilege is not specified.</exception>
         /// <exception cref="NotSupportedException">The system does not support microphone.</exception>
         public AsyncAudioCapture(int sampleRate, AudioChannel channel, AudioSampleType sampleType)
             : base(sampleRate, channel, sampleType)

diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs
index c0a6319d3ecc7e75df869ac93e7f15e4beb4e49b..5cf47cf6914956ea282e08b6a8f4040666fb1452 100644 (file)
--- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs
@@ -56,7 +56,7 @@ namespace Tizen.Multimedia
         public event EventHandler<MediaStreamSeekingOccurredEventArgs> SeekingOccurred;
 
         /// <summary>
-        /// Gets the max size of the buffer.
+        /// Gets or sets the max size of the buffer.
         /// </summary>
         /// <value>The max size of the buffer. The default is 200000.</value>
         /// <remarks>If the buffer level overflows the max size, <see cref="BufferStatusChanged"/> will be raised with <see cref="MediaStreamBufferStatus.Overflow"/>.</remarks>
@@ -91,7 +91,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets the minimum threshold of the buffer, or zero if the <see cref="MediaStreamSource"/> is not assigned to a player.
+        /// Gets or sets the minimum threshold of the buffer.
         /// </summary>
         /// <value>The minimum threshold of the buffer in percentage. The default is zero.</value>
         /// <remarks>If the buffer level drops below the threshold value, <see cref="BufferStatusChanged"/> will be raised with <see cref="MediaStreamBufferStatus.Underrun"/>.</remarks>

diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs
index c1b35a0519140eec9473dbb3e96f72e93af0cb90..23be41231c63ce01bdd2832f34b0de7ea357a328 100644 (file)
--- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs
@@ -20,6 +20,7 @@ using System.Diagnostics;
 using System.IO;
 using System.Threading;
 using static Interop;
+using System.ComponentModel;
 
 namespace Tizen.Multimedia
 {
@@ -167,7 +168,7 @@ namespace Tizen.Multimedia
         /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
         /// <exception cref="ArgumentException"><paramref name="path"/> is an empty string.</exception>
         /// <exception cref="FileNotFoundException">The specified path does not exist.</exception>
-        /// <exception cref="ArgumentNullException">The path is null.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
         public void SetSubtitle(string path)
         {
             ValidateNotDisposed();
@@ -637,6 +638,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// This method supports the product infrastructure and is not intended to be used directly from application code.
         /// </summary>
+        [EditorBrowsable(EditorBrowsableState.Never)]
         protected static Exception GetException(int errorCode, string message) =>
             ((PlayerErrorCode)errorCode).GetException(message);
     }

diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs
index 35bbe7c49fd4bd444a39a327d83026617298d97e..83e02ba938a7ee6ceb0015de21f8f51e34da6f0d 100644 (file)
--- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs
@@ -15,6 +15,7 @@
  */
 
 using System;
+using System.ComponentModel;
 using System.Diagnostics;
 using Native = Interop.Display;
 
@@ -28,6 +29,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// This constructor supports the product infrastructure and is not intended to be used directly from application code.
         /// </summary>
+        [EditorBrowsable(EditorBrowsableState.Never)]
         protected PlayerDisplaySettings(Player player)
         {
             if (player == null)
@@ -99,7 +101,7 @@ namespace Tizen.Multimedia
         /// Gets or sets the rotation of the display.
         /// </summary>
         /// <value><see cref="Rotation.Rotate0"/>, <see cref="Rotation.Rotate90"/>, <see cref="Rotation.Rotate180"/>,
-        ///     <see cref="Rotation.Rotate270"/></value>
+        ///     <see cref="Rotation.Rotate270"/>.</value>
         /// <exception cref="InvalidOperationException">
         ///     Operation failed; internal error.
         /// </exception>

diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs
index 82f11e4a7090dc99a73ddc9ecf390058845368b0..50345dad6eb4bacf01262d1f0997ba1bfa0254d0 100644 (file)
--- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs
@@ -74,7 +74,7 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentOutOfRangeException">
         ///     <paramref name="index"/> is less than zero.<br/>
         ///     -or-<br/>
-        ///     <paramref name="index"/> is equal to or greater than <see cref="GetCount()"/>
+        ///     <paramref name="index"/> is equal to or greater than <see cref="GetCount()"/>.
         /// </exception>
         public string GetLanguageCode(int index)
         {
@@ -123,7 +123,7 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentOutOfRangeException">
         ///     <paramref name="value"/> is less than zero.<br/>
         ///     -or-<br/>
-        ///     <paramref name="value"/> is equal to or greater than <see cref="GetCount()"/>
+        ///     <paramref name="value"/> is equal to or greater than <see cref="GetCount()"/>.
         /// </exception>
         public int Selected
         {

diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs
index 40ca485d0ade189e4832ce37954909a6432d1ba8..e269cac2eefb5886f1b66d7fd6e70341543008c5 100644 (file)
--- a/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs
@@ -38,7 +38,7 @@ namespace Tizen.Multimedia
         public Size Size { get; }
 
         /// <summary>
-        /// Gets the fps of the new video
+        /// Gets the fps of the new video.
         /// </summary>
         public int Fps { get; }