Updated api description for RCSRequest.
authorcoderhyme <jhyo.kim@samsung.com>
Thu, 25 Feb 2016 04:11:53 +0000 (20:11 -0800)
committerUze Choi <uzchoi@samsung.com>
Fri, 26 Feb 2016 01:10:12 +0000 (01:10 +0000)
Change-Id: Ie2997c1aa3a33853f335630a98662c8783182486
Signed-off-by: coderhyme <jhyo.kim@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/5187
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Uze Choi <uzchoi@samsung.com>
service/resource-encapsulation/include/RCSRequest.h
service/resource-encapsulation/src/serverBuilder/src/RCSRequest.cpp

index eb5a350..9ecbc01 100644 (file)
@@ -59,18 +59,30 @@ namespace OIC
             RCSRequest(const std::shared_ptr< RCSResourceObject >&,
                     const std::shared_ptr< OC::OCResourceRequest >&);
 
+            /**
+             * @return the resource object which receives this request.
+             */
             std::weak_ptr< RCSResourceObject > getResourceObject() const noexcept;
 
             /**
-            * @return Returns the URI of the request.
+            * @return the URI of the request.
             *
             */
             std::string getResourceUri() const;
 
-            const std::shared_ptr< OC::OCResourceRequest >& getOCRequest() const noexcept;
+            /**
+             * @return the OCResourceRequest.
+             */
+            std::shared_ptr< OC::OCResourceRequest > getOCRequest() const noexcept;
 
+            /**
+             * @return the query parameters of the request.
+             */
             const std::map< std::string, std::string >& getQueryParams() const;
 
+            /**
+             * @return the interface of the request.
+             */
             std::string getInterface() const;
 
         private:
index 88513af..6efc456 100644 (file)
@@ -51,7 +51,7 @@ namespace OIC
             return m_ocRequest->getResourceUri();
         }
 
-        const std::shared_ptr< OC::OCResourceRequest >& RCSRequest::getOCRequest() const noexcept
+        std::shared_ptr< OC::OCResourceRequest > RCSRequest::getOCRequest() const noexcept
         {
             return m_ocRequest;
         }