Use `URI` all caps in documentation
[iotivity.git] / service / resource-encapsulation / include / RCSDiscoveryManager.h
index 3aaf3d0..5aaba8d 100644 (file)
@@ -57,7 +57,7 @@ namespace OIC
             public:
                 typedef std::unique_ptr< DiscoveryTask > Ptr;
 
-                ~DiscoveryTask() = default;
+                ~DiscoveryTask();
 
                 DiscoveryTask(const DiscoveryTask&) = delete;
                 DiscoveryTask(DiscoveryTask&&) = delete;
@@ -65,7 +65,7 @@ namespace OIC
                 DiscoveryTask& operator =(DiscoveryTask&&) const = delete;
 
                 /**
-                 * It is cancelling the task of discovery.
+                 * It cancels the task of discovery.
                  * If it is already canceled, the operation is ignored.
                  */
                 void cancel();
@@ -101,8 +101,8 @@ namespace OIC
             static RCSDiscoveryManager* getInstance();
 
             /**
-             * Discovers resources of interest, regardless of uri and resource type.
-             * It is Consistently discovering resources until the discovery task is canceled.
+             * Discovers resources of interest, regardless of URI and resource type.
+             * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address         A RCSAddress object
              * @param cb              A callback to obtain discovered resource
@@ -117,10 +117,10 @@ namespace OIC
 
             /**
              * Discovers resources of interest, regardless of resource type.
-             * It is Consistently discovering resources until the discovery task is canceled.
+             * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address          A RCSAddress object
-             * @param relativeUri      The relative uri of resource to be searched
+             * @param relativeUri      The relative URI of resource to be searched
              * @param cb               A callback to obtain discovered resource
              *
              * @throws InvalidParameterException If cb is empty.
@@ -133,7 +133,7 @@ namespace OIC
 
             /**
              * Discovers resources of interest by resource type.
-             * It is Consistently discovering resources until the discovery task is canceled.
+             * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address          A RCSAddress object
              * @param resourceType     Resource Type
@@ -148,16 +148,16 @@ namespace OIC
                     const std::string& resourceType, ResourceDiscoveredCallback cb);
 
             /**
-             * Discovers resources of interest by resource type.
-             * It is Consistently discovering resources until the discovery task is canceled.
+             * Discovers resources of interest by resource types.
+             * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address          A RCSAddress object
              * @param resourceTypes    List of Resource Types
              * @param cb               A callback to obtain discovered resource
              *
              * @throws InvalidParameterException If cb is empty.
-             * @throws InvalidParameterException If resourceType's size is than 2,
-             * at least one of resource type is empty.
+             * @throws RCSBadRequestException If resourceTypes contain more than one element and
+             * any of them is empty.
              *
              * @note The callback will be invoked in an internal thread.
              * @note If resourceTypes is empty, discovers resource by all resource types.
@@ -168,11 +168,11 @@ namespace OIC
                     ResourceDiscoveredCallback cb);
 
             /**
-             * Discovers resources of interest by resource types with provided relativeUri.
-             * It is Consistently discovering resources until the discovery task is canceled.
+             * Discovers resources of interest by a resource type with provided relativeUri.
+             * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address          A RCSAddress object
-             * @param relativeUri      The relative uri of resource to be searched
+             * @param relativeUri      The relative URI of resource to be searched
              * @param resourceType     Resource Type
              * @param cb               A callback to obtain discovered resource
              *
@@ -187,16 +187,16 @@ namespace OIC
 
             /**
              * Discovers resources of interest by resource types with provided relativeUri.
-             * It is Consistently discovering resources until the discovery task is canceled.
+             * It will consistently discover resources until the discovery task is canceled.
              *
              * @param address          A RCSAddress object
-             * @param relativeUri      The relative uri of resource to be searched
+             * @param relativeUri      The relative URI of resource to be searched
              * @param resourceTypes     List of Resource Types
              * @param cb               A callback to obtain discovered resource
              *
              * @throws InvalidParameterException If cb is empty.
-             * @throws InvalidParameterException If resourceType's size is than 2,
-             * at least one of resource type is empty.
+             * @throws RCSBadRequestException If resourceTypes contain more than one element and
+             * any of them is empty.
              *
              * @note The callback will be invoked in an internal thread.
              * @note If resourceTypes is empty, discovers resource by all resource types.