[Player] Updated comments.
authorcoderhyme <jhyo.kim@samsung.com>
Thu, 29 Jun 2017 08:18:25 +0000 (17:18 +0900)
committercoderhyme <jhyo.kim@samsung.com>
Thu, 29 Jun 2017 08:18:25 +0000 (17:18 +0900)
Removed meaningless TODO comment.
Added remarks description for Player.Start().

Change-Id: I8854a4e98090126d36c5e48ac0b9a5abf0abb119
Signed-off-by: coderhyme <jhyo.kim@samsung.com>
src/Tizen.Multimedia.MediaPlayer/Player/CapturedFrame.cs
src/Tizen.Multimedia.MediaPlayer/Player/Player.cs

index f9a5157..1bd3cac 100644 (file)
@@ -17,7 +17,6 @@ using System.Diagnostics;
 
 namespace Tizen.Multimedia
 {
-    //TODO we need a better name.
     /// <summary>
     /// Represents data for a video frame captured.
     /// </summary>
index ea85757..ac81e4f 100644 (file)
@@ -259,7 +259,6 @@ namespace Tizen.Multimedia
             {
                 ValidateNotDisposed();
 
-                //TODO is this needed?
                 if (IsPreparing())
                 {
                     return PlayerState.Preparing;
@@ -805,13 +804,14 @@ namespace Tizen.Multimedia
             _source = null;
         }
 
-        //TODO remarks needs to be updated. see the native reference.
         /// <summary>
         /// Starts or resumes playback.
         /// </summary>
         /// <remarks>
         /// The player must be in the <see cref="PlayerState.Ready"/> or <see cref="PlayerState.Paused"/> state.
-        /// It has no effect if the player is already in the <see cref="PlayerState.Playing"/> state.
+        /// It has no effect if the player is already in the <see cref="PlayerState.Playing"/> state.\n
+        /// \n
+        /// Sound can be mixed with other sounds if you don't control the stream focus using <see cref="ApplyAudioStreamPolicy"/>.
         /// </remarks>
         /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
         /// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
@@ -819,6 +819,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="Stop"/>
         /// <seealso cref="Pause"/>
         /// <seealso cref="PlaybackCompleted"/>
+        /// <seealso cref="ApplyAudioStreamPolicy"/>
         public virtual void Start()
         {
             Log.Debug(PlayerLog.Tag, PlayerLog.Enter);