From ead9fda25d4f8276a5963199af8b020522f1a0ff Mon Sep 17 00:00:00 2001 From: coderhyme Date: Fri, 20 Oct 2017 10:00:15 +0900 Subject: [PATCH] [Multimedia] Fixed errors in the doc-comments. Change-Id: I26b841e731fb05c2a16fbdb7d258d9619c54be51 Signed-off-by: coderhyme --- src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs | 2 +- src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs | 2 +- src/Tizen.Multimedia.Radio/Radio/Radio.cs | 4 ++-- src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs | 2 +- src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs | 4 ++-- .../AudioStreamPolicyFocusStateChangedEventArgs.cs | 2 +- src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs | 2 +- src/Tizen.Multimedia/AudioManager/VolumeLevel.cs | 10 +++++----- src/Tizen.Multimedia/Common/IMediaBuffer.cs | 8 ++++---- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs index cc06c34..36ca2a2 100644 --- a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs @@ -442,7 +442,7 @@ namespace Tizen.Multimedia /// -or-
/// The media file is read-only. /// - /// is null + /// is null. /// The file does not exist. /// The caller does not have required privilege to access the file. /// The has already been disposed of. diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs index 77f1bdf..43c03d3 100755 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia public class SyncLyrics { /// - /// Initializes a new instance of the MetadataExtractor class with the specified lyrics and the timestamp. + /// Initializes a new instance of the class with the specified lyrics and the timestamp. /// /// 3 /// The text of synchronized lyrics. diff --git a/src/Tizen.Multimedia.Radio/Radio/Radio.cs b/src/Tizen.Multimedia.Radio/Radio/Radio.cs index e7bef77..8bf3f59 100755 --- a/src/Tizen.Multimedia.Radio/Radio/Radio.cs +++ b/src/Tizen.Multimedia.Radio/Radio/Radio.cs @@ -153,7 +153,7 @@ namespace Tizen.Multimedia } /// - /// Gets the value indicating if the radio is muted. + /// Gets or sets the value indicating if the radio is muted. /// /// /// true if the radio is muted; otherwise, false. @@ -256,7 +256,7 @@ namespace Tizen.Multimedia } /// - /// Starts the radio scanning and triggers the ScanInformationUpdated event when the scan information is updated. + /// Starts the radio scanning and triggers the event when the scan information is updated. /// /// The radio must be in the or state. /// The radio is not in the valid state. diff --git a/src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs b/src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs index 174f670..72075d8 100644 --- a/src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs @@ -29,7 +29,7 @@ namespace Tizen.Multimedia } /// - /// 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. /// public int Frequency { get; } diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs index cd0207b..89e7560 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs @@ -29,11 +29,11 @@ namespace Tizen.Multimedia private Interop.AudioStreamPolicy.FocusStateChangedCallback _focusStateChangedCallback; /// - /// Initializes a new instance of the class with + /// Initializes a new instance of the class with . /// /// /// 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., , + /// be passed to other APIs related to playback or recording. (For example., , /// , etc.) /// /// The type of the sound stream for which the policy needs to be created. diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs index c8b3e70..e5a8b99 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs @@ -53,7 +53,7 @@ namespace Tizen.Multimedia public AudioStreamFocusChangedReason Reason { get; } /// - /// Gets the requested behaviors that should be followed + /// Gets the requested behaviors that should be followed. /// /// The requested behaviors that should be followed. public AudioStreamBehaviors Behaviors { get; } diff --git a/src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs b/src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs index 931d9c1..7a8cc90 100644 --- a/src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs +++ b/src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs @@ -28,7 +28,7 @@ namespace Tizen.Multimedia } /// - /// Gets the max volume level of the specified + /// Gets the max volume level of the specified . /// /// The to query. /// The maximum volume level. diff --git a/src/Tizen.Multimedia/AudioManager/VolumeLevel.cs b/src/Tizen.Multimedia/AudioManager/VolumeLevel.cs index cdfcbf0..6225d82 100644 --- a/src/Tizen.Multimedia/AudioManager/VolumeLevel.cs +++ b/src/Tizen.Multimedia/AudioManager/VolumeLevel.cs @@ -28,7 +28,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the volume level of the specified + /// Gets or sets the volume level of the specified . /// /// The to control. /// The current volume level. @@ -36,10 +36,10 @@ namespace Tizen.Multimedia /// http://tizen.org/privilege/volume.set /// is invalid. /// - /// is . - /// -or- - /// is less than zero. - /// -or- + /// is .
+ /// -or-
+ /// is less than zero.
+ /// -or-
/// is greater than . /// /// The caller does not have required privilege to set volume. diff --git a/src/Tizen.Multimedia/Common/IMediaBuffer.cs b/src/Tizen.Multimedia/Common/IMediaBuffer.cs index 0a6969e..1d5204b 100644 --- a/src/Tizen.Multimedia/Common/IMediaBuffer.cs +++ b/src/Tizen.Multimedia/Common/IMediaBuffer.cs @@ -52,7 +52,7 @@ namespace Tizen.Multimedia bool IsReadOnly { get; } /// - /// Copies data from a byte array to the buffer. + /// Copies data from the buffer to a byte array. /// /// The array to copy to. /// The zero-based index in the source array where copying should start. @@ -63,7 +63,7 @@ namespace Tizen.Multimedia void CopyTo(byte[] dest, int startIndex, int length); /// - /// Copies data from a byte array to the buffer. + /// Copies data from the buffer to a byte array. /// /// The array to copy to. /// The zero-based index in the source array where copying should start. @@ -76,7 +76,7 @@ namespace Tizen.Multimedia void CopyTo(byte[] dest, int startIndex, int length, int offset); /// - /// Copies data from the buffer to a byte array. + /// Copies data from a byte array to the buffer. /// /// The array to copy from. /// The zero-based index in the destination array where copying should start. @@ -88,7 +88,7 @@ namespace Tizen.Multimedia void CopyFrom(byte[] source, int startIndex, int length); /// - /// Copies data from the buffer to a byte array. + /// Copies data from a byte array to the buffer. /// /// The array to copy from. /// The zero-based index in the destination array where copying should start. -- 2.7.4