}
/// <summary>
- /// 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.
/// </summary>
- /// <returns>true in case of no error, false otherwise</returns>
+ /// <returns>true in case of no error, false otherwise.</returns>
internal static bool WarnIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0)
{
if (err.IsFailed())
}
/// <summary>
- /// 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.
/// </summary>
- /// <returns>true in case of no error</returns>
+ /// <returns>true in case of no error.</returns>
internal static bool ThrowIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0)
{
if (err.IsFailed())
namespace Tizen.System.Usb
{
/// <summary>
- /// Enumeration of transfer direction for Endpoints.
+ /// Enumeration for the transfer directions for endpoints.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum EndpointDirection
{
/// <summary>
- /// IN direction
+ /// In direction.
/// </summary>
In = Interop.EndpointDirection.In,
/// <summary>
- /// OUT direction
+ /// Out direction.
/// </summary>
Out = Interop.EndpointDirection.Out,
/// <summary>
- /// Bi-directional
+ /// Bidirectional.
/// </summary>
InOut = Interop.EndpointDirection.InOut,
}
namespace Tizen.System.Usb
{
/// <summary>
- /// Event arguments for Hot Plugged event for USB devices.
+ /// Event arguments for the Hot Plugged event for USB devices.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class HotPluggedEventArgs : EventArgs
}
/// <summary>
- /// USB Device
+ /// USB device.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public UsbDevice Device { get; }
/// <summary>
- /// Event Type
+ /// Event type.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public HotplugEventType EventType { get; }
namespace Tizen.System.Usb
{
/// <summary>
- /// Enumeration of hot plugged event type for USB devices.
+ /// Enumeration for the Hot Plugged event type for USB devices.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum HotplugEventType
{
/// <summary>
- /// USB device is attached
+ /// USB device is attached.
/// </summary>
Attach = Interop.HotplugEventType.Attach,
/// <summary>
- /// USB device is detached
+ /// USB device is detached.
/// </summary>
Detach = Interop.HotplugEventType.Detach,
}
namespace Tizen.System.Usb
{
/// <summary>
- /// Enumeration of isochronous endpoint's synchronization type.
+ /// Enumeration for the isochronous endpoints synchronization types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum SynchronizationType
{
/// <summary>
- /// Asynchronous
+ /// Asynchronous.
/// </summary>
Asynchronous = Interop.SynchronizationType.Async,
/// <summary>
- /// Adaptive
+ /// Adaptive.
/// </summary>
Adaptive = Interop.SynchronizationType.Adaptive,
/// <summary>
- /// Synchronous
+ /// Synchronous.
/// </summary>
Synchronous = Interop.SynchronizationType.Sync,
}
namespace Tizen.System.Usb
{
/// <summary>
- /// Enumeration of an endpoint's usage type.
+ /// Enumeration for an endpoint's usage types.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public enum UsageType
{
/// <summary>
- /// Data endpoint
+ /// Data endpoint.
/// </summary>
Data = Interop.UsageType.Data,
/// <summary>
- /// Feedback endpoint
+ /// Feedback endpoint.
/// </summary>
Feedback = Interop.UsageType.Feedback,
/// <summary>
- /// Implicit feedback Data endpoint
+ /// Implicit feedback data endpoint.
/// </summary>
Implicit = Interop.UsageType.Implicit,
}
namespace Tizen.System.Usb
{
/// <summary>
- /// USB Bulk Endpoint class.
+ /// The USB Bulk Endpoint class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbBulkEndpoint : UsbEndpoint
}
/// <summary>
- /// 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.
/// </summary>
- /// <param name="buffer">Suitably-sized data buffer for either input or output (depending on endpoint).</param>
+ /// <param name="buffer">Suitably-sized data buffer for either an input or output (depending on the endpoint).</param>
/// <param name="length">
- /// 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.
/// </param>
/// <param name="timeout">
- /// 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).
/// </param>
- /// <returns>Number of bytes actually transferred.</returns>
- /// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
- /// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
+ /// <returns>The number of bytes actually transferred.</returns>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected or not opened for an operation.</exception>
+ /// <exception cref="TimeoutException">Throws an exception if the transfer is timed out.</exception>
/// <since_tizen> 4 </since_tizen>
public int Transfer(byte[] buffer, int length, uint timeout)
{
namespace Tizen.System.Usb
{
/// <summary>
- /// Class to manage USB Configuration.
+ /// A class to manage the USB configuration.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbConfiguration : IDisposable
}
/// <summary>
- /// Checks if device is self-powered in given configuration.
+ /// Checks if the device is self-powered in a given configuration.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool IsSelfPowered
}
/// <summary>
- /// Checks if device in given configuration supports remote wakeup.
+ /// Checks if the device in a given configuration supports remote wakeup.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool SupportRemoteWakeup
}
/// <summary>
- /// Gets maximum power required in given configuration, in mA.
+ /// Gets the maximum power required in a given configuration, in mA.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int MaximumPowerRequired
}
/// <summary>
- /// Dictionary mapping interfaces Ids to interface instances for given configuration.
+ /// A dictionary for mapping the interface IDs to interface instances for a given configuration.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public IReadOnlyDictionary<int, UsbInterface> Interfaces
}
/// <summary>
- /// Configuration string.
+ /// The configuration string.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public string ConfigurationString
}
/// <summary>
- /// Set this configuration as active configuration for the device.
+ /// Sets this configuration as an active configuration for the device.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// 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.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public void SetAsActive()
private bool disposedValue = false;
/// <summary>
- /// Releases all resources used by the ConnectionProfile.
- /// It should be called after finished using of the object.</summary>
+ /// Releases all the resources used by the ConnectionProfile.
+ /// It should be called after it has finished using the object.</summary>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all resources used by the ConnectionProfile.
- /// It should be called after finished using of the object.</summary>
+ /// Releases all the resources used by the ConnectionProfile.
+ /// It should be called after it has finished using the object.</summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
{
namespace Tizen.System.Usb
{
/// <summary>
- /// USB Control Endpoint class.
+ /// The USB Control Endpoint class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbControlEndpoint : UsbEndpoint
}
/// <summary>
- /// Gets number of this endpoint.
+ /// Gets the number of this endpoint.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public new int Id
}
/// <summary>
- /// Gets direction of this endpoint.
+ /// Gets the direction of this endpoint.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public new EndpointDirection Direction
}
/// <summary>
- /// Gets max packet size of given endpoint.
+ /// Gets the maximum packet size of a given endpoint.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public new int MaxPacketSize
}
/// <summary>
- /// Performs a control transaction on endpoint zero for this device.
+ /// Performs a control transaction on the endpoint, zero for this device.
/// </summary>
/// <param name="requestType">bmRequestType type field for the setup packet.</param>
/// <param name="request">bRequest field for the setup packet.</param>
/// <param name="value">wValue field for the setup packet.</param>
/// <param name="index">wIndex field for the setup packet.</param>
- /// <param name="data">Suitably-sized data buffer for either input or output, (depending on direction bits within bmRequestType).</param>
+ /// <param name="data">Suitably-sized data buffer for either an input or output (depending on the direction bits within a bmRequestType).</param>
/// <param name="length">wLength field for the setup packet. The data buffer should be at least this size.</param>
/// <param name="timeout">
- /// 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).
/// </param>
- /// <returns>Transferred Number of transferred bytes.</returns>
- /// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
- /// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
+ /// <returns>Transferred number of the transferred bytes.</returns>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected or not opened for an operation.</exception>
+ /// <exception cref="TimeoutException">Throws an exception if the transfer is timed out.</exception>
/// <since_tizen> 4 </since_tizen>
public int Transfer(byte requestType, byte request, ushort value, ushort index, byte[] data, ushort length, uint timeout)
{
namespace Tizen.System.Usb
{
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbDevice : IDisposable
/// <summary>
/// Number of the bus, this device is connected to.
/// </summary>
- /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
/// <since_tizen> 4 </since_tizen>
public int BusId {
get
}
/// <summary>
- /// Address of device on the bus.
+ /// Address of the device on the bus.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int Address
}
/// <summary>
- /// List of available port numbers from a device.
+ /// List of the available port numbers from the device.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public IEnumerable<int> Ports
}
/// <summary>
- /// Checks if device is opened.
+ /// Checks if the device is opened.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public bool IsOpened
}
/// <summary>
- /// Control endpoint (endpoint 0).
+ /// Controls an endpoint (endpoint 0).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public UsbControlEndpoint ControlEndpoint
/// <summary>
/// Active configuration for the device.
/// </summary>
- /// <exception cref="InvalidOperationException">Throws exception if device is disconnected.</exception>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected.</exception>
/// <since_tizen> 4 </since_tizen>
public UsbConfiguration ActiveConfiguration
{
}
/// <summary>
- /// Dictionary mapping configuration Ids to configuration instances for this device.
+ /// A dictionary for mapping the configuration IDs to configuration instances for this device.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public IReadOnlyDictionary<int, UsbConfiguration> Configurations
}
/// <summary>
- /// Device information such as version, class, subclass etc.
+ /// Device information such as version, class, subclass, etc.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public UsbDeviceInformation DeviceInformation
}
/// <summary>
- /// String associated with device.
+ /// String associated with the device.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public UsbDeviceStrings Strings
}
/// <summary>
- /// Opens device, which allows performing operations on it.
+ /// Opens the device, which allows performing operations on it.
/// </summary>
- /// <exception cref="OutOfMemoryException">Throws exception in case of insufficient memory.</exception>
- /// <exception cref="InvalidOperationException">Throws exception if device is disconnected.</exception>
- /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <exception cref="OutOfMemoryException">Throws an exception in case of insufficient memory.</exception>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
/// <since_tizen> 4 </since_tizen>
public void Open()
{
}
/// <summary>
- /// Closes device for operations.
+ /// Closes the device for operations.
/// </summary>
- /// <exception cref="InvalidOperationException">Throws exception if device is not opened for operation.</exception>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is not opened for an operation.</exception>
/// <since_tizen> 4 </since_tizen>
public void Close()
{
private bool disposedValue = false;
/// <summary>
- /// Releases all resources used by the ConnectionProfile.
- /// It should be called after finished using of the object.</summary>
+ /// Releases all the resources used by the ConnectionProfile.
+ /// It should be called after it has finished using the object.</summary>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
- /// Releases all resources used by the ConnectionProfile.
- /// It should be called after finished using of the object.</summary>
+ /// Releases all the resources used by the ConnectionProfile.
+ /// It should be called after it has finished using the object.</summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
{
namespace Tizen.System.Usb
{
/// <summary>
- /// Device information for USB device.
+ /// Device information for the USB device.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbDeviceInformation
/// <summary>
/// USB specification release number as binary-coded decimal.
/// </summary>
- /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
/// <since_tizen> 4 </since_tizen>
public int UsbVersion
{
}
/// <summary>
- /// Gets device class.
+ /// Gets the device class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int Class
}
/// <summary>
- /// Gets device sub class.
+ /// Gets the device subclass.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int Subclass
}
/// <summary>
- /// Gets device protocol.
+ /// Gets the device protocol.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int Protocol
}
/// <summary>
- /// Gets vendor id.
+ /// Gets the vendor ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int VendorId
}
/// <summary>
- /// Gets product id.
+ /// Gets the product ID.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int ProductId
}
/// <summary>
- /// Gets device release number in binary-coded decimal.
+ /// Gets the device release number in binary-coded decimal.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int DeviceVersion
namespace Tizen.System.Usb
{
/// <summary>
- /// String information for USB device.
+ /// String information for the USB device.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbDeviceStrings
}
/// <summary>
- /// Gets string describing device manufacturer.
+ /// Gets the string describing the device manufacturer.
/// </summary>
- /// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
- /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected or not opened for an operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
/// <since_tizen> 4 </since_tizen>
public string Manufacturer
{
}
/// <summary>
- /// Gets product string of device
+ /// Gets the product string of a device.
/// </summary>
- /// <exception cref="InvalidOperationException">Throws exception if device is not opened for operation.</exception>
- /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is not opened for an operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
/// <since_tizen> 4 </since_tizen>
public string Product
{
}
/// <summary>
- /// Gets serial number of a device.
+ /// Gets the serial number of a device.
/// </summary>
- /// <exception cref="InvalidOperationException">Throws exception if device is not opened for operation.</exception>
- /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is not opened for an operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
/// <since_tizen> 4 </since_tizen>
public string Serial
{
namespace Tizen.System.Usb
{
/// <summary>
- /// USB Endpoint class.
+ /// The USB Endpoint class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbEndpoint
}
/// <summary>
- /// Gets number of this endpoint.
+ /// Gets the number of this endpoint.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int Id
}
/// <summary>
- /// Gets direction of this endpoint.
+ /// Gets the direction of this endpoint.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public EndpointDirection Direction
}
/// <summary>
- /// Gets max packet size of given endpoint.
+ /// Gets the maximum packet size of a given endpoint.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int MaxPacketSize
namespace Tizen.System.Usb
{
/// <summary>
- /// Class to manage USB Interfaces.
+ /// A class to manage the USB interfaces.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbInterface
}
/// <summary>
- /// Gets number of given interface.
+ /// Gets the number of a given interface.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int Id
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int AlternateSetting
}
/// <summary>
- /// Dictionary mapping endpoint Ids to endpoint instances for given interface.
+ /// A dictionary for mapping the endpoint IDs to endpoint instances for a given interface.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public IReadOnlyDictionary<int, UsbEndpoint> Endpoints
/// <summary>
- /// Gets string describing an interface.
+ /// Gets the string describing an interface.
/// </summary>
/// <returns></returns>
/// <since_tizen> 4 </since_tizen>
}
/// <summary>
- /// 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.
/// </summary>
- /// <param name="force">Set to true to auto detach kernel driver, false otherwise.</param>
+ /// <param name="force">Set to true to auto detach the kernel driver, false otherwise.</param>
/// <exception cref="InvalidOperationException">
- /// 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.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public void Claim(bool force)
/// <summary>
- /// Releases previously claimed interface.
+ /// Releases the previously claimed interface.
/// </summary>
- /// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
- /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected or not opened for an operation.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
/// <since_tizen> 4 </since_tizen>
public void Release()
{
namespace Tizen.System.Usb
{
/// <summary>
- /// USB Interrupt Endpoint class.
+ /// The USB Interrupt Endpoint class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbInterruptEndpoint : UsbEndpoint
}
/// <summary>
- /// 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).
/// </summary>
/// <since_tizen> 4 </since_tizen>
public int PollingInterval
}
/// <summary>
- /// 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.
/// </summary>
- /// <param name="buffer">Suitably-sized data buffer for either input or output (depending on endpoint).</param>
+ /// <param name="buffer">Suitably-sized data buffer for either an input or output (depending on the endpoint).</param>
/// <param name="length">
- /// 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.
/// </param>
/// <param name="timeout">
- /// 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).
/// </param>
- /// <returns>Number of bytes actually transferred.</returns>
- /// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
- /// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
+ /// <returns>The number of bytes actually transferred.</returns>
+ /// <exception cref="InvalidOperationException">Throws an exception if the device is disconnected or not opened for an operation.</exception>
+ /// <exception cref="TimeoutException">Throws an exception if the transfer is timed out.</exception>
/// <since_tizen> 4 </since_tizen>
public int Transfer(byte[] buffer, int length, uint timeout)
{
namespace Tizen.System.Usb
{
/// <summary>
- /// USB Isochronous Endpoint class.
+ /// The USB Isochronous Endpoint class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbIsochronousEndpoint : UsbEndpoint
}
/// <summary>
- /// Gets synchronization type of this endpoint.
+ /// Gets the synchronization type of this endpoint.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public SynchronizationType SynchronizationType
}
/// <summary>
- /// Gets usage type of this endpoint.
+ /// Gets the usage type of this endpoint.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public UsageType UsageType
namespace Tizen.System.Usb
{
/// <summary>
- /// USB Manager class.
+ /// The USB Manager class.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public class UsbManager : IDisposable
private List<UsbDevice> _devices = new List<UsbDevice>();
/// <summary>
- /// USB Manager Constructor.
+ /// The USB Manager constructor.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public UsbManager()
}
/// <summary>
- /// This function returns list of USB devices attached to system.
+ /// This function returns a list of USB devices attached to the system.
/// </summary>
- /// <exception cref="NotSupportedException">Throws exception if USB host feature is not enabled.</exception>
- /// <exception cref="OutOfMemoryException">Throws exception in case of insufficient memory.</exception>
- /// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
+ /// <exception cref="NotSupportedException">Throws an exception if the USB host feature is not enabled.</exception>
+ /// <exception cref="OutOfMemoryException">Throws an exception in case of insufficient memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Throws an exception if the user has insufficient permission on the device.</exception>
/// <since_tizen> 4 </since_tizen>
public IEnumerable<UsbDevice> AvailableDevices
{
}
/// <summary>
- /// 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.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<HotPluggedEventArgs> DeviceHotPlugged;
projects / platform / core / csapi / tizenfx.git / commitdiff