Updated doxygen comment due to ESResult is changed
authorParkhi <h_w.park@samsung.com>
Tue, 20 Sep 2016 06:37:48 +0000 (15:37 +0900)
committerMadan Lanka <lanka.madan@samsung.com>
Wed, 21 Sep 2016 04:51:16 +0000 (04:51 +0000)
Change-Id: I1dbbb6fe36d05797a27cd80c4e21331390a7179b
Signed-off-by: Parkhi <h_w.park@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/11967
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Jihun Ha <jihun.ha@samsung.com>
Reviewed-by: Madan Lanka <lanka.madan@samsung.com>
service/easy-setup/mediator/richsdk/inc/ESRichCommon.h

index 0269456..0eb7f36 100755 (executable)
@@ -461,6 +461,15 @@ namespace OIC
                 return m_devUUID;
             }
 
+            /**
+             * Get a result for about security provisioning is success or not.
+             *
+             * @return ::ES_OK\n
+             *         ::ES_SEC_OPERATION_IS_NOT_SUPPORTED\n
+             *         ::ES_SECURE_RESOURCE_DISCOVERY_FAILURE\n
+             *         ::ES_OWNERSHIP_TRANSFER_FAILURE\n
+             *         ::ES_ERROR\n
+             */
             ESResult getESResult()
             {
                 return m_result;
@@ -651,8 +660,9 @@ namespace OIC
             /**
              * Get a result of getting provisioning status and last error code of Enrollee
              *
-             * @return a result of getting provisioning status and last error code of Enrollee
-             *
+             * @return ::ES_OK\n
+             *         ::ES_COMMUNICATION_ERROR\n
+             *         ::ES_ERROR\n
              * @see ESResult
              */
             ESResult getESResult()
@@ -699,7 +709,9 @@ namespace OIC
             /**
              * Get a result of getting preconfiguration of Enrollee
              *
-             * @return a result of preconfiguration of Enrollee
+             * @return ::ES_OK\n
+             *         ::ES_COMMUNICATION_ERROR\n
+             *         ::ES_ERROR\n
              *
              * @see ESResult
              */
@@ -744,7 +756,9 @@ namespace OIC
             /**
              * Get a result of Device property provisioning
              *
-             * @return a result of Device property provisioning
+             * @return ::ES_OK\n
+             *         ::ES_COMMUNICATION_ERROR\n
+             *         ::ES_ERROR\n
              *
              * @see ESResult
              */
@@ -778,7 +792,13 @@ namespace OIC
             /**
              * Get a result of Cloud property provisioning
              *
-             * @return a result of Cloud property provisioning
+             * @return ::ES_OK\n
+             *         ::ES_ENROLLEE_DISCOVERY_FAILURE\n
+             *         ::ES_SECURE_RESOURCE_DISCOVERY_FAILURE\n
+             *         ::ES_ACL_PROVISIONING_FAILURE\n
+             *         ::ES_CERT_PROVISIONING_FAILURE\n
+             *         ::ES_COMMUNICATION_ERROR\n
+             *         ::ES_ERROR\n
              *
              * @see ESResult
              */