Add brief descriptions to several classes in things manager feature

GroupManager, ThingsConfiguration, and ThingsMaintenance has been added with
brief descriptions.

Change-Id: Ic2f884affa1754ff2b897eda171715624641b58b
Signed-off-by: Jihun Ha <jihun.ha@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/2969
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Madan Lanka <lanka.madan@samsung.com>
(cherry picked from commit 82a52fd3586e09fd5828c23b54a2e0bfdbe77a61)
Reviewed-on: https://gerrit.iotivity.org/gerrit/2977

diff --git a/service/things-manager/sdk/inc/GroupManager.h b/service/things-manager/sdk/inc/GroupManager.h
old mode 100644 (file)
new mode 100755 (executable)
index b6c33c7..35b2075
--- a/service/things-manager/sdk/inc/GroupManager.h
+++ b/service/things-manager/sdk/inc/GroupManager.h
@@ -47,6 +47,13 @@ typedef std::function< void(const HeaderOptions&, const OCRepresentation&, const
 typedef std::function< void(const HeaderOptions&, const OCRepresentation&, const int) > PostCallback;
 typedef std::function< void(const HeaderOptions&, const OCRepresentation&, const int) > PutCallback;
 
+/**
+ * @class GroupManager
+ * @brief
+ * This APIs provide functions for application to find appropriate devices (i.e. things) in network,
+ * create a group of the devices, check a presence of member devices in the group, and actuate a
+ * group action in a more convenient way.
+ */
 class GroupManager
 {
 public:
@@ -109,7 +116,7 @@ public:
      * @param newActionSet pointer of ActionSet class instance
      *
      * @return std::string return value of this API.
-     *                                      It returns an action set String.
+     *                     It returns an action set String.
      * @note OCStackResult is defined in ocstack.h.
      */
     std::string getStringFromActionSet(const ActionSet *newActionSet);

diff --git a/service/things-manager/sdk/inc/ThingsConfiguration.h b/service/things-manager/sdk/inc/ThingsConfiguration.h
old mode 100644 (file)
new mode 100755 (executable)
index 517fdc9..ef3cbe3
--- a/service/things-manager/sdk/inc/ThingsConfiguration.h
+++ b/service/things-manager/sdk/inc/ThingsConfiguration.h
@@ -101,6 +101,14 @@ namespace OIC
     typedef std::string ConfigurationName;
     typedef std::string ConfigurationValue;
 
+    /**
+     * @class ThingsConfiguration
+     * @brief
+     * There are two main usages of this class: (1) On a server side, bootstrapping requisite
+     * information (i.e. system configuration parameters) from a bootstrap server to access other
+     * IoT services, (2) On a client side, getting/updating the system configuration parameters
+     * from/to multiple remote things.
+     */
     class ThingsConfiguration
     {
     public:

diff --git a/service/things-manager/sdk/inc/ThingsMaintenance.h b/service/things-manager/sdk/inc/ThingsMaintenance.h
old mode 100644 (file)
new mode 100755 (executable)
index 0763ec8..1ebda05
--- a/service/things-manager/sdk/inc/ThingsMaintenance.h
+++ b/service/things-manager/sdk/inc/ThingsMaintenance.h
@@ -99,6 +99,12 @@ namespace OIC
     typedef std::string MaintenanceName;
     typedef std::string MaintenanceValue;
 
+    /**
+     * @class ThingsMaintenance
+     * @brief
+     * There are two functionalities in Things Maintenance; (1) FactoryReset to restore all
+     * configuration parameters to default one, and (2) Reboot to request a system rebooting.
+     */
     class ThingsMaintenance
     {
     public: