From 44ead7f29cd77ac9c9e5c0390b7c6e7ba8e32153 Mon Sep 17 00:00:00 2001 From: Editor Date: Thu, 28 Dec 2017 15:05:41 +0530 Subject: [PATCH] Review System.Usb API cs files Change-Id: I45edd68eebcc4bb075b7669d523bc5bbeefa10d9 --- src/Tizen.System.Usb/Interop/Interop.ErrorCode.cs | 8 ++--- src/Tizen.System.Usb/Usb/EndpointDirection.cs | 8 ++--- src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs | 6 ++-- src/Tizen.System.Usb/Usb/HotplugEventType.cs | 6 ++-- src/Tizen.System.Usb/Usb/SynchronizationType.cs | 8 ++--- src/Tizen.System.Usb/Usb/UsageType.cs | 8 ++--- src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs | 18 +++++----- src/Tizen.System.Usb/Usb/UsbConfiguration.cs | 24 ++++++------- src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs | 22 ++++++------ src/Tizen.System.Usb/Usb/UsbDevice.cs | 40 +++++++++++----------- src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs | 16 ++++----- src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs | 20 +++++------ src/Tizen.System.Usb/Usb/UsbEndpoint.cs | 8 ++--- src/Tizen.System.Usb/Usb/UsbInterface.cs | 22 ++++++------ src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs | 20 +++++------ src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs | 6 ++-- src/Tizen.System.Usb/Usb/UsbManager.cs | 14 ++++---- 17 files changed, 127 insertions(+), 127 deletions(-) diff --git a/src/Tizen.System.Usb/Interop/Interop.ErrorCode.cs b/src/Tizen.System.Usb/Interop/Interop.ErrorCode.cs index 38d9ee2..9d6c8d6 100644 --- a/src/Tizen.System.Usb/Interop/Interop.ErrorCode.cs +++ b/src/Tizen.System.Usb/Interop/Interop.ErrorCode.cs @@ -56,9 +56,9 @@ internal static class ErrorCodeExtensions } /// - /// Utility method to check for error, returns false if failed and print warning messages + /// The Utility method to check for an error, returns false if failed and prints warning messages. /// - /// true in case of no error, false otherwise + /// true in case of no error, false otherwise. internal static bool WarnIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0) { if (err.IsFailed()) @@ -70,9 +70,9 @@ internal static class ErrorCodeExtensions } /// - /// Utility method to check for error, returns false if failed and throw exception + /// The Utility method checks for an error, returns false if failed and throws an exception. /// - /// true in case of no error + /// true in case of no error. internal static bool ThrowIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0) { if (err.IsFailed()) diff --git a/src/Tizen.System.Usb/Usb/EndpointDirection.cs b/src/Tizen.System.Usb/Usb/EndpointDirection.cs index 597cf39..5c1ea00 100644 --- a/src/Tizen.System.Usb/Usb/EndpointDirection.cs +++ b/src/Tizen.System.Usb/Usb/EndpointDirection.cs @@ -17,21 +17,21 @@ namespace Tizen.System.Usb { /// - /// Enumeration of transfer direction for Endpoints. + /// Enumeration for the transfer directions for endpoints. /// /// 4 public enum EndpointDirection { /// - /// IN direction + /// In direction. /// In = Interop.EndpointDirection.In, /// - /// OUT direction + /// Out direction. /// Out = Interop.EndpointDirection.Out, /// - /// Bi-directional + /// Bidirectional. /// InOut = Interop.EndpointDirection.InOut, } diff --git a/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs b/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs index 48e94ea..29ab147 100644 --- a/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs +++ b/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System.Usb { /// - /// Event arguments for Hot Plugged event for USB devices. + /// Event arguments for the Hot Plugged event for USB devices. /// /// 4 public class HotPluggedEventArgs : EventArgs @@ -31,13 +31,13 @@ namespace Tizen.System.Usb } /// - /// USB Device + /// USB device. /// /// 4 public UsbDevice Device { get; } /// - /// Event Type + /// Event type. /// /// 4 public HotplugEventType EventType { get; } diff --git a/src/Tizen.System.Usb/Usb/HotplugEventType.cs b/src/Tizen.System.Usb/Usb/HotplugEventType.cs index 1f47cf8..66f141d 100644 --- a/src/Tizen.System.Usb/Usb/HotplugEventType.cs +++ b/src/Tizen.System.Usb/Usb/HotplugEventType.cs @@ -17,17 +17,17 @@ namespace Tizen.System.Usb { /// - /// Enumeration of hot plugged event type for USB devices. + /// Enumeration for the Hot Plugged event type for USB devices. /// /// 4 public enum HotplugEventType { /// - /// USB device is attached + /// USB device is attached. /// Attach = Interop.HotplugEventType.Attach, /// - /// USB device is detached + /// USB device is detached. /// Detach = Interop.HotplugEventType.Detach, } diff --git a/src/Tizen.System.Usb/Usb/SynchronizationType.cs b/src/Tizen.System.Usb/Usb/SynchronizationType.cs index 4f2cc86..7c6124e 100644 --- a/src/Tizen.System.Usb/Usb/SynchronizationType.cs +++ b/src/Tizen.System.Usb/Usb/SynchronizationType.cs @@ -17,21 +17,21 @@ namespace Tizen.System.Usb { /// - /// Enumeration of isochronous endpoint's synchronization type. + /// Enumeration for the isochronous endpoints synchronization types. /// /// 4 public enum SynchronizationType { /// - /// Asynchronous + /// Asynchronous. /// Asynchronous = Interop.SynchronizationType.Async, /// - /// Adaptive + /// Adaptive. /// Adaptive = Interop.SynchronizationType.Adaptive, /// - /// Synchronous + /// Synchronous. /// Synchronous = Interop.SynchronizationType.Sync, } diff --git a/src/Tizen.System.Usb/Usb/UsageType.cs b/src/Tizen.System.Usb/Usb/UsageType.cs index e0384e6..a925463 100644 --- a/src/Tizen.System.Usb/Usb/UsageType.cs +++ b/src/Tizen.System.Usb/Usb/UsageType.cs @@ -17,21 +17,21 @@ namespace Tizen.System.Usb { /// - /// Enumeration of an endpoint's usage type. + /// Enumeration for an endpoint's usage types. /// /// 4 public enum UsageType { /// - /// Data endpoint + /// Data endpoint. /// Data = Interop.UsageType.Data, /// - /// Feedback endpoint + /// Feedback endpoint. /// Feedback = Interop.UsageType.Feedback, /// - /// Implicit feedback Data endpoint + /// Implicit feedback data endpoint. /// Implicit = Interop.UsageType.Implicit, } diff --git a/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs index 282509a..9dbfcdb 100644 --- a/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System.Usb { /// - /// USB Bulk Endpoint class. + /// The USB Bulk Endpoint class. /// /// 4 public class UsbBulkEndpoint : UsbEndpoint @@ -29,20 +29,20 @@ namespace Tizen.System.Usb } /// - /// Performs a USB transfer on given endpoint. Direction of transfer is determined by the endpoint. + /// Performs a USB transfer on a given endpoint. The direction of transfer is determined by the endpoint. /// - /// Suitably-sized data buffer for either input or output (depending on endpoint). + /// Suitably-sized data buffer for either an input or output (depending on the endpoint). /// - /// For writes, the number of bytes from data to be sent, for reads the maximum number of bytes to receive + /// For writes, the number of bytes from the data to be sent. For reads, the maximum number of bytes to receive /// into the data buffer. /// /// - /// Time (in milliseconds) that this function should wait for before giving up due to no response being - /// received(for an unlimited timeout 0 value should be used). + /// The time (in milliseconds) that this function should wait for, before giving up due to no response being + /// received (for an unlimited timeout, 0 value should be used). /// - /// Number of bytes actually transferred. - /// Throws exception if device is disconnected or not opened for operation. - /// Throws exception if transfer timed-out. + /// The number of bytes actually transferred. + /// Throws an exception if the device is disconnected or not opened for an operation. + /// Throws an exception if the transfer is timed out. /// 4 public int Transfer(byte[] buffer, int length, uint timeout) { diff --git a/src/Tizen.System.Usb/Usb/UsbConfiguration.cs b/src/Tizen.System.Usb/Usb/UsbConfiguration.cs index 502d0b2..98262d9 100644 --- a/src/Tizen.System.Usb/Usb/UsbConfiguration.cs +++ b/src/Tizen.System.Usb/Usb/UsbConfiguration.cs @@ -21,7 +21,7 @@ using System.Collections.Generic; namespace Tizen.System.Usb { /// - /// Class to manage USB Configuration. + /// A class to manage the USB configuration. /// /// 4 public class UsbConfiguration : IDisposable @@ -37,7 +37,7 @@ namespace Tizen.System.Usb } /// - /// Checks if device is self-powered in given configuration. + /// Checks if the device is self-powered in a given configuration. /// /// 4 public bool IsSelfPowered @@ -50,7 +50,7 @@ namespace Tizen.System.Usb } /// - /// Checks if device in given configuration supports remote wakeup. + /// Checks if the device in a given configuration supports remote wakeup. /// /// 4 public bool SupportRemoteWakeup @@ -63,7 +63,7 @@ namespace Tizen.System.Usb } /// - /// Gets maximum power required in given configuration, in mA. + /// Gets the maximum power required in a given configuration, in mA. /// /// 4 public int MaximumPowerRequired @@ -76,7 +76,7 @@ namespace Tizen.System.Usb } /// - /// Dictionary mapping interfaces Ids to interface instances for given configuration. + /// A dictionary for mapping the interface IDs to interface instances for a given configuration. /// /// 4 public IReadOnlyDictionary Interfaces @@ -101,7 +101,7 @@ namespace Tizen.System.Usb } /// - /// Configuration string. + /// The configuration string. /// /// 4 public string ConfigurationString @@ -114,10 +114,10 @@ namespace Tizen.System.Usb } /// - /// Set this configuration as active configuration for the device. + /// Sets this configuration as an active configuration for the device. /// /// - /// Throws exception if device is disconnected or not opened for operation or busy as its interfaces are currently claimed. + /// Throws an exception if the device is disconnected, or not opened for an operation, or busy as its interfaces are currently claimed. /// /// 4 public void SetAsActive() @@ -136,8 +136,8 @@ namespace Tizen.System.Usb private bool disposedValue = false; /// - /// Releases all resources used by the ConnectionProfile. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ConnectionProfile. + /// It should be called after it has finished using the object. /// 4 protected virtual void Dispose(bool disposing) { @@ -157,8 +157,8 @@ namespace Tizen.System.Usb } /// - /// Releases all resources used by the ConnectionProfile. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ConnectionProfile. + /// It should be called after it has finished using the object. /// 4 public void Dispose() { diff --git a/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs index 959b3b5..5962ea3 100644 --- a/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System.Usb { /// - /// USB Control Endpoint class. + /// The USB Control Endpoint class. /// /// 4 public class UsbControlEndpoint : UsbEndpoint @@ -32,7 +32,7 @@ namespace Tizen.System.Usb } /// - /// Gets number of this endpoint. + /// Gets the number of this endpoint. /// /// 4 public new int Id @@ -44,7 +44,7 @@ namespace Tizen.System.Usb } /// - /// Gets direction of this endpoint. + /// Gets the direction of this endpoint. /// /// 4 public new EndpointDirection Direction @@ -56,7 +56,7 @@ namespace Tizen.System.Usb } /// - /// Gets max packet size of given endpoint. + /// Gets the maximum packet size of a given endpoint. /// /// 4 public new int MaxPacketSize @@ -69,21 +69,21 @@ namespace Tizen.System.Usb } /// - /// Performs a control transaction on endpoint zero for this device. + /// Performs a control transaction on the endpoint, zero for this device. /// /// bmRequestType type field for the setup packet. /// bRequest field for the setup packet. /// wValue field for the setup packet. /// wIndex field for the setup packet. - /// Suitably-sized data buffer for either input or output, (depending on direction bits within bmRequestType). + /// Suitably-sized data buffer for either an input or output (depending on the direction bits within a bmRequestType). /// wLength field for the setup packet. The data buffer should be at least this size. /// - /// Time (in milliseconds) that this function should wait for, before giving up due to no response being received - /// (for an unlimited timeout 0 value should be used). + /// The time (in milliseconds) that this function should wait for, before giving up due to no response being received + /// (for an unlimited timeout, 0 value should be used). /// - /// Transferred Number of transferred bytes. - /// Throws exception if device is disconnected or not opened for operation. - /// Throws exception if transfer timed-out. + /// Transferred number of the transferred bytes. + /// Throws an exception if the device is disconnected or not opened for an operation. + /// Throws an exception if the transfer is timed out. /// 4 public int Transfer(byte requestType, byte request, ushort value, ushort index, byte[] data, ushort length, uint timeout) { diff --git a/src/Tizen.System.Usb/Usb/UsbDevice.cs b/src/Tizen.System.Usb/Usb/UsbDevice.cs index 0730bc8..6aaf73f 100644 --- a/src/Tizen.System.Usb/Usb/UsbDevice.cs +++ b/src/Tizen.System.Usb/Usb/UsbDevice.cs @@ -21,7 +21,7 @@ using System.Linq; namespace Tizen.System.Usb { /// - /// Class to manage USB host devices. This class contains operations for enumerating, opening and closing devices. + /// A class to manage the USB host devices. This class contains the operations for enumerating, opening, and closing devices. /// /// 4 public class UsbDevice : IDisposable @@ -47,7 +47,7 @@ namespace Tizen.System.Usb /// /// Number of the bus, this device is connected to. /// - /// Throws exception if user has insufficient permission on device. + /// Throws an exception if the user has insufficient permission on the device. /// 4 public int BusId { get @@ -58,7 +58,7 @@ namespace Tizen.System.Usb } /// - /// Address of device on the bus. + /// Address of the device on the bus. /// /// 4 public int Address @@ -71,7 +71,7 @@ namespace Tizen.System.Usb } /// - /// List of available port numbers from a device. + /// List of the available port numbers from the device. /// /// 4 public IEnumerable Ports @@ -84,7 +84,7 @@ namespace Tizen.System.Usb } /// - /// Checks if device is opened. + /// Checks if the device is opened. /// /// 4 public bool IsOpened @@ -97,7 +97,7 @@ namespace Tizen.System.Usb } /// - /// Control endpoint (endpoint 0). + /// Controls an endpoint (endpoint 0). /// /// 4 public UsbControlEndpoint ControlEndpoint @@ -112,7 +112,7 @@ namespace Tizen.System.Usb /// /// Active configuration for the device. /// - /// Throws exception if device is disconnected. + /// Throws an exception if the device is disconnected. /// 4 public UsbConfiguration ActiveConfiguration { @@ -125,7 +125,7 @@ namespace Tizen.System.Usb } /// - /// Dictionary mapping configuration Ids to configuration instances for this device. + /// A dictionary for mapping the configuration IDs to configuration instances for this device. /// /// 4 public IReadOnlyDictionary Configurations @@ -138,7 +138,7 @@ namespace Tizen.System.Usb } /// - /// Device information such as version, class, subclass etc. + /// Device information such as version, class, subclass, etc. /// /// 4 public UsbDeviceInformation DeviceInformation @@ -151,7 +151,7 @@ namespace Tizen.System.Usb } /// - /// String associated with device. + /// String associated with the device. /// /// 4 public UsbDeviceStrings Strings @@ -164,11 +164,11 @@ namespace Tizen.System.Usb } /// - /// Opens device, which allows performing operations on it. + /// Opens the device, which allows performing operations on it. /// - /// Throws exception in case of insufficient memory. - /// Throws exception if device is disconnected. - /// Throws exception if user has insufficient permission on device. + /// Throws an exception in case of insufficient memory. + /// Throws an exception if the device is disconnected. + /// Throws an exception if the user has insufficient permission on the device. /// 4 public void Open() { @@ -177,9 +177,9 @@ namespace Tizen.System.Usb } /// - /// Closes device for operations. + /// Closes the device for operations. /// - /// Throws exception if device is not opened for operation. + /// Throws an exception if the device is not opened for an operation. /// 4 public void Close() { @@ -199,8 +199,8 @@ namespace Tizen.System.Usb private bool disposedValue = false; /// - /// Releases all resources used by the ConnectionProfile. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ConnectionProfile. + /// It should be called after it has finished using the object. /// 4 protected virtual void Dispose(bool disposing) { @@ -228,8 +228,8 @@ namespace Tizen.System.Usb } /// - /// Releases all resources used by the ConnectionProfile. - /// It should be called after finished using of the object. + /// Releases all the resources used by the ConnectionProfile. + /// It should be called after it has finished using the object. /// 4 public void Dispose() { diff --git a/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs b/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs index 3761897..01f6eb5 100755 --- a/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs +++ b/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System.Usb { /// - /// Device information for USB device. + /// Device information for the USB device. /// /// 4 public class UsbDeviceInformation @@ -34,7 +34,7 @@ namespace Tizen.System.Usb /// /// USB specification release number as binary-coded decimal. /// - /// Throws exception if user has insufficient permission on device. + /// Throws an exception if the user has insufficient permission on the device. /// 4 public int UsbVersion { @@ -46,7 +46,7 @@ namespace Tizen.System.Usb } /// - /// Gets device class. + /// Gets the device class. /// /// 4 public int Class @@ -59,7 +59,7 @@ namespace Tizen.System.Usb } /// - /// Gets device sub class. + /// Gets the device subclass. /// /// 4 public int Subclass @@ -72,7 +72,7 @@ namespace Tizen.System.Usb } /// - /// Gets device protocol. + /// Gets the device protocol. /// /// 4 public int Protocol @@ -85,7 +85,7 @@ namespace Tizen.System.Usb } /// - /// Gets vendor id. + /// Gets the vendor ID. /// /// 4 public int VendorId @@ -98,7 +98,7 @@ namespace Tizen.System.Usb } /// - /// Gets product id. + /// Gets the product ID. /// /// 4 public int ProductId @@ -111,7 +111,7 @@ namespace Tizen.System.Usb } /// - /// Gets device release number in binary-coded decimal. + /// Gets the device release number in binary-coded decimal. /// /// 4 public int DeviceVersion diff --git a/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs b/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs index d5ac067..df1c62c 100755 --- a/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs +++ b/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System.Usb { /// - /// String information for USB device. + /// String information for the USB device. /// /// 4 public class UsbDeviceStrings @@ -34,10 +34,10 @@ namespace Tizen.System.Usb } /// - /// Gets string describing device manufacturer. + /// Gets the string describing the device manufacturer. /// - /// Throws exception if device is disconnected or not opened for operation. - /// Throws exception if user has insufficient permission on device. + /// Throws an exception if the device is disconnected or not opened for an operation. + /// Throws an exception if the user has insufficient permission on the device. /// 4 public string Manufacturer { @@ -49,10 +49,10 @@ namespace Tizen.System.Usb } /// - /// Gets product string of device + /// Gets the product string of a device. /// - /// Throws exception if device is not opened for operation. - /// Throws exception if user has insufficient permission on device. + /// Throws an exception if the device is not opened for an operation. + /// Throws an exception if the user has insufficient permission on the device. /// 4 public string Product { @@ -64,10 +64,10 @@ namespace Tizen.System.Usb } /// - /// Gets serial number of a device. + /// Gets the serial number of a device. /// - /// Throws exception if device is not opened for operation. - /// Throws exception if user has insufficient permission on device. + /// Throws an exception if the device is not opened for an operation. + /// Throws an exception if the user has insufficient permission on the device. /// 4 public string Serial { diff --git a/src/Tizen.System.Usb/Usb/UsbEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbEndpoint.cs index 43c51dd..d90e986 100644 --- a/src/Tizen.System.Usb/Usb/UsbEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbEndpoint.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System.Usb { /// - /// USB Endpoint class. + /// The USB Endpoint class. /// /// 4 public class UsbEndpoint @@ -35,7 +35,7 @@ namespace Tizen.System.Usb } /// - /// Gets number of this endpoint. + /// Gets the number of this endpoint. /// /// 4 public int Id @@ -48,7 +48,7 @@ namespace Tizen.System.Usb } /// - /// Gets direction of this endpoint. + /// Gets the direction of this endpoint. /// /// 4 public EndpointDirection Direction @@ -61,7 +61,7 @@ namespace Tizen.System.Usb } /// - /// Gets max packet size of given endpoint. + /// Gets the maximum packet size of a given endpoint. /// /// 4 public int MaxPacketSize diff --git a/src/Tizen.System.Usb/Usb/UsbInterface.cs b/src/Tizen.System.Usb/Usb/UsbInterface.cs index a70d7a7..eaba621 100755 --- a/src/Tizen.System.Usb/Usb/UsbInterface.cs +++ b/src/Tizen.System.Usb/Usb/UsbInterface.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace Tizen.System.Usb { /// - /// Class to manage USB Interfaces. + /// A class to manage the USB interfaces. /// /// 4 public class UsbInterface @@ -37,7 +37,7 @@ namespace Tizen.System.Usb } /// - /// Gets number of given interface. + /// Gets the number of a given interface. /// /// 4 public int Id @@ -50,7 +50,7 @@ namespace Tizen.System.Usb } /// - /// Sets alternative setting. Use index of new alternative setting for given interface. + /// Sets an alternative setting. Use the index of a new alternative setting for a given interface. /// /// 4 public int AlternateSetting @@ -63,7 +63,7 @@ namespace Tizen.System.Usb } /// - /// Dictionary mapping endpoint Ids to endpoint instances for given interface. + /// A dictionary for mapping the endpoint IDs to endpoint instances for a given interface. /// /// 4 public IReadOnlyDictionary Endpoints @@ -89,7 +89,7 @@ namespace Tizen.System.Usb /// - /// Gets string describing an interface. + /// Gets the string describing an interface. /// /// /// 4 @@ -100,11 +100,11 @@ namespace Tizen.System.Usb } /// - /// Claims interface on a device. Interface must be claimed first to perform I/O operations. + /// Claims the interface on a device. The interface must be claimed first to perform I/O operations. /// - /// Set to true to auto detach kernel driver, false otherwise. + /// Set to true to auto detach the kernel driver, false otherwise. /// - /// Throws exception if device is disconnected or not opened for operation or another program or driver has claimed the interface. + /// Throws an exception if the device is disconnected, or not opened for an operation, or another program or driver has claimed the interface. /// /// 4 public void Claim(bool force) @@ -117,10 +117,10 @@ namespace Tizen.System.Usb /// - /// Releases previously claimed interface. + /// Releases the previously claimed interface. /// - /// Throws exception if device is disconnected or not opened for operation. - /// Throws exception if user has insufficient permission on device. + /// Throws an exception if the device is disconnected or not opened for an operation. + /// Throws an exception if the user has insufficient permission on the device. /// 4 public void Release() { diff --git a/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs index 4cbd76c..a9e1fc9 100755 --- a/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System.Usb { /// - /// USB Interrupt Endpoint class. + /// The USB Interrupt Endpoint class. /// /// 4 public class UsbInterruptEndpoint : UsbEndpoint @@ -29,7 +29,7 @@ namespace Tizen.System.Usb } /// - /// Gets interval for polling endpoint for data transfers, in frame counts (refer to USB protocol specification). + /// Gets an interval for polling the endpoint for data transfers, in frame counts (refer to the USB protocol specification). /// /// 4 public int PollingInterval @@ -42,20 +42,20 @@ namespace Tizen.System.Usb } /// - /// Performs a USB transfer on given endpoint. Direction of transfer is determined by the endpoint. + /// Performs a USB transfer on a given endpoint. The direction of transfer is determined by the endpoint. /// - /// Suitably-sized data buffer for either input or output (depending on endpoint). + /// Suitably-sized data buffer for either an input or output (depending on the endpoint). /// - /// For writes, the number of bytes from data to be sent, for reads the maximum number of bytes to receive + /// For writes, the number of bytes from the data to be sent. For reads, the maximum number of bytes to receive /// into the data buffer. /// /// - /// Time (in milliseconds) that this function should wait for before giving up due to no response being - /// received(for an unlimited timeout 0 value should be used). + /// The time (in milliseconds) that this function should wait for, before giving up due to no response being + /// received (for an unlimited timeout, 0 value should be used). /// - /// Number of bytes actually transferred. - /// Throws exception if device is disconnected or not opened for operation. - /// Throws exception if transfer timed-out. + /// The number of bytes actually transferred. + /// Throws an exception if the device is disconnected or not opened for an operation. + /// Throws an exception if the transfer is timed out. /// 4 public int Transfer(byte[] buffer, int length, uint timeout) { diff --git a/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs index 6367815..94f259e 100644 --- a/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs @@ -17,7 +17,7 @@ namespace Tizen.System.Usb { /// - /// USB Isochronous Endpoint class. + /// The USB Isochronous Endpoint class. /// /// 4 public class UsbIsochronousEndpoint : UsbEndpoint @@ -27,7 +27,7 @@ namespace Tizen.System.Usb } /// - /// Gets synchronization type of this endpoint. + /// Gets the synchronization type of this endpoint. /// /// 4 public SynchronizationType SynchronizationType @@ -40,7 +40,7 @@ namespace Tizen.System.Usb } /// - /// Gets usage type of this endpoint. + /// Gets the usage type of this endpoint. /// /// 4 public UsageType UsageType diff --git a/src/Tizen.System.Usb/Usb/UsbManager.cs b/src/Tizen.System.Usb/Usb/UsbManager.cs index 00bbb66..b62d1bb 100644 --- a/src/Tizen.System.Usb/Usb/UsbManager.cs +++ b/src/Tizen.System.Usb/Usb/UsbManager.cs @@ -21,7 +21,7 @@ using System.Linq; namespace Tizen.System.Usb { /// - /// USB Manager class. + /// The USB Manager class. /// /// 4 public class UsbManager : IDisposable @@ -31,7 +31,7 @@ namespace Tizen.System.Usb private List _devices = new List(); /// - /// USB Manager Constructor. + /// The USB Manager constructor. /// /// 4 public UsbManager() @@ -43,11 +43,11 @@ namespace Tizen.System.Usb } /// - /// This function returns list of USB devices attached to system. + /// This function returns a list of USB devices attached to the system. /// - /// Throws exception if USB host feature is not enabled. - /// Throws exception in case of insufficient memory. - /// Throws exception if user has insufficient permission on device. + /// Throws an exception if the USB host feature is not enabled. + /// Throws an exception in case of insufficient memory. + /// Throws an exception if the user has insufficient permission on the device. /// 4 public IEnumerable AvailableDevices { @@ -59,7 +59,7 @@ namespace Tizen.System.Usb } /// - /// Event handler for events when a USB device is attached or detached. + /// An event handler for events when the USB device is attached or detached. /// /// 4 public event EventHandler DeviceHotPlugged; -- 2.7.4