[Multimedia] Fixed errors in the doc-comments of Recorder and StreamRecorder.

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

diff --git a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs
index f4dcd35..630d210 100755 (executable)
--- a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs
+++ b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs
@@ -138,8 +138,8 @@ namespace Tizen.Multimedia
         /// Prepares the media recorder for recording.
         /// </summary>
         /// <remarks>
-        /// The recorder should be in the <see cref="RecorderState.Idle"/> state.<br/>
-        /// The state of the recorder will be the <see cref="RecorderState.Ready"/> after this.<br/>
+        /// The recorder should be in the <see cref="RecorderState.Idle"/> state.
+        /// The state of the recorder will be the <see cref="RecorderState.Ready"/> after this.
         /// It has no effect if the current state is the <see cref="RecorderState.Ready"/>.
         /// </remarks>
         /// <exception cref="InvalidOperationException">

diff --git a/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.Capabilities.cs b/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.Capabilities.cs
index 9c3e223..7f1d3e0 100644 (file)
--- a/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.Capabilities.cs
+++ b/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.Capabilities.cs
@@ -61,7 +61,7 @@ namespace Tizen.Multimedia
         /// Gets the video resolutions that the current device supports.
         /// </summary>
         /// <feature>http://tizen.org/feature/camera</feature>
-        /// <param name="device">The camera device to retrieve the supported resolutions</param>
+        /// <param name="device">The camera device to retrieve the supported resolutions.</param>
         /// <exception cref="NotSupportedException">A required feature is not supported.</exception>
         /// <exception cref="ArgumentException"><paramref name="device"/> is invalid.</exception>
         public static IEnumerable<Size> GetSupportedVideoResolutions(CameraDevice device)

diff --git a/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs b/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs
index 414653b..cb396b0 100755 (executable)
--- a/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs
+++ b/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs
@@ -51,7 +51,8 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="VideoRecorder"/> class with the specified camera, video codec and file format.
+        /// Initializes a new instance of the <see cref="VideoRecorder"/> class with the specified
+        /// camera, video codec, and file format.
         /// </summary>
         /// <remarks>
         /// If the state of <see cref="Camera"/> is <see cref="CameraState.Created"/>,
@@ -92,8 +93,8 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="VideoRecorder"/> class with the specified camera, video codec,
-        /// audio codec and file format.
+        /// Initializes a new instance of the <see cref="VideoRecorder"/> class with the specified
+        /// camera, video codec, audio codec, and file format.
         /// </summary>
         /// <remarks>
         /// If the state of <see cref="Camera"/> is <see cref="CameraState.Created"/>,
@@ -115,7 +116,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     <paramref name="audioCodec"/> is not supported.<br/>
         ///     -or-<br/>
-        ///     <paramref name="fileFormat"/> is not supported with the specified video codec.
+        ///     <paramref name="fileFormat"/> is not supported with the specified video codec.<br/>
         ///     -or-<br/>
         ///     <paramref name="fileFormat"/> is not supported with the specified audio codec.
         /// </exception>
@@ -142,7 +143,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Sets the video codec and the file format for recording. Audio will not recorded.
+        /// Sets the video codec and the file format for recording. Audio will not be recorded.
         /// </summary>
         /// <param name="videoCodec">The codec for video encoding.</param>
         /// <param name="fileFormat">The format of result file.</param>
@@ -167,7 +168,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Sets the video codec, audio codec and the file format for recording.
+        /// Sets the video codec, audio codec, and the file format for recording.
         /// </summary>
         /// <param name="videoCodec">The codec for video encoding.</param>
         /// <param name="audioCodec">The codec for audio encoding.</param>
@@ -177,7 +178,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     <paramref name="audioCodec"/> is not supported.<br/>
         ///     -or-<br/>
-        ///     <paramref name="fileFormat"/> is not supported with the specified video codec.
+        ///     <paramref name="fileFormat"/> is not supported with the specified video codec.<br/>
         ///     -or-<br/>
         ///     <paramref name="fileFormat"/> is not supported with the specified audio codec.
         /// </exception>
@@ -232,7 +233,7 @@ namespace Tizen.Multimedia
         /// <remarks>
         /// The attribute is valid only in a video recorder.<br/>
         /// If the rate is in range of 0-1, the video is recorded in a slow motion mode.<br/>
-        /// If the rate is bigger than 1, the video is recorded in a fast motion mode.<br/>
+        /// If the rate is greater than 1, the video is recorded in a fast motion mode.<br/>
         /// <br/>
         /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or the <see cref="RecorderState.Ready"/> state.
         /// </remarks>

diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs
index 44aeb5e..f7fea50 100644 (file)
--- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs
+++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs
@@ -46,7 +46,7 @@ namespace Tizen.Multimedia
 
         /// <summary>
         /// Initialize a new instance of the <see cref="StreamRecorderAudioOptions"/> class with the specified
-        /// codec, sample rate, bit rate and channel value.
+        /// codec, sample rate, bit rate, and channel value.
         /// </summary>
         /// <param name="codec">The <see cref="RecorderAudioCodec"/> for encoding audio stream.</param>
         /// <param name="sampleRate">The sample rate for encoding audio stream.</param>

diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs
index 2ce5369..1c5c1f2 100644 (file)
--- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs
+++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs
@@ -105,7 +105,6 @@ namespace Tizen.Multimedia
         /// <remarks>
         /// After reaching the limitation, the data which is being recorded will
         /// be discarded and not written to the file.
-        /// The recorder state must be <see cref="RecorderState.Idle"/> state.
         /// </remarks>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
         /// <seealso cref="StreamRecorder.RecordingLimitReached"/>

diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
index a000330..40c13ef 100644 (file)
--- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
+++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
@@ -31,7 +31,7 @@ namespace Tizen.Multimedia
 
         /// <summary>
         /// Initialize a new instance of the <see cref="StreamRecorderVideoOptions"/> class with the specified
-        /// codec, resolution, source format and frame rate.
+        /// codec, resolution, source format, and frame rate.
         /// </summary>
         /// <param name="codec">The <see cref="RecorderVideoCodec"/> for encoding video stream.</param>
         /// <param name="resolution">The resolution of video recording.</param>
@@ -58,7 +58,7 @@ namespace Tizen.Multimedia
 
         /// <summary>
         /// Initialize a new instance of the <see cref="StreamRecorderVideoOptions"/> class with the specified
-        /// codec, resolution, source format, frame rate and bit rate.
+        /// codec, resolution, source format, frame rate, and bit rate.
         /// </summary>
         /// <param name="codec">The <see cref="RecorderVideoCodec"/> for encoding video stream.</param>
         /// <param name="resolution">The resolution of video recording.</param>