change \n to <br/> for Doc

Signed-off-by: SeokHoon Lee <andy.shlee@samsung.com>
Change-Id: I4b874f6a31f0857a8a50e61c28a1d9e6eb7f341e

diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroring.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroring.cs
index 824cd68..19643d0 100644 (file)
--- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroring.cs
+++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroring.cs
@@ -166,8 +166,8 @@ namespace Tizen.Multimedia.Remoting
         /// Prepares the screen mirroring with the specified display.
         /// </summary>
         /// <remarks>
-        /// The state must be <see cref="ScreenMirroringState.Idle"/>.\n
-        /// \n
+        /// The state must be <see cref="ScreenMirroringState.Idle"/>.<br/>
+        /// <br/>
         /// All supported resolutions will be candidates.
         /// </remarks>
         /// <param name="display">The display where the mirroring will be played on.</param>
@@ -176,8 +176,8 @@ namespace Tizen.Multimedia.Remoting
         /// </exception>
         /// <exception cref="ArgumentNullException"><paramref name="display"/> is null.</exception>
         /// <exception cref="InvalidOperationException">
-        ///     The current state is not in the valid.\n
-        ///     -or-\n
+        ///     The current state is not in the valid.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -195,14 +195,14 @@ namespace Tizen.Multimedia.Remoting
         /// <param name="display">The display where the mirroring will be played on.</param>
         /// <param name="resolutions">The desired resolutions.</param>
         /// <exception cref="ArgumentException">
-        ///    <paramref name="resolutions"/> contain invalid flags.\n
-        ///    -or-\n
+        ///    <paramref name="resolutions"/> contain invalid flags.<br/>
+        ///    -or-<br/>
         ///    <paramref name="display"/> has already been assigned to another.
         /// </exception>
         /// <exception cref="ArgumentNullException"><paramref name="display"/> is null.</exception>
         /// <exception cref="InvalidOperationException">
-        ///     The current state is not in the valid.\n
-        ///     -or-\n
+        ///     The current state is not in the valid.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -244,8 +244,8 @@ namespace Tizen.Multimedia.Remoting
         /// <privilege>http://tizen.org/privilege/internet</privilege>
         /// <exception cref="ArgumentNullException"><paramref name="sourceIp"/> is null.</exception>
         /// <exception cref="InvalidOperationException">
-        ///     The current state is not in the valid.\n
-        ///     -or-\n
+        ///     The current state is not in the valid.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ArgumentException"><paramref name="sourceIp"/> is a zero-length string, contains only white space.</exception>
@@ -288,8 +288,8 @@ namespace Tizen.Multimedia.Remoting
         /// <returns>A task that represents the asynchronous operation.</returns>
         /// <privilege>http://tizen.org/privilege/internet</privilege>
         /// <exception cref="InvalidOperationException">
-        ///     The current state is not in the valid.\n
-        ///     -or-\n
+        ///     The current state is not in the valid.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -319,8 +319,8 @@ namespace Tizen.Multimedia.Remoting
         /// <returns>A task that represents the asynchronous operation.</returns>
         /// <privilege>http://tizen.org/privilege/internet</privilege>
         /// <exception cref="InvalidOperationException">
-        ///     The current state is not in the valid.\n
-        ///     -or-\n
+        ///     The current state is not in the valid.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -350,8 +350,8 @@ namespace Tizen.Multimedia.Remoting
         /// <returns>A task that represents the asynchronous operation.</returns>
         /// <privilege>http://tizen.org/privilege/internet</privilege>
         /// <exception cref="InvalidOperationException">
-        ///     The current state is not in the valid.\n
-        ///     -or-\n
+        ///     The current state is not in the valid.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -380,8 +380,8 @@ namespace Tizen.Multimedia.Remoting
         /// </remarks>
         /// <privilege>http://tizen.org/privilege/internet</privilege>
         /// <exception cref="InvalidOperationException">
-        ///     The current state is not in the valid.\n
-        ///     -or-\n
+        ///     The current state is not in the valid.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -402,8 +402,8 @@ namespace Tizen.Multimedia.Remoting
         /// or <see cref="ScreenMirroringState.Disconnected"/>.
         /// </remarks>
         /// <exception cref="InvalidOperationException">
-        ///     The current state is not in the valid.\n
-        ///     -or-\n
+        ///     The current state is not in the valid.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>

diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs
index 59bd648..c3024ce 100644 (file)
--- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs
+++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs
@@ -37,8 +37,8 @@ namespace Tizen.Multimedia.Remoting
         /// Gets the negotiated audio codec.
         /// </summary>
         /// <exception cref="InvalidOperationException">
-        ///     Not connected to a source.\n
-        ///     \n
+        ///     Not connected to a source.<br/>
+        ///     <br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -59,8 +59,8 @@ namespace Tizen.Multimedia.Remoting
         /// Gets the negotiated audio channels.
         /// </summary>
         /// <exception cref="InvalidOperationException">
-        ///     Not connected to a source.\n
-        ///     \n
+        ///     Not connected to a source.<br/>
+        ///     <br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -81,8 +81,8 @@ namespace Tizen.Multimedia.Remoting
         /// Gets the negotiated audio sample rate.
         /// </summary>
         /// <exception cref="InvalidOperationException">
-        ///     Not connected to a source.\n
-        ///     \n
+        ///     Not connected to a source.<br/>
+        ///     <br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -103,8 +103,8 @@ namespace Tizen.Multimedia.Remoting
         /// Gets the negotiated audio bit width.
         /// </summary>
         /// <exception cref="InvalidOperationException">
-        ///     Not connected to a source.\n
-        ///     \n
+        ///     Not connected to a source.<br/>
+        ///     <br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>

diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs
index 0716436..35856f5 100644 (file)
--- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs
+++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs
@@ -36,8 +36,8 @@ namespace Tizen.Multimedia.Remoting
         /// Gets the negotiated video codec.
         /// </summary>
         /// <exception cref="InvalidOperationException">
-        ///     Not connected to a source.\n
-        ///     \n
+        ///     Not connected to a source.<br/>
+        ///     <br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -58,8 +58,8 @@ namespace Tizen.Multimedia.Remoting
         /// Gets the negotiated video resolution.
         /// </summary>
         /// <exception cref="InvalidOperationException">
-        ///     Not connected to a source.\n
-        ///     \n
+        ///     Not connected to a source.<br/>
+        ///     <br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>
@@ -81,8 +81,8 @@ namespace Tizen.Multimedia.Remoting
         /// Gets the negotiated video frame rate.
         /// </summary>
         /// <exception cref="InvalidOperationException">
-        ///     Not connected to a source.\n
-        ///     \n
+        ///     Not connected to a source.<br/>
+        ///     <br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="ScreenMirroring"/> has already been disposed.</exception>

diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs
index 99fd6d8..8aed8ea 100644 (file)
--- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs
+++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs
@@ -142,9 +142,9 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <remarks>
         /// The recorder state must be <see cref="RecorderState.Ready"/> state by
-        /// <see cref="Prepare(StreamRecorderOptions)"/>, <see cref="Cancel"/> and <see cref="Commit"/>.\n
-        /// The recorder state will be <see cref="RecorderState.Idle"/>.\n
-        /// \n
+        /// <see cref="Prepare(StreamRecorderOptions)"/>, <see cref="Cancel"/> and <see cref="Commit"/>.<br/>
+        /// The recorder state will be <see cref="RecorderState.Idle"/>.<br/>
+        /// <br/>
         /// It has no effect if the recorder is already in the <see cref="RecorderState.Idle"/> state.
         /// </remarks>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
@@ -168,8 +168,8 @@ namespace Tizen.Multimedia
         /// <remarks>
         ///    The recorder state must be <see cref="RecorderState.Ready"/> state by
         ///    <see cref="Prepare(StreamRecorderOptions)"/> or
-        ///    <see cref="RecorderState.Paused"/> state by <see cref="Pause"/>.\n
-        /// \n
+        ///    <see cref="RecorderState.Paused"/> state by <see cref="Pause"/>.<br/>
+        /// <br/>
         /// It has no effect if the recorder is already in the <see cref="RecorderState.Recording"/> state.
         /// </remarks>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
@@ -194,10 +194,10 @@ namespace Tizen.Multimedia
         /// Pauses recording.
         /// </summary>
         /// <remarks>
-        /// Recording can be resumed with <see cref="Start"/>.\n
-        /// \n
-        ///    The recorder state must be <see cref="RecorderState.Recording"/> state by <see cref="Start"/> \n
-        /// \n
+        /// Recording can be resumed with <see cref="Start"/>.<br/>
+        /// <br/>
+        ///    The recorder state must be <see cref="RecorderState.Recording"/> state by <see cref="Start"/> <br/>
+        /// <br/>
         /// It has no effect if the recorder is already in the <see cref="RecorderState.Paused"/> state.
         /// </remarks>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
@@ -222,9 +222,9 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <remarks>
         /// The recorder state must be <see cref="RecorderState.Recording"/> state by <see cref="Start"/> or
-        /// <see cref="RecorderState.Paused"/> state by <see cref="Pause"/>.\n
-        /// \n
-        /// The recorder state will be <see cref="RecorderState.Ready"/> after commit.\n
+        /// <see cref="RecorderState.Paused"/> state by <see cref="Pause"/>.<br/>
+        /// <br/>
+        /// The recorder state will be <see cref="RecorderState.Ready"/> after commit.<br/>
         /// <para>
         /// http://tizen.org/privilege/mediastorage is needed if the save path are relevant to media storage.
         /// http://tizen.org/privilege/externalstorage is needed if the save path are relevant to external storage.
@@ -278,14 +278,14 @@ namespace Tizen.Multimedia
         /// The recorder state must be <see cref="RecorderState.Recording"/> state by <see cref="Start"/>.
         /// </remarks>
         /// <exception cref="InvalidOperationException">
-        ///     The recorder is not in the valid state.\n
-        ///     -or-\n
-        ///     <paramref name="packet"/> is an audio packet but audio recording is not enabled(See <see cref="StreamRecorderOptions.Audio"/>).\n
-        ///     -or-\n
-        ///     <paramref name="packet"/> is a video packet but video recording is not enabled(See <see cref="StreamRecorderOptions.Video"/>).\n
-        ///     -or-\n
-        ///     <paramref name="packet"/> is a video packet but the <see cref="VideoMediaFormat.MimeType"/> does not match the video source format.\n
-        ///     -or-\n
+        ///     The recorder is not in the valid state.<br/>
+        ///     -or-<br/>
+        ///     <paramref name="packet"/> is an audio packet but audio recording is not enabled(See <see cref="StreamRecorderOptions.Audio"/>).<br/>
+        ///     -or-<br/>
+        ///     <paramref name="packet"/> is a video packet but video recording is not enabled(See <see cref="StreamRecorderOptions.Video"/>).<br/>
+        ///     -or-<br/>
+        ///     <paramref name="packet"/> is a video packet but the <see cref="VideoMediaFormat.MimeType"/> does not match the video source format.<br/>
+        ///     -or-<br/>
         ///     An internal error occurs.
         /// </exception>
         /// <exception cref="ObjectDisposedException">The <see cref="StreamRecorder"/> has already been disposed.</exception>

diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs
index 3aabb7d..44aeb5e 100644 (file)
--- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs
+++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs
@@ -54,10 +54,10 @@ namespace Tizen.Multimedia
         /// <param name="channels">The number of channels for encoding audio stream.</param>
         /// <exception cref="ArgumentException"><paramref name="codec"/> is not valid.</exception>
         /// <exception cref="ArgumentOutOfRangeException">
-        ///     <paramref name="sampleRate"/> is less than zero.\n
-        ///     -or-\n
-        ///     <paramref name="bitRate"/> is less than or equal to zero.\n
-        ///     -or-\n
+        ///     <paramref name="sampleRate"/> is less than zero.<br/>
+        ///     -or-<br/>
+        ///     <paramref name="bitRate"/> is less than or equal to zero.<br/>
+        ///     -or-<br/>
         ///     <paramref name="channels"/> is less than or equal to zero.
         /// </exception>
         public StreamRecorderAudioOptions(RecorderAudioCodec codec, int sampleRate, int bitRate, int channels)

diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs
index 49d9098..2ce5369 100644 (file)
--- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs
+++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs
@@ -37,8 +37,8 @@ namespace Tizen.Multimedia
         /// <param name="fileFormat">The file format of output file.</param>
         /// <exception cref="ArgumentNullException"><paramref name="savePath"/>is null.</exception>
         /// <exception cref="ArgumentException">
-        ///     <paramref name="savePath"/>is an empty string.\n
-        ///     -or-\n
+        ///     <paramref name="savePath"/>is an empty string.<br/>
+        ///     -or-<br/>
         ///     <paramref name="fileFormat"/> is not valid.
         /// </exception>
         public StreamRecorderOptions(string savePath, RecorderFileFormat fileFormat)

diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
index 3460532..600b1a2 100644 (file)
--- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
+++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
@@ -41,14 +41,14 @@ namespace Tizen.Multimedia
         /// <see cref="BitRate"/> will be set as default.
         /// </remarks>
         /// <exception cref="ArgumentException">
-        ///     <paramref name="codec"/> is not valid.\n
-        ///     -or-\n
-        ///     <paramref name="sourceFormat"/> is not valid.\n
+        ///     <paramref name="codec"/> is not valid.<br/>
+        ///     -or-<br/>
+        ///     <paramref name="sourceFormat"/> is not valid.<br/>
         /// </exception>
         /// <exception cref="ArgumentOutOfRangeException">
-        ///     Width or height of <paramref name="resolution"/> is less than or equal to zero.\n
-        ///     -or-\n
-        ///     <paramref name="frameRate"/> is less than or equal to zero.\n
+        ///     Width or height of <paramref name="resolution"/> is less than or equal to zero.<br/>
+        ///     -or-<br/>
+        ///     <paramref name="frameRate"/> is less than or equal to zero.<br/>
         /// </exception>
         public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution,
             StreamRecorderVideoFormat sourceFormat, int frameRate) :
@@ -66,15 +66,15 @@ namespace Tizen.Multimedia
         /// <param name="frameRate">The frame rate for encoding video stream.</param>
         /// <param name="bitRate">The bit rate for encoding video stream.</param>
         /// <exception cref="ArgumentException">
-        ///     <paramref name="codec"/> is not valid.\n
-        ///     -or-\n
-        ///     <paramref name="sourceFormat"/> is not valid.\n
+        ///     <paramref name="codec"/> is not valid.<br/>
+        ///     -or-<br/>
+        ///     <paramref name="sourceFormat"/> is not valid.<br/>
         /// </exception>
         /// <exception cref="ArgumentOutOfRangeException">
-        ///     Width or height of <paramref name="resolution"/> is less than or equal to zero.\n
-        ///     -or-\n
-        ///     <paramref name="frameRate"/> is less than or equal to zero.\n
-        ///     -or-\n
+        ///     Width or height of <paramref name="resolution"/> is less than or equal to zero.<br/>
+        ///     -or-<br/>
+        ///     <paramref name="frameRate"/> is less than or equal to zero.<br/>
+        ///     -or-<br/>
         ///     <paramref name="bitRate"/> is less than zero.
         /// </exception>
         public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution,