From: lokilee73 Date: Wed, 13 Dec 2017 10:11:05 +0000 (+0000) Subject: Merge "[Usb] Add missing documentation" X-Git-Tag: 5.0.0-preview1-00411^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a9249cb3e15e545f192abb8145bf5aa8980f9bd8;hp=39b3fda25f65bec3e7c6b958a6990e14cb786805;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git Merge "[Usb] Add missing documentation" --- diff --git a/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs b/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs old mode 100644 new mode 100755 index 48e94ea..5121e3c --- a/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs +++ b/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs @@ -33,12 +33,16 @@ namespace Tizen.System.Usb /// /// USB Device /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public UsbDevice Device { get; } /// /// Event Type /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public HotplugEventType EventType { get; } } diff --git a/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs old mode 100644 new mode 100755 index 282509a..b260b92 --- a/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs @@ -41,6 +41,8 @@ namespace Tizen.System.Usb /// received(for an unlimited timeout 0 value should be used). /// /// Number of bytes actually transferred. + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if transfer timed-out. /// 4 diff --git a/src/Tizen.System.Usb/Usb/UsbConfiguration.cs b/src/Tizen.System.Usb/Usb/UsbConfiguration.cs index bb5582e..369a690 100755 --- a/src/Tizen.System.Usb/Usb/UsbConfiguration.cs +++ b/src/Tizen.System.Usb/Usb/UsbConfiguration.cs @@ -39,6 +39,8 @@ namespace Tizen.System.Usb /// /// Checks if device is self-powered in given configuration. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public bool IsSelfPowered { @@ -52,6 +54,8 @@ namespace Tizen.System.Usb /// /// Checks if device in given configuration supports remote wakeup. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public bool SupportRemoteWakeup { @@ -65,6 +69,8 @@ namespace Tizen.System.Usb /// /// Gets maximum power required in given configuration, in mA. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int MaximumPowerRequired { @@ -78,6 +84,8 @@ namespace Tizen.System.Usb /// /// Dictionary mapping interfaces Ids to interface instances for given configuration. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public IReadOnlyDictionary Interfaces { @@ -103,7 +111,11 @@ namespace Tizen.System.Usb /// /// Configuration string. /// - /// Throws exception if device is disconnected or not opened for operation. + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. + /// + /// Throws exception if device is disconnected or not opened for operation or busy as its interfaces are currently claimed. + /// /// 4 public string ConfigurationString { @@ -118,6 +130,8 @@ namespace Tizen.System.Usb /// /// Set this configuration as active configuration for the device. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if device is disconnected or not opened for operation. /// 4 public void SetAsActive() diff --git a/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs old mode 100644 new mode 100755 index 959b3b5..8f5d12e --- a/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs @@ -34,6 +34,8 @@ namespace Tizen.System.Usb /// /// Gets number of this endpoint. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public new int Id { @@ -46,6 +48,8 @@ namespace Tizen.System.Usb /// /// Gets direction of this endpoint. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public new EndpointDirection Direction { @@ -58,6 +62,8 @@ namespace Tizen.System.Usb /// /// Gets max packet size of given endpoint. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public new int MaxPacketSize { @@ -82,6 +88,8 @@ namespace Tizen.System.Usb /// (for an unlimited timeout 0 value should be used). /// /// Transferred Number of transferred bytes. + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if transfer timed-out. /// 4 diff --git a/src/Tizen.System.Usb/Usb/UsbDevice.cs b/src/Tizen.System.Usb/Usb/UsbDevice.cs index 7dbb34d..1516d4f 100755 --- a/src/Tizen.System.Usb/Usb/UsbDevice.cs +++ b/src/Tizen.System.Usb/Usb/UsbDevice.cs @@ -38,6 +38,8 @@ namespace Tizen.System.Usb /// /// Number of the bus, this device is connected to. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if user has insufficient permission on device. /// 4 public int BusId { @@ -51,6 +53,8 @@ namespace Tizen.System.Usb /// /// Address of device on the bus. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int Address { @@ -64,6 +68,8 @@ namespace Tizen.System.Usb /// /// List of available port numbers from a device. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public IEnumerable Ports { @@ -77,6 +83,8 @@ namespace Tizen.System.Usb /// /// Checks if device is opened. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public bool IsOpened { @@ -90,6 +98,8 @@ namespace Tizen.System.Usb /// /// Control endpoint (endpoint 0). /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public UsbControlEndpoint ControlEndpoint { @@ -103,6 +113,8 @@ namespace Tizen.System.Usb /// /// Active configuration for the device. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if device is disconnected or not opened for operation. /// 4 public UsbConfiguration ActiveConfiguration @@ -120,6 +132,8 @@ namespace Tizen.System.Usb /// /// Dictionary mapping configuration Ids to configuration instances for this device. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public IReadOnlyDictionary Configurations { @@ -141,6 +155,8 @@ namespace Tizen.System.Usb /// /// Device information such as version, class, subclass etc. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public UsbDeviceInformation DeviceInformation { @@ -154,6 +170,8 @@ namespace Tizen.System.Usb /// /// String associated with device. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if device is disconnected or not opened for operation. /// 4 public UsbDeviceStrings Strings @@ -169,6 +187,8 @@ namespace Tizen.System.Usb /// /// Opens device, which allows performing operations on it. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception in case of insufficient memory. /// Throws exception if device is disconnected. /// Throws exception if user has insufficient permission on device. @@ -182,6 +202,8 @@ namespace Tizen.System.Usb /// /// Closes device for operations. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public void Close() { diff --git a/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs b/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs index 3761897..38a58ef 100755 --- a/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs +++ b/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs @@ -34,6 +34,8 @@ namespace Tizen.System.Usb /// /// USB specification release number as binary-coded decimal. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if user has insufficient permission on device. /// 4 public int UsbVersion @@ -48,6 +50,8 @@ namespace Tizen.System.Usb /// /// Gets device class. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int Class { @@ -61,6 +65,8 @@ namespace Tizen.System.Usb /// /// Gets device sub class. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int Subclass { @@ -74,6 +80,8 @@ namespace Tizen.System.Usb /// /// Gets device protocol. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int Protocol { @@ -87,6 +95,8 @@ namespace Tizen.System.Usb /// /// Gets vendor id. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int VendorId { @@ -100,6 +110,8 @@ namespace Tizen.System.Usb /// /// Gets product id. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int ProductId { @@ -113,6 +125,8 @@ namespace Tizen.System.Usb /// /// Gets device release number in binary-coded decimal. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int DeviceVersion { diff --git a/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs b/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs index a682b73..4b43f94 100755 --- a/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs +++ b/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs @@ -32,18 +32,24 @@ namespace Tizen.System.Usb /// /// Gets string describing device manufacturer. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public string Manufacturer; /// /// Gets product string of device /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public string Product; /// /// Gets serial number of a device. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public string Serial; } diff --git a/src/Tizen.System.Usb/Usb/UsbEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbEndpoint.cs index e06716e..3c06f77 100755 --- a/src/Tizen.System.Usb/Usb/UsbEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbEndpoint.cs @@ -36,6 +36,8 @@ namespace Tizen.System.Usb /// /// Gets number of this endpoint. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int Id { @@ -49,6 +51,8 @@ namespace Tizen.System.Usb /// /// Gets direction of this endpoint. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public EndpointDirection Direction { @@ -62,6 +66,8 @@ namespace Tizen.System.Usb /// /// Gets max packet size of given endpoint. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int MaxPacketSize { diff --git a/src/Tizen.System.Usb/Usb/UsbInterface.cs b/src/Tizen.System.Usb/Usb/UsbInterface.cs index bf5ddae..850eb8a 100755 --- a/src/Tizen.System.Usb/Usb/UsbInterface.cs +++ b/src/Tizen.System.Usb/Usb/UsbInterface.cs @@ -39,6 +39,8 @@ namespace Tizen.System.Usb /// /// Gets number of given interface. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int Id { @@ -52,6 +54,8 @@ namespace Tizen.System.Usb /// /// Sets alternative setting. Use index of new alternative setting for given interface. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int AlternateSetting { @@ -65,6 +69,8 @@ namespace Tizen.System.Usb /// /// Dictionary mapping endpoint Ids to endpoint instances for given interface. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public IReadOnlyDictionary Endpoints { @@ -91,7 +97,11 @@ namespace Tizen.System.Usb /// /// Gets string describing an interface. /// - /// Throws exception if device is disconnected or not opened for operation. + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. + /// + /// Throws exception if device is disconnected or not opened for operation. + /// /// 4 public string InterfaceString { @@ -107,6 +117,8 @@ namespace Tizen.System.Usb /// Claims interface on a device. Interface must be claimed first to perform I/O operations. /// /// Set to true to auto detach kernel driver, false otherwise. + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// /// Throws exception if device is disconnected or not opened for operation or another program or driver has claimed the interface. /// @@ -129,6 +141,8 @@ namespace Tizen.System.Usb /// /// Releases previously claimed interface. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if user has insufficient permission on device. /// 4 diff --git a/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs index 4cbd76c..798ddb2 100755 --- a/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs @@ -31,6 +31,8 @@ namespace Tizen.System.Usb /// /// Gets interval for polling endpoint for data transfers, in frame counts (refer to USB protocol specification). /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public int PollingInterval { @@ -54,6 +56,8 @@ namespace Tizen.System.Usb /// received(for an unlimited timeout 0 value should be used). /// /// Number of bytes actually transferred. + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if transfer timed-out. /// 4 diff --git a/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs old mode 100644 new mode 100755 index 6367815..e6e9fa4 --- a/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs @@ -29,6 +29,8 @@ namespace Tizen.System.Usb /// /// Gets synchronization type of this endpoint. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public SynchronizationType SynchronizationType { @@ -42,6 +44,8 @@ namespace Tizen.System.Usb /// /// Gets usage type of this endpoint. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public UsageType UsageType { diff --git a/src/Tizen.System.Usb/Usb/UsbManager.cs b/src/Tizen.System.Usb/Usb/UsbManager.cs index 366ca76..70734f0 100755 --- a/src/Tizen.System.Usb/Usb/UsbManager.cs +++ b/src/Tizen.System.Usb/Usb/UsbManager.cs @@ -46,7 +46,8 @@ namespace Tizen.System.Usb /// /// USB Manager Constructor. /// - /// Throws exception if USB host feature is not enabled. + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public UsbManager() { @@ -66,6 +67,8 @@ namespace Tizen.System.Usb /// /// This function returns list of USB devices attached to system. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// Throws exception in case of insufficient memory. /// Throws exception if user has insufficient permission on device. /// 4 @@ -81,6 +84,8 @@ namespace Tizen.System.Usb /// /// Event handler for events when a USB device is attached or detached. /// + /// http://tizen.org/feature/usb.host + /// The required feature is not supported. /// 4 public event EventHandler DeviceHotPlugged;