From: Piotr Szydelko
/// Initialize() should be called to initialize. @@ -163,16 +163,14 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// @a filePath point to a file for handling secure virtual resources. + /// - ///points to a file for handling secure virtual resources. /// The file that is CBOR(Concise Binary Object Representation)-format must already exist - /// in @a filePath. We recommend to use application-local file for @a filePath. + /// in . We recommend to use application-local file for . /// - /// http://tizen.org/privilege/network.get \n - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/network.get + ///http://tizen.org/privilege/internet ///public - /// The file path to point to storage for handling secure virtual resources. + /// The file path pointing to storage for handling secure virtual resources. ///http://tizen.org/feature/iot.ocf ////// You must call Deinitialize() if IoTCon API is no longer needed. @@ -261,16 +259,15 @@ namespace Tizen.Network.IoTConnectivity /// /// 3 ///- /// Sends request to receive presence to an interested server's resource with resourceType. + /// - ///Sends request to receive presence to an interested server's resource with resourceType. /// If succeeded, + ///event handler will be triggered when the server sends presence. - /// A server sends presence events when adds / removes / alters a resource or start / stop presence.\n - /// @a hostAddress could be for IPv4 multicast. - /// The length of @ 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. + /// A server sends presence events when adds / removes / alters a resource or start / stop presence. /// could be for IPv4 multicast. + /// The length of should be less than or equal to 61. + /// The must start with a lowercase alphabetic character, followed by a sequence + /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space. - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The address or addressable name of the server. /// A resource type that a client is interested in. @@ -278,7 +275,7 @@ namespace Tizen.Network.IoTConnectivity ///http://tizen.org/feature/iot.ocf ///Initialize() should be called to initialize.///- /// When the resource receive presence, ///event handler will be invoked.\n + /// When the resource receive presence, event handler will be invoked.
/// You must destroy presence by calling StopReceivingPresence() if presence event is no longer needed. ///@@ -371,9 +368,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Sends request to not to receive server's presence any more. /// - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The start presence request identifier. ///http://tizen.org/feature/iot.ocf @@ -443,15 +438,14 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// Sends request to find a resource of @a hostAddress server with @a resourceType. - /// If succeeded, - ///event handler will be triggered with information of the resource.\n - /// @a hostAddress could be 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. + /// Sends request to find a resource of + ///server with . + /// If succeeded, event handler will be triggered with information of the resource. /// could be for the IPv4 multicast. + /// The length of should be less than or equal to 61. The must start + /// with a lowercase alphabetic character, followed by a sequence + /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space. - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The address or addressable name of the server. The address includes a protocol like coaps://. /// The query specified as a filter for founding resources. @@ -557,13 +551,11 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// Requests server for device information. - /// If succeeded, - ///event handler will be triggered with information of the device.\n - /// @a hostAddress could be for the IPv4 multicast. + /// Requests server for device information. + /// If succeeded, + ///event handler will be triggered with information of the device. /// could be for the IPv4 multicast. - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The host address of the remote server. /// The query specified as a filter for founding resources. @@ -660,13 +652,11 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// Requests server for platform information. - /// If succeeded, - ///event handler will be triggered with information of the platform.\n - /// @a hostAddress could be for IPv4 multicast. + /// Requests server for platform information. + /// If succeeded, + ///event handler will be triggered with information of the platform. /// could be for IPv4 multicast. - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The host address of remote server. /// The query specified as a filter for founding resources. diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs index c93c532..6313cbc 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs @@ -33,16 +33,14 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// @a filePath point to a file for handling secure virtual resources. + /// - ///points to a file for handling secure virtual resources. /// The file that is CBOR(Concise Binary Object Representation)-format must already exist - /// in @a filePath. We recommend to use application-local file for @a filePath. + /// in . We recommend to use application-local file for . /// - /// http://tizen.org/privilege/network.get \n - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/network.get + ///http://tizen.org/privilege/internet ///public - /// The file path to point to storage for handling secure virtual resources. + /// The file path pointing to storage for handling secure virtual resources. ///http://tizen.org/feature/iot.ocf ////// You must call Deinitialize() if IoTCon API is no longer needed. @@ -93,9 +91,7 @@ namespace Tizen.Network.IoTConnectivity /// Registers a resource in IoTCon server. /// /// 3 - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The resource to register. ///http://tizen.org/feature/iot.ocf @@ -165,9 +161,7 @@ namespace Tizen.Network.IoTConnectivity /// Unregisters a resource in IoTCon server. /// ///3 - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The resource to unregister. ///http://tizen.org/feature/iot.ocf @@ -208,14 +202,12 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// 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 - /// If @a time is 0, server will set default value as 60 seconds.\n - /// If @a time is very big, server will set maximum value as (60 * 60 * 24) seconds, (24 hours). + /// - ///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. + ///If + ///is 0, server will set default value as 60 seconds. If ///is very big, server will set maximum value as (60 * 60 * 24) seconds, (24 hours). - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The interval of announcing presence in seconds. ///http://tizen.org/feature/iot.ocf @@ -254,9 +246,7 @@ namespace Tizen.Network.IoTConnectivity /// 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. /// - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public ///http://tizen.org/feature/iot.ocf ///@@ -287,8 +277,8 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// 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 /// The device name. ///. + /// This API sets the name of the local device (the device calling the API). + ///If the device name is set, clients can get the name using ///. http://tizen.org/feature/iot.ocf diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs index a69e2ae..34d0418 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs @@ -32,13 +32,11 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// Creates a lite resource, which can then be registered in server using - ///.\n - /// When client requests some operations, it sends a response to client automatically.\n - /// @a uri length must be less than 128. + /// Creates a lite resource, which can then be registered in server using + ///. When client requests some operations, it sends a response to client automatically. + ////// length must be less than 128. - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The uri path of the lite resource. /// The type of the resource. diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs index af90596..6a7d1b4 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs @@ -51,10 +51,10 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// 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. + /// /// The host address of the resource. /// The URI path of the resource. @@ -301,9 +301,7 @@ namespace Tizen.Network.IoTConnectivity ///To use this API, you should provide all the details required to correctly contact and + /// observe the object. + ///If not, you should discover the resource object manually. + ///The ///can contain multiple policies like ResourcePolicy.Discoverable | ResourcePolicy.Observable ./// When server sends notification message, - ///will be called. /// - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The type to specify how client wants to observe. /// The query to send to server. @@ -369,9 +367,7 @@ namespace Tizen.Network.IoTConnectivity /// Stops observing on the resource. /// ///3 - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public ///http://tizen.org/feature/iot.ocf ///Thrown when the iotcon is not supported. @@ -391,9 +387,7 @@ namespace Tizen.Network.IoTConnectivity /// Gets the attributes of a resource asynchronously. /// ///3 - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The ResourceQuery to send to server. ///Remote response with result and representation. @@ -447,9 +441,7 @@ namespace Tizen.Network.IoTConnectivity /// Puts the representation of a resource asynchronously. /// ///3 - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// Resource representation to put. /// The ResourceQuery to send to server. @@ -509,9 +501,7 @@ namespace Tizen.Network.IoTConnectivity /// Posts request on a resource asynchronously. /// ///3 - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// Resource representation of request. /// The ResourceQuery to send to server. @@ -564,9 +554,7 @@ namespace Tizen.Network.IoTConnectivity /// Deletes the resource asynchronously. /// ///3 - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public ///Remote response with result and representation. ///http://tizen.org/feature/iot.ocf diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs index e3a4535..3369eff 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs @@ -39,12 +39,10 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// @a uri format would be relative URI path like '/a/light' + /// - ///format would be relative URI path like '/a/light' /// and its length must be less than 128. /// - /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// The URI path of the resource. /// Resource types. @@ -162,9 +160,7 @@ namespace Tizen.Network.IoTConnectivity /// Notify the specified representation and qos. /// ///3 - ///- /// http://tizen.org/privilege/internet - /// + ///http://tizen.org/privilege/internet ///public /// Representation. /// The quality of service for message transfer. diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs index 8947003..2cbaef2 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs @@ -175,7 +175,7 @@ namespace Tizen.Network.IoTConnectivity /// ///3 ///- /// @a item could be a value, such as /// The string data to insert into the resource interfaces. ///. + /// could be a value, such as . /// http://tizen.org/feature/iot.ocf diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs index f3353c1..d5aad1d 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs @@ -23,9 +23,9 @@ using System.Linq; namespace Tizen.Network.IoTConnectivity { ///- /// This class represents resource options. It provides APIs to manage them.\n - /// 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. + /// ///This class represents resource options. It provides APIs to manage them. + ///The iotcon options API provides methods for managing vendor specific options of coap packet. + ///See more about coap packet in http://tools.ietf.org/html/rfc7252. ///3 public class ResourceOptions : IDictionary, IDisposable @@ -217,9 +217,9 @@ namespace Tizen.Network.IoTConnectivity /// /// 3 ///- /// 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. + /// /// The ID of the option to insert. /// The string data to insert into the options. diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs index 4205bde..f0f2c7f 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs @@ -134,10 +134,10 @@ namespace Tizen.Network.IoTConnectivity /// ///ResourceOptions can have up to 2 options. + ///key is always situated between 2048 and 3000. + ///Length of option data is less than or equal to 15. ///3 ///- /// 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. + /// /// The string data to insert into the resource types. ///The length of + ///should be less than or equal to 61. The + ///must start with a lowercase alphabetic character, followed by a sequence + /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space. Duplicate strings are not allowed. ///http://tizen.org/feature/iot.ocf