diff options
author | Editor Lionbridge <TizenEditor.SEL@lionbridge.com> | 2017-07-26 12:27:14 +0530 |
---|---|---|
committer | Editor Lionbridge <TizenEditor.SEL@lionbridge.com> | 2017-07-31 19:51:59 +0900 |
commit | 772c239d8c75e9f96fab4b66b7f3ce75563120c5 (patch) | |
tree | 87c2fab3eba981891cb095084833bcd97b420b71 | |
parent | bb4af44e18bf650b8f4b3a152f4b5a436f866df3 (diff) | |
download | iotcon-772c239d8c75e9f96fab4b66b7f3ce75563120c5.tar.gz iotcon-772c239d8c75e9f96fab4b66b7f3ce75563120c5.tar.bz2 iotcon-772c239d8c75e9f96fab4b66b7f3ce75563120c5.zip |
Review Iotcon API cs filestizen
PS2: Restore unchanged files.
PS3: Restore unchanged files.
PS4: Remove \r
Change-Id: I7b2a4ee74dcbe1cbc32aa3f42466d50108f49e74
30 files changed, 734 insertions, 734 deletions
diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Attributes.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Attributes.cs index e7bb84c..6dd18a8 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Attributes.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Attributes.cs @@ -29,7 +29,7 @@ namespace Tizen.Network.IoTConnectivity /// It provides API to manage attributes. /// This class is accessed by using a constructor to create a new instance of this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class Attributes : IDictionary<string, object>, IDisposable { internal IntPtr _resourceAttributesHandle = IntPtr.Zero; @@ -37,12 +37,12 @@ namespace Tizen.Network.IoTConnectivity private bool _disposed = false; /// <summary> - /// The Attributes constructor + /// The Attributes constructor. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); /// </code> @@ -77,9 +77,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets the number of keys + /// Gets the number of keys. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The number of keys.</value> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { @@ -96,10 +96,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Represents whether attribute is readonly + /// Represents whether an attribute is readonly. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Whether attribute is readonly.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>Whether an attribute is readonly.</value> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// { "state", "ON" }, @@ -117,9 +117,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Contains all the attribute keys + /// Contains all the attribute keys. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>All the attribute keys.</value> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { @@ -138,9 +138,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Contains all the attribute values + /// Contains all the attribute values. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>All the attribute values.</value> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { @@ -161,7 +161,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Gets or sets the attribute with the specified key. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The attribute with the specified key.</value> /// <param name="key">The key of the attribute to get or set.</param> /// <returns>The element with the specified key.</returns> @@ -187,10 +187,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Adds attribute key and value as a key value pair + /// Adds the attribute key and a value as a key value pair. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The key value pair to add</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The key value pair to add.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); @@ -202,11 +202,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Adds an attribute + /// Adds an attribute. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The key representing the attribute</param> - /// <param name="value">The value representing the attribute</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The key representing the attribute.</param> + /// <param name="value">The value representing the attribute.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); @@ -295,9 +295,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Clears attributes collection + /// Clears attributes collection. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> @@ -321,11 +321,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Checks whether the given key value pair exists in attributes collection + /// Checks whether the given key value pair exists in attributes collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The status key value pair</param> - /// <returns>true if exists. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The status key value pair.</param> + /// <returns>true if exists. Otherwise, false.</returns> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// { "state", "ON" }, @@ -340,11 +340,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Checks whether the given key exists in attributes collection + /// Checks whether the given key exists in attributes collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The status key to look for</param> - /// <returns>true if exists. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The status key to look for.</param> + /// <returns>true if exists. Otherwise, false.</returns> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// { "state", "ON" }, @@ -361,9 +361,9 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Copies the elements of the attributes to an array, starting at a particular index. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="array">The destination array</param> - /// <param name="arrayIndex">The zero-based index in array at which copying begins.</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="array">The destination array.</param> + /// <param name="arrayIndex">The zero-based index in an array at which copying begins.</param> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// { "state", "ON" }, @@ -382,7 +382,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Returns an enumerator that iterates through the collection. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <returns> An enumerator that can be used to iterate through the collection.</returns> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { @@ -400,11 +400,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Removes an attribute from collection + /// Removes an attribute from collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The attributes element to remove</param> - /// <returns>true if operation is success. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The attributes element to remove.</param> + /// <returns>true if operation is successful, otherwise, false.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> @@ -423,11 +423,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Removes an attribute from collection using key + /// Removes an attribute from collection using a key. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The attributes element to remove</param> - /// <returns>true if operation is successful, Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The attributes element to remove.</param> + /// <returns>true if operation is successful, otherwise, false.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> @@ -457,10 +457,10 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Gets the value associated with the specified key. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="key">The key whose value to get.</param> - /// <param name="value"> The value associated with the specified key</param> - /// <returns> true if the attributes collection contains an element with the specified key; otherwise, false.</returns> + /// <param name="value"> The value associated with the specified key.</param> + /// <returns> true if the attributes collection contains an element with the specified key, otherwise, false.</returns> /// <code> /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// { "state", "ON" } @@ -478,7 +478,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Returns an enumerator that iterates through the collection. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> IEnumerator IEnumerable.GetEnumerator() { return _attributes.GetEnumerator(); @@ -487,7 +487,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -498,7 +498,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/CacheUpdatedEventArgs.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/CacheUpdatedEventArgs.cs index 45292f8..7ca278e 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/CacheUpdatedEventArgs.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/CacheUpdatedEventArgs.cs @@ -22,15 +22,15 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// This class represents event arguments of the CacheUpdated event. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class CacheUpdatedEventArgs : EventArgs { internal CacheUpdatedEventArgs() { } /// <summary> - /// Indicates the updated representation of the resource + /// Indicates the updated representation of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The updated representation of the resource.</value> public Representation Representation { get; internal set; } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/DeviceInformationFoundEventArgs.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/DeviceInformationFoundEventArgs.cs index 3a1b30d..605fc03 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/DeviceInformationFoundEventArgs.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/DeviceInformationFoundEventArgs.cs @@ -20,50 +20,50 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// This class represents event arguments of the DeviceInformationFound event. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class DeviceInformationFoundEventArgs { internal DeviceInformationFoundEventArgs() { } /// <summary> - /// The request id + /// The request ID. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The request id.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The request ID.</value> public int RequestId { get; internal set; } /// <summary> /// Indicates to continuously receive the event for finding device information. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Continuously receive the event for finding device information.</value> public bool EventContinue { get; set; } /// <summary> - /// Indicates human friendly name for device + /// Indicates the human friendly name for device. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Human friendly name for device.</value> public string Name { get; internal set; } /// <summary> - /// Indicates spec version of the core specification + /// Indicates the spec version of the core specification. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Spec version of the core specification.</value> public string SpecVersion { get; internal set; } /// <summary> - /// Indicates unique identifier for OIC device + /// Indicates an unique identifier for the OIC device. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Unique identifier for OIC device.</value> public string DeviceId { get; internal set; } /// <summary> - /// Indicates version of the specs this device data model is implemented to + /// Indicates version of the specs this device data model is implemented to. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Version of the specs this device data model is implemented to.</value> public string DataModelVersion { get; internal set; } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingError.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingError.cs index 4a77587..eec4fbe 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingError.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingError.cs @@ -18,56 +18,56 @@ namespace Tizen.Network.IoTConnectivity { /// <summary> - /// Enumeration for resource found errors + /// Enumeration for resource found errors. /// </summary> internal enum FindingError { /// <summary> - /// I/O error + /// I/O error. /// </summary> Io = 1, /// <summary> - /// Out of memory + /// Out of memory. /// </summary> OutOfMemory, /// <summary> - /// Permission denied + /// Permission denied. /// </summary> PermissionDenied, /// <summary> - /// Not supported + /// Not supported. /// </summary> NotSupported, /// <summary> - /// Invalid parameter + /// Invalid parameter. /// </summary> InvalidParameter, /// <summary> - /// No data available + /// No data available. /// </summary> NoData, /// <summary> - /// Time out + /// Time out. /// </summary> TimeOut, /// <summary> - /// IoTivity errors + /// IoTivity errors. /// </summary> Iotivity, /// <summary> - /// Representation errors + /// Representation errors. /// </summary> Representation, /// <summary> - /// Invalid type + /// Invalid type. /// </summary> InvalidType, /// <summary> - /// Already + /// Already. /// </summary> Already, /// <summary> - /// System errors + /// System errors. /// </summary> System } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingErrorOccurredEventArgs.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingErrorOccurredEventArgs.cs index 6179747..bc28027 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingErrorOccurredEventArgs.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingErrorOccurredEventArgs.cs @@ -22,22 +22,22 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// This class represents event arguments of the FindingErrorOccurred event. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class FindingErrorOccurredEventArgs : EventArgs { internal FindingErrorOccurredEventArgs() { } /// <summary> - /// The request id of the operation which caused this error + /// The request ID of the operation, which caused this error. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The request id of the operation which caused this error.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The request ID of the operation, which caused this error.</value> public int RequestId { get; internal set; } /// <summary> /// Contains error details. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Error details.</value> public Exception Error { get; internal set; } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityClientManager.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityClientManager.cs index 2fc8c10..9da873d 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityClientManager.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityClientManager.cs @@ -23,13 +23,13 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// IoT connectivity client manager consists of client side APIs. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public static class IoTConnectivityClientManager { /// <summary> - /// The IP Address for multicast + /// The IP Address for multicast. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public const string MulticastAddress = null; private static int s_presenceListenerId = 1; @@ -42,42 +42,42 @@ namespace Tizen.Network.IoTConnectivity private static Dictionary<IntPtr, Interop.IoTConnectivity.Client.PlatformInformation.PlatformInformationCallback> s_platformInformationCallbacksMap = new Dictionary<IntPtr, Interop.IoTConnectivity.Client.PlatformInformation.PlatformInformationCallback>(); /// <summary> - /// PresenceReceived event. This event is occurred when server starts sending presence of a resource. + /// PresenceReceived event. This event occurs when server starts sending presence of a resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public static event EventHandler<PresenceReceivedEventArgs> PresenceReceived; /// <summary> - /// ResourceFound event. This event is occurred when a resource is found from the remote server + /// ResourceFound event. This event occurs when a resource is found from the remote server /// after sending request using API StartFindingResource(). /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public static event EventHandler<ResourceFoundEventArgs> ResourceFound; /// <summary> - /// PlatformInformationFound event. This event is occurred when platform information is found + /// PlatformInformationFound event. This event occurs when platform information is found /// after sending request using API StartFindingPlatformInformation(). /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public static event EventHandler<PlatformInformationFoundEventArgs> PlatformInformationFound; /// <summary> - /// DeviceInformationFound event. This event is occurred when device information is found + /// DeviceInformationFound event. This event occurs when device information is found /// after sending request using API StartFindingDeviceInformation(). /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public static event EventHandler<DeviceInformationFoundEventArgs> DeviceInformationFound; /// <summary> - /// FindingError event. This event is occurred when an error is found. + /// FindingError event. This event occurs when an error is found. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public static event EventHandler<FindingErrorOccurredEventArgs> FindingErrorOccurred; /// <summary> - /// Timeout in seconds + /// Timeout in seconds. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value> /// Value to be set must be in range from 1 to 3600. Default timeout interval value is 30.\n /// Sets/gets the timeout of StartFindingResource(), StartFindingDeviceInformation(), StartFindingPlatformInformation(), @@ -85,7 +85,7 @@ namespace Tizen.Network.IoTConnectivity /// Setter can throw exception. /// </value> /// <pre> - /// Initialize() should be called to initialize + /// Initialize() should be called to initialize. /// </pre> /// <code> /// IoTConnectivityClientManager.Initialize(); @@ -116,9 +116,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Polling interval of IoTConnectivity + /// Polling interval of IoTConnectivity. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value> /// Sets/Gets the polling inerval(milliseconds) of IoTCon. Default value is 100 milliseconds. /// Value to be set must be in range from 1 to 999. The closer to 0, the faster it operates. @@ -127,7 +127,7 @@ namespace Tizen.Network.IoTConnectivity /// Setter can throw exception. /// </value> /// <pre> - /// Initialize() should be called to initialize + /// Initialize() should be called to initialize. /// </pre> /// <code> /// IoTConnectivityClientManager.Initialize(); @@ -161,7 +161,7 @@ namespace Tizen.Network.IoTConnectivity /// Initializes IoTCon. /// Call this function to start IoTCon. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// @a filePath point to a file for handling secure virtual resources. /// The file that is CBOR(Concise Binary Object Representation)-format must already exist @@ -178,9 +178,9 @@ namespace Tizen.Network.IoTConnectivity /// You must call Deinitialize() if IoTCon API is no longer needed. /// </post> /// <seealso cref="Deinitialize()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> /// <code> /// string filePath = "../../res/iotcon-test-svr-db-client.dat"; /// IoTConnectivityClientManager.Initialize(filePath); @@ -198,7 +198,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Deinitializes IoTCon. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// This API must be called if IoTCon API is no longer needed. /// </remarks> @@ -234,7 +234,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Invokes a next message from a queue for receiving messages from others, immediately. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// This API invokes a next message from a queue for receiving messages from others, immediately. /// After calling the API, it continues the polling with existing interval. @@ -243,7 +243,7 @@ namespace Tizen.Network.IoTConnectivity /// <pre> /// Initialize() should be called to initialize. /// </pre> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> /// <code> /// IoTConnectivityClientManager.InvokePolling(); /// </code> @@ -258,9 +258,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Starts receiving presence events + /// Starts receiving presence events. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// Sends request to receive presence to an interested server's resource with resourceType. /// If succeeded, <see cref="PresenceReceived"/> event handler will be triggered when the server sends presence. @@ -273,9 +273,9 @@ namespace Tizen.Network.IoTConnectivity /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="hostAddress">The address or addressable name of the server</param> - /// <param name="resourceType">A resource type that a client is interested in</param> - /// <returns>PresenceId - An identifier for this request</returns> + /// <param name="hostAddress">The address or addressable name of the server.</param> + /// <param name="resourceType">A resource type that a client is interested in.</param> + /// <returns>PresenceId - An identifier for this request.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre>Initialize() should be called to initialize.</pre> /// <post> @@ -286,11 +286,11 @@ namespace Tizen.Network.IoTConnectivity /// <seealso cref="IoTConnectivityServerManager.StopSendingPresence()"/> /// <seealso cref="StopReceivingPresence()"/> /// <seealso cref="PresenceReceived"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// EventHandler<PresenceReceivedEventArgs> handler = (sender, e) => { /// Console.Log("PresenceReceived, presence id :" + e.PresenceId); @@ -366,9 +366,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Stops receiving presence events + /// Stops receiving presence events. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// Sends request to not to receive server's presence any more. /// </remarks> @@ -376,7 +376,7 @@ namespace Tizen.Network.IoTConnectivity /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="presenceId">The start presence request identifier</param> + /// <param name="presenceId">The start presence request identifier.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre> /// Initialize() should be called to initialize. @@ -385,11 +385,11 @@ namespace Tizen.Network.IoTConnectivity /// <seealso cref="IoTConnectivityServerManager.StopSendingPresence()"/> /// <seealso cref="StartReceivingPresence()"/> /// <seealso cref="PresenceReceived"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// EventHandler<PresenceReceivedEventArgs> handler = (sender, e) => { /// Console.Log("PresenceReceived, presence id :" + e.PresenceId); @@ -442,11 +442,11 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Starts finding resources. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// Sends request to find a resource of @a hostAddress server with @a resourceType. /// If succeeded, <see cref="ResourceFound"/> event handler will be triggered with information of the resource.\n - /// @a hostAddress could be <see cref="MulticastAddress"/> for IPv4 multicast. + /// @a hostAddress could be <see cref="MulticastAddress"/> for the IPv4 multicast. /// The length of @a resourceType should be less than or equal to 61. The @ resourceType must start with a lowercase alphabetic character, followed by a sequence /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space. /// </remarks> @@ -454,9 +454,9 @@ namespace Tizen.Network.IoTConnectivity /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="hostAddress">The address or addressable name of the server. The address includes a protocol like coaps://</param> - /// <param name="query">The query specified as a filter for founding resources</param> - /// <returns>RequestId - An identifier for this request</returns> + /// <param name="hostAddress">The address or addressable name of the server. The address includes a protocol like coaps://.</param> + /// <param name="query">The query specified as a filter for founding resources.</param> + /// <returns>RequestId - An identifier for this request.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre>Initialize() should be called to initialize.</pre> /// <post> @@ -465,10 +465,10 @@ namespace Tizen.Network.IoTConnectivity /// <seealso cref="ResourceFound"/> /// <seealso cref="ResourceFoundEventArgs"/> /// <seealso cref="TimeOut"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// EventHandler<ResourceFoundEventArgs> handler = (sender, e) => { /// Console.Log("Found resource at host address :" + e.Resource.HostAddress + ", uri :" + e.Resource.UriPath); @@ -555,19 +555,19 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Starts finding the device information of remote server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// Requests server for device information. /// If succeeded, <see cref="DeviceInformationFound"/> event handler will be triggered with information of the device.\n - /// @a hostAddress could be <see cref="MulticastAddress"/> for IPv4 multicast. + /// @a hostAddress could be <see cref="MulticastAddress"/> for the IPv4 multicast. /// </remarks> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="hostAddress">The host address of remote server</param> - /// <param name="query">The query specified as a filter for founding resources</param> - /// <returns>RequestId - An identifier for this request</returns> + /// <param name="hostAddress">The host address of the remote server.</param> + /// <param name="query">The query specified as a filter for founding resources.</param> + /// <returns>RequestId - An identifier for this request.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre>Initialize() should be called to initialize.</pre> /// <post> @@ -577,10 +577,10 @@ namespace Tizen.Network.IoTConnectivity /// <seealso cref="DeviceInformationFound"/> /// <seealso cref="DeviceInformationFoundEventArgs"/> /// <seealso cref="TimeOut"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// EventHandler<DeviceInformationFoundEventArgs> handler = (sender, e) => { /// Console.Log("Device information found, id : " + e.RequestId + ", name : " + e.Name); @@ -658,7 +658,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Starts finding the platform information of remote server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// Requests server for platform information. /// If succeeded, <see cref="PlatformInformationFound" /> event handler will be triggered with information of the platform.\n @@ -668,9 +668,9 @@ namespace Tizen.Network.IoTConnectivity /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="hostAddress">The host address of remote server</param> - /// <param name="query">The query specified as a filter for founding resources</param> - /// <returns>RequestId - An identifier for this request</returns> + /// <param name="hostAddress">The host address of remote server.</param> + /// <param name="query">The query specified as a filter for founding resources.</param> + /// <returns>RequestId - An identifier for this request.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre>Initialize() should be called to initialize.</pre> /// <post> @@ -679,10 +679,10 @@ namespace Tizen.Network.IoTConnectivity /// <seealso cref="PlatformInformationFound"/> /// <seealso cref="PlatformInformationFoundEventArgs"/> /// <seealso cref="TimeOut"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// EventHandler<PlatformInformationFoundEventArgs> handler = (sender, e) => { /// Console.Log("PlatformInformationFound :" + e.RequestId); diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs index 4256414..1a89430 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs @@ -22,16 +22,16 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// IoT connectivity server manager consists of server side APIs. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public static class IoTConnectivityServerManager { private static int s_requestId = 1; private static Dictionary<IntPtr, Interop.IoTConnectivity.Server.Resource.RequestHandlerCallback> s_RequestHandlerCallbackMap = new Dictionary<IntPtr, Interop.IoTConnectivity.Server.Resource.RequestHandlerCallback>(); /// <summary> - /// Initializes IoTCon. Call this API to start IoTCon. + /// Initializes IoTCon. Calls this API to start IoTCon. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// @a filePath point to a file for handling secure virtual resources. /// The file that is CBOR(Concise Binary Object Representation)-format must already exist @@ -48,9 +48,9 @@ namespace Tizen.Network.IoTConnectivity /// You must call Deinitialize() if IoTCon API is no longer needed. /// </post> /// <seealso cref="Deinitialize()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access</exception> /// <code> /// string filePath = "../../res/iotcon-test-svr-db-server.dat"; /// IoTConnectivityServerManager.Initialize(filePath); @@ -68,7 +68,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Deinitializes IoTCon. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// This API must be called if IoTCon API is no longer needed. /// </remarks> @@ -90,25 +90,25 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Registers a resource in IoTCon server + /// Registers a resource in IoTCon server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="resource">The resource to register</param> + /// <param name="resource">The resource to register.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre> /// Initialize() should be called to initialize. /// </pre> /// <seealso cref="Resource"/> /// <seealso cref="LiteResource"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> /// <code> /// ResourceTypes types = new ResourceTypes(new List<string>(){ "org.tizen.light" }); /// Attributes attributes = new Attributes { { "state", "ON" }}; @@ -162,22 +162,22 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Unregisters a resource in IoTCon server + /// Unregisters a resource in IoTCon server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="resource">The resource to unregister</param> + /// <param name="resource">The resource to unregister.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre> /// Initialize() should be called to initialize. /// </pre> /// <seealso cref="Resource"/> /// <seealso cref="LiteResource"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> /// <code> /// ResourceTypes types = new ResourceTypes(new List<string>(){ "org.tizen.light" }); /// Attributes attributes = new Attributes { { "state", "ON" }}; @@ -204,9 +204,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Starts presence of a server + /// Starts presence of a server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// Use this API to send server's announcements to clients. /// Server can call this API when online for the first time or come back from offline to online.\n @@ -226,9 +226,9 @@ namespace Tizen.Network.IoTConnectivity /// <seealso cref="IoTConnectivityClientManager.StopReceivingPresence()"/> /// <seealso cref="IoTConnectivityClientManager.PresenceReceived"/> /// <seealso cref="StopSendingPresence()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> /// <code> /// try { /// IoTConnectivityServerManager.StartSendingPresence(120); @@ -249,7 +249,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Stops presence of a server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// Use this API to stop sending server's announcements to clients. /// Server can call this API when terminating, entering to offline or out of network. @@ -266,9 +266,9 @@ namespace Tizen.Network.IoTConnectivity /// <seealso cref="IoTConnectivityClientManager.StopReceivingPresence()"/> /// <seealso cref="IoTConnectivityClientManager.PresenceReceived"/> /// <seealso cref="StartSendingPresence()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> /// <code> /// IoTConnectivityServerManager.StopSendingPresence(); /// </code> @@ -283,21 +283,21 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Sets the device name + /// Sets the device name. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// This API sets the name of the local device (the device calling the API).\n /// If the device name is set, clients can get the name using <see cref="IoTConnectivityClientManager.StartFindingDeviceInformation()"/>. /// </remarks> - /// <param name="deviceName">The device name</param> + /// <param name="deviceName">The device name.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="IoTConnectivityClientManager.DeviceInformationFound"/> /// <seealso cref="IoTConnectivityClientManager.StartFindingDeviceInformation()"/> /// <seealso cref="DeviceInformationFoundEventArgs"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> /// <code> /// IoTConnectivityServerManager.SetDeviceName("my-tizen"); /// </code> diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs index f6238c6..b7b4801 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs @@ -22,29 +22,29 @@ namespace Tizen.Network.IoTConnectivity /// It provides APIs to encapsulate resources. /// This class is accessed by using a constructor to create a new instance of this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class LiteResource : Resource { /// <summary> - /// The LiteResource constructor + /// The LiteResource constructor. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> - /// Creates a lite resource which can then be registered in server using <see cref="IoTConnectivityServerManager.RegisterResource()"/>.\n - /// When client requests some operations, it send a response to client, automatically.\n + /// Creates a lite resource, which can then be registered in server using <see cref="IoTConnectivityServerManager.RegisterResource()"/>.\n + /// When client requests some operations, it sends a response to client automatically.\n /// @a uri length must be less than 128. /// </remarks> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="uri">The uri path of the lite resource</param> - /// <param name="types">The type of the resource</param> - /// <param name="policy">Policy of the resource</param> - /// <param name="attribs">Optional attributes of the resource</param> + /// <param name="uri">The uri path of the lite resource.</param> + /// <param name="types">The type of the resource.</param> + /// <param name="policy">Policy of the resource.</param> + /// <param name="attribs">Optional attributes of the resource.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre> - /// IoTConnectivityServerManager.Initialize() should be called to initialize + /// IoTConnectivityServerManager.Initialize() should be called to initialize. /// </pre> /// <seealso cref="ResourceTypes"/> /// <seealso cref="ResourcePolicy"/> @@ -63,9 +63,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets or sets the attributes of the lite resource + /// Gets or sets the attributes of the lite resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The attributes of the lite resource.</value> /// <code> /// List<string> list = new List<string>() { "org.tizen.light" }; @@ -84,12 +84,12 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Decides whether to accept or reject a post request. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// Child classes of this class can override this method to accept or reject post request. /// </remarks> - /// <param name="attribs">The new attributes of the lite resource</param> - /// <returns>true to accept post request, false to reject it</returns> + /// <param name="attribs">The new attributes of the lite resource.</param> + /// <returns>true to accept post request, false to reject it.</returns> /// <code> /// public class MyLightResource : LiteResource /// { diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObservePolicy.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObservePolicy.cs index f50901b..b70b841 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObservePolicy.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObservePolicy.cs @@ -18,20 +18,20 @@ namespace Tizen.Network.IoTConnectivity { /// <summary> - /// Enumeration for policy of observation + /// Enumeration for the policy of observation. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public enum ObservePolicy { /// <summary> - /// Indicates observation request for most up-to-date notifications only + /// Indicates the observation request for the most up-to-date notifications only. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> IgnoreOutOfOrder = 0, /// <summary> - /// Indicates observation request for all notifications including state notifications + /// Indicates the observation request for all notifications including state notifications. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> AcceptOutOfOrder } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserveType.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserveType.cs index ca611bb..6329bef 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserveType.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserveType.cs @@ -18,27 +18,27 @@ namespace Tizen.Network.IoTConnectivity { /// <summary> - /// Enumeration for type of observation + /// Enumeration for the type of observation. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public enum ObserveType { /// <summary> - /// No observe action + /// No observe action. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> NoType = 0, /// <summary> - /// Indicates action of registering observation + /// Indicates an action of the registering observation. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Register = 1, /// <summary> - /// Indicates action of unregistering observation + /// Indicates an action of unregistering observation. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Deregister = 2, } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserverNotifiedEventArgs.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserverNotifiedEventArgs.cs index edbbef2..1e7c6ab 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserverNotifiedEventArgs.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserverNotifiedEventArgs.cs @@ -22,22 +22,22 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// This class represents event arguments of the ObserverNotified event. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class ObserverNotifiedEventArgs : EventArgs { internal ObserverNotifiedEventArgs() { } /// <summary> - /// Result of the observe response + /// Result of the observe response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Result of the observe response.</value> public ResponseCode Result { get; internal set; } /// <summary> /// Representation of the resource being observed. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Representation of the resource being observed.</value> public Representation Representation { get; internal set; } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PlatformInformationFoundEventArgs.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PlatformInformationFoundEventArgs.cs index 312f05f..d7279e9 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PlatformInformationFoundEventArgs.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PlatformInformationFoundEventArgs.cs @@ -20,100 +20,100 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// This class represents event arguments of the PlatformInformationFound event. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class PlatformInformationFoundEventArgs { internal PlatformInformationFoundEventArgs() { } /// <summary> - /// Indicates the request id + /// Indicates the request ID. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The request id.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The request ID.</value> public int RequestId { get; internal set; } /// <summary> - /// Indicates to continuously receive the event for finding platform information. + /// Indicates to continuously receive the event for finding the platform information. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Continuously receive the event for finding platform information.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>Continuously receive the event for finding the platform information.</value> public bool EventContinue { get; set; } /// <summary> - /// Indicates the platform identifier + /// Indicates the platform identifier. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The platform identifier.</value> public string PlatformId { get; internal set; } /// <summary> - /// Indicates the name of manufacturer + /// Indicates the name of the manufacturer. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The name of manufacturer.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The name of the manufacturer.</value> public string ManufacturerName { get; internal set; } /// <summary> - /// Indicates URL of the manufacturer + /// Indicates the URL of the manufacturer. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>URL of the manufacturer.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The URL of the manufacturer.</value> public string ManufacturerURL { get; internal set; } /// <summary> - /// Indicates model number as designated by manufacturer + /// Indicates the model number as designated by the manufacturer. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Model number as designated by manufacturer.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The model number as designated by the manufacturer.</value> public string ModelNumber { get; internal set; } /// <summary> - /// Indicates manufacturing date of the device + /// Indicates the manufacturing date of the device. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Manufacturing date of the device.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The manufacturing date of the device.</value> public string DateOfManufacture { get; internal set; } /// <summary> - /// Indicates version of platfrom defined by manufacturer + /// Indicates the version of the platfrom defined by the manufacturer. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Version of platfrom defined by manufacturer.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The version of platfrom defined by manufacturer.</value> public string PlatformVersion { get; internal set; } /// <summary> - /// Indicates version of platfrom resident OS + /// Indicates the version of the platfrom resident OS. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Version of platfrom resident OS.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The version of the platfrom resident OS.</value> public string OsVersion { get; internal set; } /// <summary> - /// Indicates version of platform Hardware + /// Indicates the version of the platform Hardware. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Version of platform Hardware.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The version of the platform Hardware.</value> public string HardwareVersion { get; internal set; } /// <summary> - /// Indicates version of device firmware + /// Indicates the version of the device firmware. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Version of device firmware.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The version of the device firmware.</value> public string FirmwareVersion { get; internal set; } /// <summary> - /// Indicates URL that points to support information from manufacturer + /// Indicates the URL that points to support information from the manufacturer. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>URL that points to support information from manufacturer.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The URL that points to support information from the manufacturer.</value> public string SupportUrl { get; internal set; } /// <summary> - /// Indicates reference time of the device + /// Indicates the reference time of the device. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Reference time of the device.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The reference time of the device.</value> public string SystemTime { get; internal set; } } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceEventType.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceEventType.cs index 77ba72a..5c7b58f 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceEventType.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceEventType.cs @@ -20,23 +20,23 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Enumeration for operation of presence response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public enum PresenceEventType { /// <summary> - /// Indicates for resource creation operation of server + /// Indicates the resource creation operation of the server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> ResourceCreated = 0, /// <summary> - /// Indicates for resource updation operation of server + /// Indicates the resource updation operation of the server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> ResourceUpdated, /// <summary> - /// Indicates for resource destruction operation of server + /// Indicates the resource destruction operation of the server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> ResourceDestroyed } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceReceivedEventArgs.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceReceivedEventArgs.cs index 0138c11..4fc0238 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceReceivedEventArgs.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceReceivedEventArgs.cs @@ -22,37 +22,37 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// This class represents event arguments of the PresenceReceived event. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class PresenceReceivedEventArgs : EventArgs { internal PresenceReceivedEventArgs() { } /// <summary> - /// Indicates request id of presence event. + /// Indicates the request ID of the presence event. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Request id of presence event.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The request ID of the presence event.</value> public int PresenceId { get; internal set; } /// <summary> - /// Indicates event type + /// Indicates the event type. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Event type.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The event type.</value> public PresenceEventType EventType { get; internal set; } /// <summary> - /// Indicates host address of resource + /// Indicates the host address of resource. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Host address of resource.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The host address of resource.</value> public string HostAddress { get; internal set; } /// <summary> - /// Indicates type of the resource + /// Indicates the type of the resource. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>Type of the resource.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The type of the resource.</value> public string Type { get; internal set; } } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/QualityOfService.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/QualityOfService.cs index c05ffc9..54eed08 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/QualityOfService.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/QualityOfService.cs @@ -20,18 +20,18 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Enumeration for states of remote resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public enum QualityOfService { /// <summary> - /// Indicates low quality of service + /// Indicates the low quality of service. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Low = 0, /// <summary> - /// Indicates high quality of service + /// Indicates the high quality of service. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> High } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs index 3844199..af90596 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs @@ -27,7 +27,7 @@ namespace Tizen.Network.IoTConnectivity /// This class represents a remote resource. /// It provides APIs to manage remote resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class RemoteResource : IDisposable { internal const int TimeOutMax = 3600; @@ -47,24 +47,24 @@ namespace Tizen.Network.IoTConnectivity private EventHandler<StateChangedEventArgs> _stateChangedEventHandler; /// <summary> - /// Creates a remote resource instance + /// Creates a remote resource instance. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> - /// To use this API, you should provide all of the details required to correctly contact and + /// To use this API, you should provide all the details required to correctly contact and /// observe the object.\n /// If not, you should discover the resource object manually.\n /// The @a policy can contain multiple policies like ResourcePolicy.Discoverable | ResourcePolicy.Observable. /// </remarks> - /// <param name="hostAddress">The host address of the resource</param> - /// <param name="uriPath">The URI path of the resource</param> - /// <param name="policy">The policies of the resource</param> - /// <param name="resourceTypes">The resource types of the resource</param> - /// <param name="resourceInterfaces">The resource interfaces of the resource</param> + /// <param name="hostAddress">The host address of the resource.</param> + /// <param name="uriPath">The URI path of the resource.</param> + /// <param name="policy">The policies of the resource.</param> + /// <param name="resourceTypes">The resource types of the resource.</param> + /// <param name="resourceInterfaces">The resource interfaces of the resource.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> public RemoteResource(string hostAddress, string uriPath, ResourcePolicy policy, ResourceTypes resourceTypes, ResourceInterfaces resourceInterfaces) { if (hostAddress == null || uriPath == null || resourceTypes == null || resourceInterfaces == null) @@ -103,21 +103,21 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Event that is invoked with cached resource attributes + /// The event is invoked with cached resource attributes. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public event EventHandler<CacheUpdatedEventArgs> CacheUpdated; /// <summary> - /// Observe event on the resource sent by the server + /// Observe an event on the resource sent by the server. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public event EventHandler<ObserverNotifiedEventArgs> ObserverNotified; /// <summary> - /// Event that is called when remote resource's state are changed + /// The event is called when remote resource's state are changed. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public event EventHandler<StateChangedEventArgs> StateChanged { add @@ -139,47 +139,47 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// The host address of the resource + /// The host address of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The host address of the resource.</value> public string HostAddress { get; private set; } /// <summary> - /// The URI path of the resource + /// The URI path of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The URI path of the resource.</value> public string UriPath { get; private set; } /// <summary> - /// The resource types of the remote resource + /// The resource types of the remote resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The resource types of the remote resource.</value> public IEnumerable<string> Types { get; private set; } /// <summary> - /// The interfaces of the resource + /// The interfaces of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The interfaces of the resource.</value> public IEnumerable<string> Interfaces { get; private set; } /// <summary> - /// The policy of the resource + /// The policy of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The policy of the resource.</value> public ResourcePolicy Policy { get; private set; } /// <summary> - /// The header options of the resource + /// The header options of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The header options of the resource.</value> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> public ResourceOptions Options { get @@ -204,15 +204,15 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Indicates the CacheEnabled status of the remote resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value> /// Client can start caching only when this is set true. Set it to false to stop caching the resource attributes. /// </value> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> public bool CacheEnabled { get @@ -230,15 +230,15 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Time interval of monitoring and caching API + /// Time interval of monitoring and caching API. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value> /// Default time interval is 10 seconds. - /// Seconds for time interval (must be in range from 1 to 3600) + /// Seconds for time interval (must be in range from 1 to 3600). /// </value> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> public int TimeInterval { get @@ -268,17 +268,17 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// The device id of the resource + /// The device ID of the resource. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The device id of the resource.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The device ID of the resource.</value> public string DeviceId { get; private set; } /// <summary> - /// Gets cached representation from the remote resource + /// Gets cached representation from the remote resource. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>cached representation from the remote resource</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>cached representation from the remote resource.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> public Representation CachedRepresentation() { @@ -295,9 +295,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Starts observing on the resource + /// Starts observing on the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// When server sends notification message, <see cref="ObserverNotified"/> will be called. /// </remarks> @@ -305,13 +305,13 @@ namespace Tizen.Network.IoTConnectivity /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="policy">The type to specify how client wants to observe</param> - /// <param name="query">The query to send to server</param> + /// <param name="policy">The type to specify how client wants to observe.</param> + /// <param name="query">The query to send to server.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> public void StartObserving(ObservePolicy policy, ResourceQuery query = null) { _observeCallback = (IntPtr resource, int err, int sequenceNumber, IntPtr response, IntPtr userData) => @@ -366,17 +366,17 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Stops observing on the resource + /// Stops observing on the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> public void StopObserving() { int ret = Interop.IoTConnectivity.Client.RemoteResource.DeregisterObserve(_remoteResourceHandle); @@ -388,15 +388,15 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets the attributes of a resource, asynchronously + /// Gets the attributes of a resource asynchronously. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="query">The ResourceQuery to send to server</param> - /// <returns>Remote response with result and representation</returns> + /// <param name="query">The ResourceQuery to send to server.</param> + /// <returns>Remote response with result and representation.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> public async Task<RemoteResponse> GetAsync(ResourceQuery query = null) { @@ -444,16 +444,16 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Puts the representation of a resource, asynchronously. + /// Puts the representation of a resource asynchronously. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="representation">Resource representation to put</param> - /// <param name="query">The ResourceQuery to send to server</param> - /// <returns>Remote response with result and representation</returns> + /// <param name="representation">Resource representation to put.</param> + /// <param name="query">The ResourceQuery to send to server.</param> + /// <returns>Remote response with result and representation.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> public async Task<RemoteResponse> PutAsync(Representation representation, ResourceQuery query = null) { @@ -506,16 +506,16 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Post request on a resource, asynchronously + /// Posts request on a resource asynchronously. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="representation">Resource representation of request</param> - /// <param name="query">The ResourceQuery to send to server</param> - /// <returns>Remote response with result and representation</returns> + /// <param name="representation">Resource representation of request.</param> + /// <param name="query">The ResourceQuery to send to server.</param> + /// <returns>Remote response with result and representation.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> public async Task<RemoteResponse> PostAsync(Representation representation, ResourceQuery query = null) { @@ -561,14 +561,14 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Deletes the resource, asynchronously + /// Deletes the resource asynchronously. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <returns>Remote response with result and representation</returns> + /// <returns>Remote response with result and representation.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> public async Task<RemoteResponse> DeleteAsync() { @@ -623,7 +623,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -696,7 +696,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResponse.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResponse.cs index 667b5c3..cff7d44 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResponse.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResponse.cs @@ -21,29 +21,29 @@ namespace Tizen.Network.IoTConnectivity /// This class represents a remote response. /// It represents the response of all CRUD operations. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class RemoteResponse { internal RemoteResponse() { } /// <summary> - /// Indicates the result of the response + /// Indicates the result of the response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The result of the response.</value> public ResponseCode Result { get; internal set; } /// <summary> - /// Indicates representation of the response + /// Indicates representation of the response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Representation of the response.</value> public Representation Representation { get; internal set; } /// <summary> - /// Indicates header options of the response + /// Indicates header options of the response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Header options of the response.</value> public ResourceOptions Options { get; internal set; } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Representation.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Representation.cs index 7f7b633..8281a55 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Representation.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Representation.cs @@ -26,7 +26,7 @@ namespace Tizen.Network.IoTConnectivity /// This class provides APIs to manage representation. /// A representation is a payload of a request or a response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class Representation : IDisposable { internal IntPtr _representationHandle = IntPtr.Zero; @@ -35,13 +35,13 @@ namespace Tizen.Network.IoTConnectivity private ObservableCollection<Representation> _children = new ObservableCollection<Representation>(); /// <summary> - /// The Representation constructor + /// The Representation constructor. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> /// <code> /// Representation repr = new Representation(); /// </code> @@ -83,16 +83,16 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// The URI path of resource + /// The URI path of resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value> /// The URI path of resource. - /// Setter can throw exceptions + /// Setter can throw exceptions. /// </value> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// Representation repr = new Representation(); /// repr.UriPath = "/a/light"; @@ -125,14 +125,14 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// The type of resource + /// The type of resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The type of resource.</value> /// <seealso cref="ResourceTypes"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// Representation repr = new Representation(); /// ResourceTypes types = new ResourceTypes (new List<string>(){ "org.tizen.light" }); @@ -170,14 +170,14 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// The interface of the resource + /// The interface of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The interface of the resource.</value> /// <seealso cref="ResourceInterfaces"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// Representation repr = new Representation(); /// ResourceInterfaces ifaces = new ResourceInterfaces (new List<string>(){ ResourceInterfaces.DefaultInterface }); @@ -215,14 +215,14 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Current attributes of the resource + /// Current attributes of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Current attributes of the resource.</value> /// <seealso cref="Attributes"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// Representation repr = new Representation(); /// Attributes attributes = new Attributes() { @@ -264,9 +264,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// List of Child resource representation + /// List of Child resource representation. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>List of Child resource representation.</value> /// <code> /// Representation repr = new Representation(); @@ -296,7 +296,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -307,7 +307,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Request.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Request.cs index 93d5326..bbaeae5 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Request.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Request.cs @@ -23,7 +23,7 @@ namespace Tizen.Network.IoTConnectivity /// Class respresenting request to a resource. /// It provides APIs to manage client's request. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class Request : IDisposable { private bool _disposed = false; @@ -41,37 +41,37 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// The host address of the request + /// The host address of the request. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The host address of the request.</value> public string HostAddress { get; internal set; } /// <summary> - /// The representation of the request + /// The representation of the request. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The representation of the request.</value> public Representation Representation { get; internal set; } /// <summary> - /// The query of the request + /// The query of the request. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The query of the request.</value> public ResourceQuery Query { get; internal set; } /// <summary> - /// The options related to the request + /// The options related to the request. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The options related to the request.</value> public ResourceOptions Options { get; internal set; } /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -82,7 +82,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs index 27f0c94..deb277c 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs @@ -26,7 +26,7 @@ namespace Tizen.Network.IoTConnectivity /// Abstract class respresenting a resource. /// All resources need to inherit from this class. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public abstract class Resource : IDisposable { private IntPtr _resourceHandle = IntPtr.Zero; @@ -35,9 +35,9 @@ namespace Tizen.Network.IoTConnectivity private IntPtr _observerHandle = IntPtr.Zero; /// <summary> - /// The constructor + /// The constructor. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// @a uri format would be relative URI path like '/a/light' /// and its length must be less than 128. @@ -46,19 +46,19 @@ namespace Tizen.Network.IoTConnectivity /// http://tizen.org/privilege/internet /// </privilege> /// <privlevel>public</privlevel> - /// <param name="uri">The URI path of the resource</param> - /// <param name="types">Resource types</param> - /// <param name="interfaces">Resource interfaces</param> - /// <param name="policy">The policies of the resoruce</param> + /// <param name="uri">The URI path of the resource.</param> + /// <param name="types">Resource types.</param> + /// <param name="interfaces">Resource interfaces.</param> + /// <param name="policy">The policies of the resoruce.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre> - /// IoTConnectivityServerManager.Initialize() should be called to initialize + /// IoTConnectivityServerManager.Initialize() should be called to initialize. /// </pre> /// <seealso cref="ResourceTypes"/> /// <seealso cref="ResourceInterfaces"/> /// <seealso cref="ResourcePolicy"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// // Create a class which inherits from Resource /// public class DoorResource : Resource @@ -106,37 +106,37 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Type details of the resource + /// Type details of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Type details of the resource.</value> public ResourceTypes Types { get; internal set; } /// <summary> - /// Interface details of the resource + /// Interface details of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Interface details of the resource.</value> public ResourceInterfaces Interfaces { get; internal set; } /// <summary> - /// The policies of the resource + /// The policies of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The policies of the resource.</value> public ResourcePolicy Policy { get; internal set; } /// <summary> - /// URI path of the resource + /// URI path of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>URI path of the resource.</value> public string UriPath { get; internal set; } /// <summary> - /// List of Child resources + /// List of Child resources. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>List of Child resources.</value> public ICollection<Resource> Children { @@ -161,7 +161,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Notify the specified representation and qos. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <privilege> /// http://tizen.org/privilege/internet /// </privilege> @@ -170,13 +170,13 @@ namespace Tizen.Network.IoTConnectivity /// <param name="qos">The quality of service for message transfer.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <pre> - /// IoTConnectivityServerManager.Initialize() should be called to initialize + /// IoTConnectivityServerManager.Initialize() should be called to initialize. /// </pre> /// <seealso cref="Representation"/> /// <seealso cref="QualityOfService"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceInterfaces ifaces = new ResourceInterfaces(new List<string>(){ ResourceInterfaces.DefaultInterface }); /// ResourceTypes types = new ResourceTypes(new List<string>(){ "oic.iot.door.new.notify" }); @@ -203,43 +203,43 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// This is Called when the client performs get operation on this resource. + /// This is called when the client performs get operation on this resource. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="request">A request from client</param> - /// <returns>A response having the representation and the result</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="request">A request from client.</param> + /// <returns>A response having the representation and the result.</returns> protected abstract Response OnGet(Request request); /// <summary> - /// This is Called when the client performs put operation on this resource. + /// This is called when the client performs put operation on this resource. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="request">A request from client</param> - /// <returns>A response</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="request">A request from client.</param> + /// <returns>A response.</returns> protected abstract Response OnPut(Request request); /// <summary> - /// This is Called when the client performs post operation on this resource. + /// This is called when the client performs post operation on this resource. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="request">A request from client</param> - /// <returns>A response having the representation and the result</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="request">A request from client.</param> + /// <returns>A response having the representation and the result.</returns> protected abstract Response OnPost(Request request); /// <summary> - /// This is Called when the client performs delete operation on this resource. + /// This is called when the client performs delete operation on this resource. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="request">A request from client</param> - /// <returns>A response</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="request">A request from client.</param> + /// <returns>A response.</returns> protected abstract Response OnDelete(Request request); /// <summary> /// Called on the observing event. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="request">A request from client</param> - /// <param name="type">Observer type</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="request">A request from client.</param> + /// <param name="type">Observer type.</param> /// <param name="observeId">Observe identifier.</param> /// <returns>Returns true if it wants to be observed, else false.</returns> protected abstract bool OnObserving(Request request, ObserveType type, int observeId); @@ -247,7 +247,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -258,7 +258,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceFoundEventArgs.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceFoundEventArgs.cs index 86a9c8a..6673d7f 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceFoundEventArgs.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceFoundEventArgs.cs @@ -22,30 +22,30 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// This class represents event arguments of the ResourceFound event. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class ResourceFoundEventArgs : EventArgs { internal ResourceFoundEventArgs() { } /// <summary> - /// Indicates the request id. - /// This is the same request id returned by the <see cref="IoTConnectivityClientManager.StartFindingResource()"/> API. + /// Indicates the request ID. + /// This is the same request ID returned by the <see cref="IoTConnectivityClientManager.StartFindingResource()"/> API. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The request id.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The request ID.</value> public int RequestId { get; internal set; } /// <summary> /// Indicates to continuously receive the event for finding resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Continuously receive the event for finding resource.</value> public bool EventContinue { get; set; } /// <summary> - /// Remote resource which is found after <see cref="IoTConnectivityClientManager.StartFindingResource()"/>. + /// Remote resource, which is found after <see cref="IoTConnectivityClientManager.StartFindingResource()"/>. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Remote resource which is found after <see cref="IoTConnectivityClientManager.StartFindingResource()"/>.</value> /// <seealso cref="IoTConnectivityClientManager.ResourceFound"/> /// <seealso cref="IoTConnectivityClientManager.StartFindingResource()"/> diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs index 8d0f789..fbdf220 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs @@ -23,40 +23,40 @@ using System.Text.RegularExpressions; namespace Tizen.Network.IoTConnectivity { /// <summary> - /// This class contains resource interfaces and provides APIs to manage, add, remove those interfaces. + /// This class contains resource interfaces and provides APIs to manage, add, or remove those interfaces. /// A resource interface indicates a class or category of resources. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class ResourceInterfaces : IEnumerable<string>, IDisposable { /// <summary> - /// Default Interface + /// Default Interface. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public const string DefaultInterface = "oic.if.baseline"; /// <summary> - /// List Links Interface which is used to list the references to other resources contained in a resource. + /// List Links Interface, which is used to list the references to other resources contained in a resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public const string LinkInterface = "oic.if.ll"; /// <summary> - /// Batch Interface which is used to manipulate (GET, PUT, POST, DELETE) on other resource contained in a resource. + /// Batch Interface, which is used to manipulate (GET, PUT, POST, DELETE) on other resource contained in a resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public const string BatchInterface = "oic.if.b"; /// <summary> - /// Group Interface which is used to manipulate (GET, PUT, POST) a group of remote resources. + /// Group Interface, which is used to manipulate (GET, PUT, POST) a group of remote resources. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public const string GroupInterface = "oic.mi.grp"; /// <summary> - /// Read-Only Interface which is used to limit the methods that can be applied to a resource to GET only. + /// Read-Only Interface, which is used to limit the methods that can be applied to a resource to GET only. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public const string ReadonlyInterface = "oic.if.r"; private readonly IntPtr _resourceInterfacesHandle = IntPtr.Zero; @@ -65,14 +65,14 @@ namespace Tizen.Network.IoTConnectivity private bool _disposed = false; /// <summary> - /// Constructor of ResourceInterfaces + /// Constructor of ResourceInterfaces. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> /// <seealso cref="Remove()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(); /// </code> @@ -87,14 +87,14 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Constructor of ResourceInterfaces using list of interfaces + /// Constructor of ResourceInterfaces using list of interfaces. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="ifaces">List of resource interfaces</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="ifaces">List of resource interfaces.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> /// <code> /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(new List<string>() /// { ResourceInterfaces.LinkInterface, ResourceInterfaces.ReadonlyInterface }); @@ -155,7 +155,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Indicates count of interfaces in the list /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Count of interfaces in the list.</value> /// <code> /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(new List<string>() @@ -173,16 +173,16 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Adds a resource interface into the list. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> - /// @a item could be a value such as <see cref="DefaultInterface"/> + /// @a item could be a value, such as <see cref="DefaultInterface"/>. /// </remarks> - /// <param name="item">The string data to insert into the resource interfaces</param> + /// <param name="item">The string data to insert into the resource interfaces.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Remove()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> /// <code> /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(); /// resourceInterfaces.Add(ResourceInterfaces.BatchInterface); @@ -207,15 +207,15 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Removes a resource interface from the list + /// Removes a resource interface from the list. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The string data to delete from the resource ifaces</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The string data to delete from the resource ifaces.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(new List<string>(){ ResourceInterfaces.BatchInterface }); /// resourceInterfaces.Add(ResourceInterfaces.BatchInterface); @@ -237,10 +237,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Return enumerator for the list of interfaces + /// Returns enumerator for the list of interfaces. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>The enumerator</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>The enumerator.</returns> /// <code> /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(new List<string>() /// { ResourceInterfaces.LinkInterface, ResourceInterfaces.ReadonlyInterface }); @@ -255,10 +255,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Return enumerator for the list of interfaces + /// Returns enumerator for the list of interfaces. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>The enumerator</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>The enumerator.</returns> /// <code> /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(new List<string>() /// { ResourceInterfaces.LinkInterface, ResourceInterfaces.ReadonlyInterface }); @@ -275,7 +275,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -292,7 +292,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs index 37ee5e4..d54001e 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs @@ -27,7 +27,7 @@ namespace Tizen.Network.IoTConnectivity /// The iotcon options API provides methods for managing vendor specific options of coap packet.\n /// See more about coap packet in http://tools.ietf.org/html/rfc7252. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class ResourceOptions : IDictionary<ushort, string>, IDisposable { internal const int MaxSize = 2; @@ -40,14 +40,14 @@ namespace Tizen.Network.IoTConnectivity private bool _disposed = false; /// <summary> - /// The resource options constructor + /// The resource options constructor. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> /// <seealso cref="Remove()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// ResourceOptions options = new ResourceOptions(); /// </code> @@ -94,9 +94,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Contains all the Option keys + /// Contains all the Option keys. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>All the Option keys.</value> /// <code> /// ResourceOptions options = new ResourceOptions(); @@ -114,9 +114,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Contains all the Option values + /// Contains all the Option values. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>All the Option values.</value> /// <code> /// ResourceOptions options = new ResourceOptions(); @@ -134,9 +134,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets the number of options + /// Gets the number of options. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The number of options.</value> /// <code> /// ResourceOptions options = new ResourceOptions(); @@ -154,9 +154,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Represents whether the collection is readonly + /// Represents whether the collection is readonly. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Whether the collection is readonly.</value> /// <code> /// ResourceOptions options = new ResourceOptions(); @@ -172,12 +172,12 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets or sets the option data + /// Gets or sets the option data. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The option data.</value> - /// <param name="key">The option id to get or set.</param> - /// <returns>The option with the specified id.</returns> + /// <param name="key">The option ID to get or set.</param> + /// <returns>The option with the specified ID.</returns> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options[2055] = "sample-data"; @@ -196,11 +196,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Checks whether the given key exists in Options collection + /// Checks whether the given key exists in Options collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The key to look for</param> - /// <returns>true if exists. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The key to look for.</param> + /// <returns>true if exists. Otherwise, false.</returns> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(2050, "sample-data"); @@ -213,20 +213,20 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Adds a new id and a correspoding data into the options. + /// Adds a new ID and a correspoding data into the options. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// ResourceOptions can have up to 2 options. \n /// key is always situated between 2048 and 3000. \n /// Length of option data is less than or equal to 15. /// </remarks> - /// <param name="key">The id of the option to insert</param> - /// <param name="value">The string data to insert into the options</param> + /// <param name="key">The ID of the option to insert.</param> + /// <param name="value">The string data to insert into the options.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Remove()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(2050, "sample-data"); @@ -252,15 +252,15 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Removes the id and its associated data from the options. + /// Removes the ID and its associated data from the options. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The id of the option to delete</param> - /// <returns>True if operation is successful. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The ID of the option to delete.</param> + /// <returns>True if operation is successful. Otherwise, false.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(2050, "12345"); @@ -283,10 +283,10 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Gets the value associated with the specified key. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The option id</param> - /// <param name="value">Value corresponding to option id</param> - /// <returns>True if the key exists, false otherwise</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The option ID.</param> + /// <param name="value">Value corresponding to option ID.</param> + /// <returns>True if the key exists, false otherwise.</returns> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(2050, "12345"); @@ -301,10 +301,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Adds options key and value as a key value pair + /// Adds options key and value as a key value pair. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The key value pair</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The key value pair.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Remove()"/> /// <code> @@ -317,11 +317,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Clears the Options collection + /// Clears the Options collection. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(2050, "12345"); @@ -343,11 +343,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Checks if the given option pair exists + /// Checks if the given option pair exists. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The key value pair</param> - /// <returns>True if exists. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The key value pair.</param> + /// <returns>True if exists. Otherwise, false.</returns> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(new KeyValuePair<ushort, string>(2050, "12345")); @@ -361,11 +361,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Copies the elements of the options collection to an Array, starting at a particular index. + /// Copies the elements of the options collection to an array, starting at a particular index. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="array">The destination array</param> - /// <param name="arrayIndex">Index parameter</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="array">The destination array.</param> + /// <param name="arrayIndex">Index parameter.</param> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(new KeyValuePair<ushort, string>(2050, "12345")); @@ -379,7 +379,7 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Remove the given key value pair from the options + /// Removes the given key value pair from the options. /// </summary> /// <since_tizen>3</since_tizen> /// <param name="item">The key value pair to remove</param> @@ -398,10 +398,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Get the enumerator to options collection + /// Get the enumerator to options collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>Enumerator to option pairs</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>Enumerator to option pairs.</returns> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(new KeyValuePair<ushort, string>(2050, "sample1")); @@ -419,7 +419,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -428,10 +428,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Get the enumerator to options collection + /// Gets the enumerator to options collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>Enumerator to option pairs</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>Enumerator to option pairs.</returns> /// <code> /// ResourceOptions options = new ResourceOptions(); /// options.Add(new KeyValuePair<ushort, string>(2050, "sample1")); @@ -449,7 +449,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourcePolicy.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourcePolicy.cs index ca1082a..0edfb3b 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourcePolicy.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourcePolicy.cs @@ -20,45 +20,45 @@ using System; namespace Tizen.Network.IoTConnectivity { /// <summary> - /// Enumeration for policy which can be held in a resource. + /// Enumeration for the policy, which can be held in a resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public enum ResourcePolicy { /// <summary> - /// Indicates resource uninitialized + /// Indicates resource uninitialized. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> NoProperty = 0, /// <summary> - /// Indicates resource that is allowed to be discovered + /// Indicates resource that is allowed to be discovered. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Discoverable = (1 << 0), /// <summary> - /// Indicates resource that is allowed to be observed + /// Indicates resource that is allowed to be observed. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Observable = (1 << 1), /// <summary> - /// Indicates resource initialized and activated + /// Indicates resource initialized and activated. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Active = (1 << 2), /// <summary> - /// Indicates resource which takes some delay to respond + /// Indicates resource, which takes some delay to respond. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Slow = (1 << 3), /// <summary> - /// Indicates secure resource + /// Indicates secure resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Secure = (1 << 4), /// <summary> /// When this bit is set, the resource is allowed to be discovered only if discovery request contains an explicit querystring. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> ExplicitDiscoverable = (1 << 5), } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceQuery.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceQuery.cs index 27a8135..4583dc5 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceQuery.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceQuery.cs @@ -23,9 +23,9 @@ using System.Runtime.InteropServices; namespace Tizen.Network.IoTConnectivity { /// <summary> - /// This class provides APIs to manage query of request. + /// This class provides APIs to manage the query of request. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class ResourceQuery : IDictionary<string, string>, IDisposable { internal const int QueryMaxLenth = 64; @@ -34,14 +34,14 @@ namespace Tizen.Network.IoTConnectivity private bool _disposed = false; /// <summary> - /// The resource query constructor + /// The resource query constructor. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> /// <seealso cref="Remove()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// ResourceQuery query = new ResourceQuery(); /// </code> @@ -87,13 +87,13 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets and sets the resource type of the query + /// Gets and sets the resource type of the query. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The resource type of the query.</value> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Type = "org.tizen.light"; @@ -127,16 +127,16 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets and sets the resource interface of the query + /// Gets and sets the resource interface of the query. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value> /// The resource interface of the query. - /// Setter value could be a value such as <see cref="ResourceInterfaces.DefaultInterface"/> + /// Setter value could be a value, such as <see cref="ResourceInterfaces.DefaultInterface"/>. /// </value> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Interface = ResourceInterfaces.LinkInterface; @@ -169,9 +169,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Contains all the query keys + /// Contains all the query keys. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>All the query keys.</value> /// <code> /// ResourceQuery query = new ResourceQuery(); @@ -189,9 +189,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Contains all the query values + /// Contains all the query values. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>All the query values.</value> /// <code> /// ResourceQuery query = new ResourceQuery(); @@ -209,9 +209,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets the number of query elements + /// Gets the number of query elements. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The number of query elements.</value> /// <code> /// ResourceQuery query = new ResourceQuery(); @@ -229,9 +229,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Represents whether the collection is readonly + /// Represents whether the collection is readonly. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Whether the collection is readonly.</value> /// <code> /// ResourceQuery query = new ResourceQuery(); @@ -247,9 +247,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets or sets the query data + /// Gets or sets the query data. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The query data.</value> /// <param name="key">The query key to get or set.</param> /// <returns>The query with the specified key.</returns> @@ -272,11 +272,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Checks whether the given key exists in Query collection + /// Checks whether the given key exists in the query collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The key to look for</param> - /// <returns>true if exists. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The key to look for.</param> + /// <returns>true if exists. Otherwise, false.</returns> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add("key1", "value1"); @@ -291,17 +291,17 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Adds a new key and correspoding value into the query. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// The full length of query should be less than or equal to 64. /// </remarks> - /// <param name="key">The key of the query to insert</param> - /// <param name="value">The string data to insert into the query</param> + /// <param name="key">The key of the query to insert.</param> + /// <param name="value">The string data to insert into the query.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Remove()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add("key1", "value1"); @@ -328,14 +328,14 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Removes the key and its associated value from the query. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The id of the query to delete</param> - /// <returns>True if operation is successful. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The ID of the query to delete.</param> + /// <returns>True if operation is successful. Otherwise, false.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add("key1", "value1"); @@ -358,10 +358,10 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Gets the value associated with the specified key. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="key">The query key</param> - /// <param name="value">Value corresponding to query key</param> - /// <returns>True if the key exists, false otherwise</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="key">The query key.</param> + /// <param name="value">Value corresponding to query key.</param> + /// <returns>True if the key exists, false otherwise.</returns> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add("key1", "value1"); @@ -376,10 +376,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Adds query key and value as a key value pair + /// Adds a query key and a value as a key value pair. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The key value pair</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The key value pair.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Remove()"/> /// <code> @@ -392,12 +392,12 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Clears the Query collection + /// Clears the query collection. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add("key1", "value1"); @@ -419,11 +419,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Checks if the given query pair exists + /// Checks if the given query pair exists. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The key value pair</param> - /// <returns>True if exists. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The key value pair.</param> + /// <returns>True if exists. Otherwise, false.</returns> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add(new KeyValuePair<string, string>("key1", "value1")); @@ -437,11 +437,11 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Copies the elements of the query collection to an Array, starting at a particular index. + /// Copies the elements of the query collection to an array, starting at a particular index. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="array">The destination array</param> - /// <param name="arrayIndex">Index parameter</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="array">The destination array.</param> + /// <param name="arrayIndex">Index parameter.</param> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add(new KeyValuePair<string, string>("key1", "value1")); @@ -455,14 +455,14 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Remove the given key value pair from the query + /// Removes the given key value pair from the query. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The key value pair to remove</param> - /// <returns>True if operation is successful. Otherwise, false</returns> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The key value pair to remove.</param> + /// <returns>True if operation is successful. Otherwise, false.</returns> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add(new KeyValuePair<string, string>("key1", "value1")); @@ -474,10 +474,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Get the enumerator to query collection + /// Gets the enumerator to the query collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>Enumerator to query pairs</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>Enumerator to query pairs.</returns> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add(new KeyValuePair<string, string>("key1", "value1")); @@ -493,10 +493,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Get the enumerator to query collection + /// Gets the enumerator to the query collection. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>Enumerator to query pairs</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>The enumerator to the query pairs.</returns> /// <code> /// ResourceQuery query = new ResourceQuery(); /// query.Add(new KeyValuePair<string, string>("key1", "value1")); @@ -514,7 +514,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -525,7 +525,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceState.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceState.cs index 32eb72d..e093b0a 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceState.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceState.cs @@ -18,20 +18,20 @@ namespace Tizen.Network.IoTConnectivity { /// <summary> - /// Enumeration for states of remote resource. + /// Enumeration for states of the remote resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public enum ResourceState { /// <summary> - /// Indicates remote resource is alive + /// Indicates remote resource is alive. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Alive = 0, /// <summary> - /// Indicates remote resource is lost + /// Indicates remote resource is lost. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> LostSignal } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs index 21bd1b3..b2c82a7 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs @@ -23,10 +23,10 @@ using System.Text.RegularExpressions; namespace Tizen.Network.IoTConnectivity { /// <summary> - /// This class contains resource types and provides APIs to manage, add, remove those types. - /// A resource type indicates a class or category of resources. + /// This class contains resource types and provides APIs to manage, add, or remove those types. + /// A resource type indicates a class or a category of resources. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class ResourceTypes : IEnumerable<string>, IDisposable { internal const int MaxLength = 61; @@ -35,14 +35,14 @@ namespace Tizen.Network.IoTConnectivity private bool _disposed = false; /// <summary> - /// Constructor of ResourceTypes + /// Constructor of ResourceTypes. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> /// <seealso cref="Remove()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory.</exception> /// <code> /// ResourceTypes types = new ResourceTypes(); /// </code> @@ -57,12 +57,12 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Constructor of ResourceTypes using list of types + /// Constructor of ResourceTypes using list of types. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="types">List of resource types</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="types">List of resource types.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> /// <code> /// ResourceTypes types = new ResourceTypes(new List<string>() { "org.tizen.light", "oic.if.room" }); /// </code> @@ -113,9 +113,9 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Indicates count of types in the list + /// Indicates count of types in the list. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>Count of types in the list.</value> /// <code> /// ResourceTypes types = new ResourceTypes(new List<string>() { "org.tizen.light", "oic.if.room" }); @@ -132,19 +132,19 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Adds a resource type into the list. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <remarks> /// The length of @a item should be less than or equal to 61.\n /// The @a item must start with a lowercase alphabetic character, followed by a sequence /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.\n /// Duplicate strings are not allowed. /// </remarks> - /// <param name="item">The string data to insert into the resource types</param> + /// <param name="item">The string data to insert into the resource types.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Remove()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceTypes resourceTypes = new ResourceTypes(); /// resourceTypes.Add("org.tizen.light"); @@ -169,15 +169,15 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Removes a resource type from the list + /// Removes a resource type from the list. /// </summary> - /// <since_tizen>3</since_tizen> - /// <param name="item">The string data to delete from the resource types</param> + /// <since_tizen> 3 </since_tizen> + /// <param name="item">The string data to delete from the resource types.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> /// <seealso cref="Add()"/> - /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported</exception> - /// <exception cref="ArgumentException">Thrown when there is an invalid parameter</exception> - /// <exception cref="InvalidOperationException">Thrown when the operation is invalid</exception> + /// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception> + /// <exception cref="ArgumentException">Thrown when there is an invalid parameter.</exception> + /// <exception cref="InvalidOperationException">Thrown when the operation is invalid.</exception> /// <code> /// ResourceTypes resourceTypes = new ResourceTypes(new List<string>() { "org.tizen.light", "oic.if.room" }); /// resourceTypes.Remove("oic.if.room"); @@ -195,10 +195,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Return enumerator for the list of types + /// Returns an enumerator for the list of types. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>The enumerator</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>The enumerator.</returns> /// <code> /// ResourceTypes resourceTypes = new ResourceTypes(new List<string>() { "org.tizen.light", "oic.if.room" }); /// foreach(string item in resourceTypes) @@ -212,10 +212,10 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Return enumerator for the list of types + /// Returns an enumerator for the list of types. /// </summary> - /// <since_tizen>3</since_tizen> - /// <returns>The enumerator</returns> + /// <since_tizen> 3 </since_tizen> + /// <returns>The enumerator.</returns> /// <code> /// ResourceTypes resourceTypes = new ResourceTypes(new List<string>() { "org.tizen.light", "oic.if.room" }); /// foreach(string item in resourceTypes) @@ -231,7 +231,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <feature>http://tizen.org/feature/iot.ocf</feature> public void Dispose() { @@ -248,7 +248,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> /// <feature>http://tizen.org/feature/iot.ocf</feature> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Response.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Response.cs index 60e9e9d..ce8306e 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Response.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Response.cs @@ -23,15 +23,15 @@ namespace Tizen.Network.IoTConnectivity /// This class represents response from a resource. /// It provides APIs to manage response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class Response : IDisposable { private bool _disposed = false; /// <summary> - /// Constructor of Response + /// Constructor of Response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <code> /// Response response = new Response(); /// </code> @@ -46,30 +46,30 @@ namespace Tizen.Network.IoTConnectivity } /// <summary> - /// Gets or sets the result from/into the reponse + /// Gets or sets the result from/into the response. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The result from/into the reponse.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The result from/into the response.</value> public ResponseCode Result { get; set; } /// <summary> - /// Gets or sets the representation from/into the reponse + /// Gets or sets the representation from/into the response. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The representation from/into the reponse.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The representation from/into the response.</value> public Representation Representation { get; set; } /// <summary> - /// Gets or sets the options from/into the reponse + /// Gets or sets the options from/into the response. /// </summary> - /// <since_tizen>3</since_tizen> - /// <value>The options from/into the reponse.</value> + /// <since_tizen> 3 </since_tizen> + /// <value>The options from/into the response.</value> public ResourceOptions Options { get; set; } /// <summary> /// Releases any unmanaged resources used by this object. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public void Dispose() { Dispose(true); @@ -131,7 +131,7 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param> protected virtual void Dispose(bool disposing) { diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResponseCode.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResponseCode.cs index 4e6ddfa..0792b00 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResponseCode.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResponseCode.cs @@ -18,45 +18,45 @@ namespace Tizen.Network.IoTConnectivity { /// <summary> - /// Enumeration for result of response + /// Enumeration for the result of response. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public enum ResponseCode { /// <summary> - /// Indicates result of response for success + /// Indicates the result of response for success. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Ok = 0, /// <summary> - /// Indicates result of response for some error + /// Indicates the result of response for some error. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Error, /// <summary> - /// Indicates result of response for created resource + /// Indicates the result of response for created resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Created, /// <summary> - /// Indicates result of response for deleted resource + /// Indicates the result of response for deleted resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Deleted, /// <summary> - /// Indicates result of response for changed resource + /// Indicates the result of response for changed resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Changed, /// <summary> - /// Indicates result of response for slow resource + /// Indicates the result of response for slow resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Slow, /// <summary> - /// Indicates result of response for accessing unauthorized resource + /// Indicates the result of response for accessing unauthorized resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> Forbidden } } diff --git a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/StateChangedEventArgs.cs b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/StateChangedEventArgs.cs index eefc47e..0078a93 100755 --- a/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/StateChangedEventArgs.cs +++ b/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/StateChangedEventArgs.cs @@ -22,15 +22,15 @@ namespace Tizen.Network.IoTConnectivity /// <summary> /// This class represents event arguments of the StateChanged event. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> public class StateChangedEventArgs : EventArgs { internal StateChangedEventArgs() { } /// <summary> - /// Indicates the new state of the resource + /// Indicates the new state of the resource. /// </summary> - /// <since_tizen>3</since_tizen> + /// <since_tizen> 3 </since_tizen> /// <value>The new state of the resource.</value> public ResourceState State { get; internal set; } } |