Add API description of Things Manager.

joinGroup and findGroup function call were ambiguous
when join to a local(or remote) resource.
We provide more detail description of function for the user.

Fix [IOT-265],[IOT-267]

Change-Id: I43de1f6671dc73d0725bdc9c0e85ffca45878d2e
Signed-off-by: HyunJun Kim <hyunjun2.kim@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/245
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Uze Choi <uzchoi@samsung.com>
(cherry picked from commit a3c86a7a2d2fce37f68fd3cf738500e17480cbbe)
Reviewed-on: https://gerrit.iotivity.org/gerrit/378
Reviewed-by: Sudarshan Prasad <sudarshan.prasad@intel.com>

diff --git a/service/things-manager/sdk/inc/ThingsManager.h b/service/things-manager/sdk/inc/ThingsManager.h
index 8dd0a6f..2ab30f0 100644 (file)
--- a/service/things-manager/sdk/inc/ThingsManager.h
+++ b/service/things-manager/sdk/inc/ThingsManager.h
@@ -117,7 +117,9 @@ namespace OIC
          * @return OCStackResult - return value of this API.
          *                         It returns OC_STACK_OK if success.
          *
-         * NOTE: OCStackResult is defined in ocstack.h.
+         * NOTE: It return OC_STACK ERROR when It was finding a group.
+         *       You should call this api when the group finding process has stopped.
+         *       OCStackResult is defined in ocstack.h.
          */
         OCStackResult findGroup(std::vector< std::string > collectionResourceTypes,
                 FindCallback callback);
@@ -144,7 +146,10 @@ namespace OIC
          * @return OCStackResult - return value of this API.
          *                         It returns OC_STACK_OK if success.
          *
-         * NOTE: OCStackResult is defined in ocstack.h.
+         * NOTE: If you want to join the resource in the remote(other) process,
+         *       use joinGroup(const std::shared_ptr< OCResource >, OCResourceHandle)
+         *       instead of this.
+         *       OCStackResult is defined in ocstack.h.
          */
         OCStackResult joinGroup(std::string collectionResourceType,
                 OCResourceHandle resourceHandle);
@@ -160,7 +165,10 @@ namespace OIC
          * @return OCStackResult - return value of this API.
          *                         It returns OC_STACK_OK if success.
          *
-         * NOTE: OCStackResult is defined in ocstack.h.
+         * NOTE: NOTE: If you want to join the resource in the same process,
+         *       use joinGroup(std::string, OCResourceHandle)
+         *       instead of this.
+         *       OCStackResult is defined in ocstack.h.
          */
         OCStackResult joinGroup(const std::shared_ptr< OCResource > resource,
                 OCResourceHandle resourceHandle);