[Mirroring] Clarify C# API description

Clarify C# Screen mirroring API description more.
Added more detailed description about insufficient or ambiguous description in C# Screen mirroring documents.

Change-Id: Idc6e44a20a49f91abb7f1d13c0847df90441837d
Signed-off-by: Hyunsoo, Park <hance.park@samsung.com>

diff --git a/src/Tizen.Multimedia/ScreenMirroring/AudioInformation.cs b/src/Tizen.Multimedia/ScreenMirroring/AudioInformation.cs
index de12e48..f3dab42 100755 (executable)
--- a/src/Tizen.Multimedia/ScreenMirroring/AudioInformation.cs
+++ b/src/Tizen.Multimedia/ScreenMirroring/AudioInformation.cs
@@ -20,11 +20,11 @@ using System.Runtime.InteropServices;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// Audio Information
+    /// Audio Information class provides audio information which is negotiated with source device for screen mirroring. e.g codec
     /// </summary>
     /// <remarks>
-    /// This class provides properties and API that are required for setting
-    /// audio information of a player.
+    /// This class provides properties and API that are required for setting audio information.
+    /// For getting property using this api, we should call it after connectAsync() api.
     /// </remarks>
     public class AudioInformation
     {
@@ -39,9 +39,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Get Audio Codec.
+        /// Get audio codec.
         /// </summary>
-        /// <value> Audio Codec </value>
+        /// <value> Get audio codec which is one of enums in 'AudioCodec' which is negotiaged with source device.  </value>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to an internal error</exception>
         public AudioCodec Codec
         {
@@ -62,7 +62,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Get audio channel.
         /// </summary>
-        /// <value> AudioChannel </value>
+        /// <value> Get audio channel property of audio information which is negotiated with source device. </value>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to an internal error</exception>
         public int Channel
         {
@@ -83,7 +83,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Get audio sample rate.
         /// </summary>
-        /// <value> AudioSampleRate </value>
+        /// <value> Get audio sample rate property which is negotiated with source device. </value>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to an internal error</exception>
         public int SampleRate
         {
@@ -104,7 +104,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Get audio bitwidth.
         /// </summary>
-        /// <value> AudioBitwidth </value>
+        /// <value> Get audio bitwidth property which is negotiated with source device. </value>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to an internal error</exception>
         public int BitWidth
         {

diff --git a/src/Tizen.Multimedia/ScreenMirroring/ScreenMirroring.cs b/src/Tizen.Multimedia/ScreenMirroring/ScreenMirroring.cs
index a4b7539..aa5568a 100755 (executable)
--- a/src/Tizen.Multimedia/ScreenMirroring/ScreenMirroring.cs
+++ b/src/Tizen.Multimedia/ScreenMirroring/ScreenMirroring.cs
@@ -24,7 +24,10 @@ namespace Tizen.Multimedia
     }
 
     /// <summary>
-    /// Screen mirroring.
+    /// ScreenMirroring class provides methods to function as screen mirroring application as sink.
+    /// It gives the ability to connect to and disconnect from a screen mirroring source, and
+    /// start, pause, and resume the screen mirroring sink, set the resolution or display,
+    /// register state change callback function.
     /// </summary>
     public class ScreenMirroring : IDisposable
     {
@@ -43,7 +46,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Initializes a new instance of the ScreenMirroring class with parameters Ip, Port, Surface type and Display handle.
         /// Object should be created only when Ip and Port are available.
-        /// Create api will create a new handle with the given parameters.
+        /// Create(i.e constructor) api will create a new handle with the given parameters.
         /// </summary>
         /// <param name="type">Type.</param>
         /// <param name="display">Display.</param>

diff --git a/src/Tizen.Multimedia/ScreenMirroring/StateChangedEventArgs.cs b/src/Tizen.Multimedia/ScreenMirroring/StateChangedEventArgs.cs
index 6db0132..7bf0c32 100755 (executable)
--- a/src/Tizen.Multimedia/ScreenMirroring/StateChangedEventArgs.cs
+++ b/src/Tizen.Multimedia/ScreenMirroring/StateChangedEventArgs.cs
@@ -19,10 +19,10 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// StateChanged event arguments
+    /// Get value of changed state. It provides getting state values which are returned when state is changed.
     /// </summary>
     /// <remarks>
-    /// StateChanged event arguments
+    /// Return error and state code.
     /// </remarks>
     public class StateChangedEventArgs : EventArgs
     {
@@ -41,9 +41,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Get the error.
+        /// Get the error code of screen mirroring.
         /// </summary>
-        /// <value> error code </value>
+        /// <value> Get the error code which is one of enums in 'ScreenMirroringErrorCode' when screen mirroring error is occurred.</value>
         public ScreenMirroringErrorCode Error
         {
             get
@@ -53,9 +53,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Get the current state.
+        /// Get the current state of screen mirroring.
         /// </summary>
-        /// <value> current state </value>
+        /// <value> Get state code which is one of enums in 'ScreenMirroringSinkState' when screen mirroring state is changed. </value>
         public ScreenMirroringSinkState State
         {
             get

diff --git a/src/Tizen.Multimedia/ScreenMirroring/VideoInformation.cs b/src/Tizen.Multimedia/ScreenMirroring/VideoInformation.cs
index 511f402..d8ccabf 100755 (executable)
--- a/src/Tizen.Multimedia/ScreenMirroring/VideoInformation.cs
+++ b/src/Tizen.Multimedia/ScreenMirroring/VideoInformation.cs
@@ -21,11 +21,11 @@ using System.Runtime.InteropServices;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// Video Information
+    /// Video Information class provides video information which is negotiated with source device for screen mirroring. e.g codec
     /// </summary>
     /// <remarks>
-    /// This class provides properties and API that are required for setting
-    /// video information of a player.
+    /// This class provides properties and API that are required for setting video information.
+    /// For getting property using this api, we should call it after connectAsync() api.
     /// </remarks>
     public class VideoInformation
     {
@@ -40,9 +40,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Get video Codec.
+        /// Get video codec.
         /// </summary>
-        /// <value> Video Codec </value>
+        /// <value> Get video codec which is one of enums in 'VideoCodec' which is negotiaged with source device. </value>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to an internal error</exception>
         public VideoCodec Codec
         {
@@ -63,7 +63,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Get height of video resolution.
         /// </summary>
-        /// <value> Video Resolution Height </value>
+        /// <value> Get height property of video resolution which is negotiated with source device. </value>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to an internal error</exception>
         public int Height
         {
@@ -82,9 +82,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Get width of video resolution.
+        /// Get width of video.
         /// </summary>
-        /// <value> Video Resolution Width </value>
+        /// <value> Get width property of video resolution which is negotiated with source device. </value>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to an internal error</exception>
         public int Width
         {
@@ -103,9 +103,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Get width of video frame rate.
+        /// Get video frame rate.
         /// </summary>
-        /// <value> Video FrameRate </value>
+        /// <value> Get video frame rate property which is negotiated with source device.  </value>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to an internal error</exception>
         public int FrameRate
         {