From 19dedcbd0fd69f2b7f97174630386df5345b5aa8 Mon Sep 17 00:00:00 2001 From: "bg.chun" Date: Thu, 4 May 2017 14:54:41 +0900 Subject: [PATCH] [IOT-2155]Update doxygen comments for guide getAllHosts/setHost to get tcp port. Update doxygem commets for guide getAllHosts/setHost to get tcp port. Change-Id: Ib6f2f0047f6e330fe6f2225611e97651bb73aa1f Signed-off-by: bg.chun Reviewed-on: https://gerrit.iotivity.org/gerrit/19609 Tested-by: jenkins-iotivity Reviewed-by: Dan Mihai --- resource/include/OCPlatform.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/resource/include/OCPlatform.h b/resource/include/OCPlatform.h index 9891fe8..fbcc873 100644 --- a/resource/include/OCPlatform.h +++ b/resource/include/OCPlatform.h @@ -152,6 +152,9 @@ namespace OC * as BTH etc. * @note OCStackResult is defined in ocstack.h. * @see findResource(const std::string&, const std::string&, OCConnectivityType, FindCallback, QualityOfService) + * @note To get the tcpPort information, user must call getAllHosts() from the OCResource + object in FindCallback. To use a TCP endpoint that has been received by getAllHosts(), + user must use the setHost() function. */ OCStackResult findResource(const std::string& host, const std::string& resourceURI, OCConnectivityType connectivityType, FindCallback resourceHandler); @@ -177,6 +180,9 @@ namespace OC * from a particular service. * @param QoS QualityOfService the quality of communication * @see findResource(const std::string&, const std::string&, OCConnectivityType, FindCallback) + * @note To get the tcpPort information, user must call getAllHosts() from the OCResource + object in FindCallback. To use a TCP endpoint that has been received by getAllHosts(), + user must use the setHost() function. */ OCStackResult findResource(const std::string& host, const std::string& resourceURI, OCConnectivityType connectivityType, FindCallback resourceHandler, -- 2.7.4