[Usb] Add missing documentation 04/163204/1
authorlokilee73 <changjoo.lee@samsung.com>
Fri, 8 Dec 2017 02:49:23 +0000 (11:49 +0900)
committerlokilee73 <changjoo.lee@samsung.com>
Fri, 8 Dec 2017 02:49:49 +0000 (11:49 +0900)
Features and few exceptions were documented here.

Change-Id: I41a644ebe22799079575a292a910a24fd433ee14
Signed-off-by: lokilee73 <changjoo.lee@samsung.com>
12 files changed:
src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs [changed mode: 0644->0755]
src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs [changed mode: 0644->0755]
src/Tizen.System.Usb/Usb/UsbConfiguration.cs
src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs [changed mode: 0644->0755]
src/Tizen.System.Usb/Usb/UsbDevice.cs
src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs
src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs
src/Tizen.System.Usb/Usb/UsbEndpoint.cs
src/Tizen.System.Usb/Usb/UsbInterface.cs
src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs
src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs [changed mode: 0644->0755]
src/Tizen.System.Usb/Usb/UsbManager.cs

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