[Multimedia] Fixed errors in the doc-comments. 54/156754/1
authorcoderhyme <jhyo.kim@samsung.com>
Fri, 20 Oct 2017 01:00:15 +0000 (10:00 +0900)
committercoderhyme <jhyo.kim@samsung.com>
Fri, 20 Oct 2017 01:00:57 +0000 (10:00 +0900)
Change-Id: I26b841e731fb05c2a16fbdb7d258d9619c54be51
Signed-off-by: coderhyme <jhyo.kim@samsung.com>
src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs
src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs
src/Tizen.Multimedia.Radio/Radio/Radio.cs
src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs
src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs
src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs
src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs
src/Tizen.Multimedia/AudioManager/VolumeLevel.cs
src/Tizen.Multimedia/Common/IMediaBuffer.cs

index cc06c34..36ca2a2 100644 (file)
@@ -442,7 +442,7 @@ namespace Tizen.Multimedia
         ///     -or-<br/>
         ///     The media file is read-only.
         /// </exception>
-        /// <exception cref="ArgumentNullException"><paramref name="path"/> is null</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
         /// <exception cref="FileNotFoundException">The file does not exist.</exception>
         /// <exception cref="UnauthorizedAccessException">The caller does not have required privilege to access the file.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
index 77f1bdf..43c03d3 100755 (executable)
@@ -22,7 +22,7 @@ namespace Tizen.Multimedia
     public class SyncLyrics
     {
         /// <summary>
-        /// Initializes a new instance of the MetadataExtractor class with the specified lyrics and the timestamp.
+        /// Initializes a new instance of the <see cref="SyncLyrics"/> class with the specified lyrics and the timestamp.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="lyrics">The text of synchronized lyrics.</param>
index e7bef77..8bf3f59 100755 (executable)
@@ -153,7 +153,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets the value indicating if the radio is muted.
+        /// Gets or sets the value indicating if the radio is muted.
         /// </summary>
         /// <value>
         /// true if the radio is muted; otherwise, false.
@@ -256,7 +256,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Starts the radio scanning and triggers the ScanInformationUpdated event when the scan information is updated.
+        /// Starts the radio scanning and triggers the <see cref="ScanUpdated"/> event when the scan information is updated.
         /// </summary>
         /// <remarks>The radio must be in the <see cref="RadioState.Ready"/> or <see cref="RadioState.Playing"/> state.</remarks>
         /// <exception cref="InvalidOperationException">The radio is not in the valid state.</exception>
index 174f670..72075d8 100644 (file)
@@ -29,7 +29,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets the tuned radio frequency that is scanned, in range [87500 ~ 108000] (kHz).
+        /// Gets the tuned radio frequency that is scanned, in the range of 87500 ~ 108000 kHz.
         /// </summary>
         public int Frequency { get; }
 
index cd0207b..89e7560 100755 (executable)
@@ -29,11 +29,11 @@ namespace Tizen.Multimedia
         private Interop.AudioStreamPolicy.FocusStateChangedCallback _focusStateChangedCallback;
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="AudioStreamPolicy"/> class with <see cref="AudioStreamType"/>
+        /// Initializes a new instance of the <see cref="AudioStreamPolicy"/> class with <see cref="AudioStreamType"/>.
         /// </summary>
         /// <remarks>
         /// To apply the stream policy according to this stream information, the AudioStreamPolicy should
-        /// be passed to other APIs related to playback or recording. (For example., <see cref="T:Tizen.MultimediaPlayer"/>,
+        /// be passed to other APIs related to playback or recording. (For example., <see cref="T:Tizen.Multimedia.Player"/>,
         /// <see cref="T:Tizen.Multimedia.WavPlayer"/> , etc.)
         /// </remarks>
         /// <param name="streamType">The type of the sound stream for which the policy needs to be created.</param>
index c8b3e70..e5a8b99 100644 (file)
@@ -53,7 +53,7 @@ namespace Tizen.Multimedia
         public AudioStreamFocusChangedReason Reason { get; }
 
         /// <summary>
-        /// Gets the requested behaviors that should be followed
+        /// Gets the requested behaviors that should be followed.
         /// </summary>
         /// <value>The requested behaviors that should be followed.</value>
         public AudioStreamBehaviors Behaviors { get; }
index 931d9c1..7a8cc90 100644 (file)
@@ -28,7 +28,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets the max volume level of the specified <see cref="AudioVolumeType"/>
+        /// Gets the max volume level of the specified <see cref="AudioVolumeType"/>.
         /// </summary>
         /// <param name="type">The <see cref="AudioVolumeType"/> to query.</param>
         /// <value>The maximum volume level.</value>
index cdfcbf0..6225d82 100644 (file)
@@ -28,7 +28,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets or sets the volume level of the specified <see cref="AudioVolumeType"/>
+        /// Gets or sets the volume level of the specified <see cref="AudioVolumeType"/>.
         /// </summary>
         /// <param name="type">The <see cref="AudioVolumeType"/> to control.</param>
         /// <value>The current volume level.</value>
@@ -36,10 +36,10 @@ namespace Tizen.Multimedia
         /// <privilege>http://tizen.org/privilege/volume.set</privilege>
         /// <exception cref="ArgumentException"><paramref name="type"/> is invalid.</exception>
         /// <exception cref="ArgumentOutOfRangeException">
-        ///     <paramref name="type"/> is <see cref="AudioVolumeType.None"/>.
-        ///     -or-
-        ///     <paramref name="value"/> is less than zero.
-        ///     -or-
+        ///     <paramref name="type"/> is <see cref="AudioVolumeType.None"/>.<br/>
+        ///     -or-<br/>
+        ///     <paramref name="value"/> is less than zero.<br/>
+        ///     -or-<br/>
         ///     <paramref name="value"/> is greater than <see cref="MaxVolumeLevel.this[AudioVolumeType]"/>.
         /// </exception>
         /// <exception cref="UnauthorizedAccessException">The caller does not have required privilege to set volume.</exception>
index 0a6969e..1d5204b 100644 (file)
@@ -52,7 +52,7 @@ namespace Tizen.Multimedia
         bool IsReadOnly { get; }
 
         /// <summary>
-        /// Copies data from a byte array to the buffer.
+        /// Copies data from the buffer to a byte array.
         /// </summary>
         /// <param name="dest">The array to copy to.</param>
         /// <param name="startIndex">The zero-based index in the source array where copying should start.</param>
@@ -63,7 +63,7 @@ namespace Tizen.Multimedia
         void CopyTo(byte[] dest, int startIndex, int length);
 
         /// <summary>
-        /// Copies data from a byte array to the buffer.
+        /// Copies data from the buffer to a byte array.
         /// </summary>
         /// <param name="dest">The array to copy to.</param>
         /// <param name="startIndex">The zero-based index in the source array where copying should start.</param>
@@ -76,7 +76,7 @@ namespace Tizen.Multimedia
         void CopyTo(byte[] dest, int startIndex, int length, int offset);
 
         /// <summary>
-        /// Copies data from the buffer to a byte array.
+        /// Copies data from a byte array to the buffer.
         /// </summary>
         /// <param name="source">The array to copy from.</param>
         /// <param name="startIndex">The zero-based index in the destination array where copying should start.</param>
@@ -88,7 +88,7 @@ namespace Tizen.Multimedia
         void CopyFrom(byte[] source, int startIndex, int length);
 
         /// <summary>
-        /// Copies data from the buffer to a byte array.
+        /// Copies data from a byte array to the buffer.
         /// </summary>
         /// <param name="source">The array to copy from.</param>
         /// <param name="startIndex">The zero-based index in the destination array where copying should start.</param>