Updated api description for response classes of RE.
authorcoderhyme <jhyo.kim@samsung.com>
Mon, 29 Feb 2016 02:12:12 +0000 (18:12 -0800)
committerJungHo Kim <jhyo.kim@samsung.com>
Wed, 2 Mar 2016 02:57:41 +0000 (02:57 +0000)
Change-Id: I3bf6047ebe7f9b84f83438ce8093ce31e173c443
Signed-off-by: coderhyme <jhyo.kim@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/5251
Reviewed-by: Uze Choi <uzchoi@samsung.com>
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
service/resource-encapsulation/include/RCSResponse.h
service/resource-encapsulation/src/serverBuilder/unittests/RCSResponseTest.cpp

index 041a187..d94b555 100644 (file)
@@ -127,8 +127,22 @@ namespace OIC
              */
             static RCSGetResponse create(RCSResourceAttributes&& attrs, int errorCode);
 
+            /**
+             * Creates a RCSGetResponse for the separate response.
+             * The separate response is to delay sending actual response to the client.
+             *
+             * @note A separate response needs to be set with RCSSeparateResponse
+             * to send the result of the request.
+             *
+             * @see RCSSeparateResponse
+             */
             static RCSGetResponse separate();
 
+            /**
+             * Returns whether it is a separate response.
+             *
+             * @see separate()
+             */
             bool isSeparate() const;
 
             //! @cond
@@ -294,8 +308,22 @@ namespace OIC
              */
             static RCSSetResponse create(RCSResourceAttributes&& attrs, int errorCode);
 
+            /**
+             * Creates a RCSSetResponse for a separate response.
+             * The separate response is to delay sending actual response to the client.
+             *
+             * @note A separate response needs to be set with RCSSeparateResponse
+             * to send the result of the request.
+             *
+             * @see RCSSeparateResponse
+             */
             static RCSSetResponse separate();
 
+            /**
+             * Returns whether it is a separate response.
+             *
+             * @see separate()
+             */
             bool isSeparate() const;
 
             //! @cond
index 4f55d4a..0e7acd3 100644 (file)
 
 #include "UnitTestHelper.h"
 
-#include "RCSRequest.h"
 #include "RCSResponse.h"
 #include "RCSSeparateResponse.h"
-#include "RCSResourceObject.h"
-
-#include "RequestHandler.h"
-#include "ResourceAttributesConverter.h"
-
-#include "OCPlatform.h"
-
-using namespace std;
+#include "RCSException.h"
 
 using namespace OIC::Service;
-using namespace OC;
 
 TEST(RCSResponseTest, DefaultSetResponseHasDefaultMethod)
 {