From b0d2b939f6015a131f04ae6032a64685b1ee9368 Mon Sep 17 00:00:00 2001 From: "hunje.yeon" Date: Sat, 4 Apr 2015 23:23:09 +0900 Subject: [PATCH] Notification Manager API Doxygen update remove the invalid return value from the documentation Change-Id: Iba341cc59475764d52b06d4cf2fc5ba787a9bba8 Signed-off-by: hunje.yeon Reviewed-on: https://gerrit.iotivity.org/gerrit/649 Reviewed-by: Uze Choi Tested-by: Uze Choi --- .../NotificationManager/include/hosting.h | 24 +++++-------------- 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/service/notification-manager/NotificationManager/include/hosting.h b/service/notification-manager/NotificationManager/include/hosting.h index a2916382e..e688508b8 100755 --- a/service/notification-manager/NotificationManager/include/hosting.h +++ b/service/notification-manager/NotificationManager/include/hosting.h @@ -35,30 +35,18 @@ #define HOSTING_TAG PCF("Hosting") /** + * Start resource coordinator. + * This function will create mirrorResourceList and start to discover coordinatee candidate. * - * Start resource coordinator - * - * @brief create mirrorResourceList and discover coordinatee candidate. - * - * @return - * OC_STACK_OK - no errors - * OC_STACK_INVALID_CALLBACK - invalid callback function pointer - * OC_STACK_INVALID_METHOD - invalid resource method - * OC_STACK_INVALID_URI - invalid required or reference URI - * OC_STACK_INVALID_QUERY - number of resource types specified for filtering presence - * notifications exceeds @ref MAX_PRESENCE_FILTERS. - * OC_STACK_ERROR - otherwise error(initialized value) + * @return ::OC_STACK_OK upon success, ::OC_STACK_ERROR is returned except the case that OC_STACK_SUCCESS is returned. */ OCStackResult OICStartCoordinate(); /** + * Stop resource coordinator. + * This function will stop the resource hosting and delete mirrorResourceList used. * - * stop resource coordinator - * - * @brief delete mirrorResourceList used while coordinating - * - * @return - * OC_STACK_ERROR - otherwise error(initialized value) + * @return ::OC_STACK_OK upon success, ::OC_STACK_ERROR is returned except the case that OC_STACK_SUCCESS is returned. */ OCStackResult OICStopCoordinate(); -- 2.34.1