From: chleun.moon Date: Mon, 19 Dec 2016 05:58:26 +0000 (+0900) Subject: Modify the header and documentation X-Git-Tag: accepted/tizen/common/20161222.131132~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F09%2F105609%2F2;p=platform%2Fcore%2Fapi%2Fnsd.git Modify the header and documentation Signed-off-by: cheoleun Change-Id: I5bd7524351d87fbc8c7c32ed789ee5c302ec63da --- diff --git a/doc/nsd_doc.h b/doc/nsd_doc.h index bd72d67..4351750 100644 --- a/doc/nsd_doc.h +++ b/doc/nsd_doc.h @@ -18,11 +18,11 @@ #ifndef __TIZEN_NETWORK_SERVICE_DISCOVERY_DOC_H__ #define __TIZEN_NETWORK_SERVICE_DISCOVERY_DOC_H__ + /** + * @ingroup CAPI_NETWORK_FRAMEWORK * @defgroup CAPI_NETWORK_SSDP_MODULE SSDP * @brief The SSDP API provides functions for network service discovery using SSDP. - * @ingroup CAPI_NETWORK_FRAMEWORK - * * @section CAPI_NETWORK_SSDP_MODULE_HEADER Required Header * \#include * @@ -31,25 +31,21 @@ * You should deregister and destroy the created local service handle if it is not available. * In addition, you can browse services on a network using SSDP API. * You should stop browsing if you do not need it anymore. + * * @section CAPI_NETWORK_SSDP_MODULE_FEATURE Related Features * This API is related with the following features:\n * - http://tizen.org/feature/network.service_discovery.ssdp - * * It is recommended to design feature related codes in your application for reliability.\n - * * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n - * * More details on featuring your application can be found from Feature List. - * */ + /** + * @ingroup CAPI_NETWORK_FRAMEWORK * @defgroup CAPI_NETWORK_DNSSD_MODULE DNSSD * @brief The DNSSD API provides functions for network service discovery using DNSSD. - * @ingroup CAPI_NETWORK_FRAMEWORK - * * @section CAPI_NETWORK_DNSSD_MODULE_HEADER Required Header * \#include * @@ -58,16 +54,12 @@ * You should deregister and destroy the created local service handle if it is not available. * In addition, you can browse services on a network using DNSSD API. * You should stop browsing if you do not need it anymore. + * * @section CAPI_NETWORK_DNSSD_MODULE_FEATURE Related Features * This API is related with the following features:\n * - http://tizen.org/feature/network.service_discovery.dnssd - * * It is recommended to design feature related codes in your application for reliability.\n - * * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n - * * More details on featuring your application can be found from Feature List. - * */ diff --git a/include/dns-sd.h b/include/dns-sd.h index 39382cc..2233cb2 100644 --- a/include/dns-sd.h +++ b/include/dns-sd.h @@ -38,43 +38,47 @@ extern "C" { * @since_tizen 3.0 */ typedef enum { - DNSSD_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ - DNSSD_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory*/ - DNSSD_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */ - DNSSD_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid function parameter*/ - DNSSD_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ - DNSSD_ERROR_NOT_INITIALIZED = TIZEN_ERROR_DNSSD | 0x01, /**< Not Initialized */ - DNSSD_ERROR_ALREADY_REGISTERED = TIZEN_ERROR_DNSSD | 0x02, /**< Already registered */ - DNSSD_ERROR_NAME_CONFLICT = TIZEN_ERROR_DNSSD | 0x03, /**< Name conflict */ + DNSSD_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + DNSSD_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory*/ + DNSSD_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */ + DNSSD_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid function parameter*/ + DNSSD_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ + DNSSD_ERROR_NOT_INITIALIZED = TIZEN_ERROR_DNSSD | 0x01, /**< Not Initialized */ + DNSSD_ERROR_ALREADY_REGISTERED = TIZEN_ERROR_DNSSD | 0x02, /**< Already registered */ + DNSSD_ERROR_NAME_CONFLICT = TIZEN_ERROR_DNSSD | 0x03, /**< Name conflict */ DNSSD_ERROR_SERVICE_NOT_RUNNING = TIZEN_ERROR_DNSSD | 0x04, /**< Background daemon not running */ - DNSSD_ERROR_SERVICE_NOT_FOUND = TIZEN_ERROR_DNSSD | 0x05, /**< Service not found */ - DNSSD_ERROR_OPERATION_FAILED = TIZEN_ERROR_DNSSD | 0x06, /**< Operation failed */ + DNSSD_ERROR_SERVICE_NOT_FOUND = TIZEN_ERROR_DNSSD | 0x05, /**< Service not found */ + DNSSD_ERROR_OPERATION_FAILED = TIZEN_ERROR_DNSSD | 0x06, /**< Operation failed */ } dnssd_error_e; + /** * @brief Enumeration for Network Service Discovery DNSSD browse state. * @since_tizen 3.0 */ typedef enum { - DNSSD_SERVICE_STATE_AVAILABLE, /**