From: saerome.kim Date: Thu, 29 Mar 2018 06:32:39 +0000 (+0900) Subject: d2d-manager: fix doxgen warnings and errors X-Git-Tag: submit/tizen/20190131.065036~74 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=7ac41765b6942cd7c6853fc6ab4b119f06144d67;p=platform%2Fcore%2Fapi%2Fmulti-device-group.git d2d-manager: fix doxgen warnings and errors Signed-off-by: saerome.kim --- diff --git a/capi/include/companion.h b/capi/include/companion.h index 9bc2f1a..c813996 100644 --- a/capi/include/companion.h +++ b/capi/include/companion.h @@ -102,8 +102,8 @@ typedef void *companion_device_h; /**< Device handle */ * * @since_tizen 5.0 * - * @remarks The @group should not be released. - * @remarks The @group can be used only in the callback. To use outside, make a copy. + * @remarks The @a group should not be released. + * @remarks The @a group can be used only in the callback. To use outside, make a copy. * * @param[out] type Companion group type * @param[out] group Group resource found @@ -122,8 +122,8 @@ typedef bool (*companion_group_found_cb)(companion_group_type_e type, * * @since_tizen 5.0 * - * @remarks The @device should not be released. - * @remarks The @device can be used only in the callback. To use outside, make a copy. + * @remarks The @a device should not be released. + * @remarks The @a device can be used only in the callback. To use outside, make a copy. * * @param[out] device Device found * @param[out] user_data User data pointer @@ -203,8 +203,8 @@ typedef void (*companion_device_eject_result_cb)(int result, void *user_data); * * @since_tizen 5.0 * - * @remarks The @resp_data should not be released. - * @remarks The @resp_data can be used only in the callback. To use outside, make a copy. + * @remarks The @a resp_data should not be released. + * @remarks The @a resp_data can be used only in the callback. To use outside, make a copy. * * @param[out] result Result of operation * @param[out] resp_data Retrieved data @@ -223,8 +223,8 @@ typedef void (*companion_send_data_finish_cb)(int result, char *resp_data, * * @since_tizen 5.0 * - * @remarks The @cmd, @arg should not be released. - * @remarks The @cmd, @arg can be used only in the callback. To use outside, make a copy. + * @remarks The @a cmd, @arg should not be released. + * @remarks The @a cmd, @arg can be used only in the callback. To use outside, make a copy. * * @param[out] cmd Command * @param[out] arg Argument @@ -244,7 +244,7 @@ typedef void (*companion_request_result_cb)(char *cmd, char *arg, int ret, * @brief Initializes companion-manager. * @since_tizen 5.0 * - * @remarks You must release @handle using companion_deinitialize(). + * @remarks You must release @a handle using companion_deinitialize(). * * @param[out] handle The companion manager handle * @@ -252,9 +252,7 @@ typedef void (*companion_request_result_cb)(char *cmd, char *arg, int ret, * @retval #COMP_ERROR_NONE Successful * @retval #COMP_ERROR_ALREADY_INITIALIZED Already initialized * @retval #COMP_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #COMP_ERROR_INVALID_OPERATION Invalid operation * @retval #COMP_ERROR_OPERATION_FAILED Operation failed - * @retval #COMP_ERROR_PERMISSION_DENIED Permission Denied * @retval #COMP_ERROR_OUT_OF_MEMORY Out of memory */ int companion_initialize(companion_h *handle); @@ -268,7 +266,6 @@ int companion_initialize(companion_h *handle); * @return 0 on success, otherwise negative error value * @retval #COMP_ERROR_NONE Successful * @retval #COMP_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #COMP_ERROR_INVALID_OPERATION Invalid operation * @retval #COMP_ERROR_OPERATION_FAILED Operation failed */ int companion_deinitialize(companion_h handle); @@ -449,7 +446,7 @@ int companion_group_merge(companion_h handle, companion_group_h dest_group, * * @since_tizen 5.0 * - * @remarks The @devices should be released using companion_device_destroy(). + * @remarks The @a devices should be released using companion_device_destroy(). * * @param[in] handle The companion manager handle * @param[in] group Group resource list @@ -574,6 +571,7 @@ int companion_device_get_found_mowned_devices(companion_h handle, * * @since_tizen 5.0 * + * @param[in] handle The companion manager handle * @param[in] group Group handle * @param[in] device Device handle * @param[in] PIN PIN number @@ -633,7 +631,6 @@ int companion_device_eject(companion_h handle, companion_group_h group, * @since_tizen 5.0 * * @param[in] handle The companion manager handle - * @param[in] handle The companion manager handle * @param[in] device Local device handle * * @return 0 on success, otherwise a negative error value. @@ -652,10 +649,11 @@ int companion_device_get_my_device(companion_h handle, * * @since_tizen 5.0 * - * @remarks The @uuid should not be released. + * @remarks The @a uuid should not be released. + * @remarks The @a uuid can be used only in the callback. To use outside, make a copy. * * @param[in] handle The companion manager handle - * @param[in] uuid Local device UUID + * @param[out] uuid Local device UUID * * @return 0 on success, otherwise a negative error value. * @retval #COMP_ERROR_NONE Successful @@ -673,7 +671,7 @@ int companion_device_get_my_uuid(companion_h handle, char **uuid); * * @since_tizen 5.0 * - * @remarks The @group should be released using companion_group_information_destroy(). + * @remarks The @a group should be released using companion_group_information_destroy(). * * @param[in] group Group handle * @@ -697,7 +695,7 @@ int companion_group_information_create(companion_group_h* group); * * @since_tizen 5.0 * - * @remarks The @dst should be released using companion_group_information_destroy(). + * @remarks The @a dst should be released using companion_group_information_destroy(). * * @param[out] dst Destination group handle * @param[in] src Source group handle @@ -769,7 +767,7 @@ int companion_group_information_get_type(companion_group_h group, * * @since_tizen 5.0 * - * @remarks The @resource_type should be released using free(). + * @remarks The @a resource_type should be released using free(). * * @param[in] group Group handle * @param[out] resource_type Resource type @@ -795,7 +793,7 @@ int companion_group_information_get_resource_type( * * @since_tizen 5.0 * - * @remarks The @uri_path should be released using free(). + * @remarks The @a uri_path should be released using free(). * * @param[in] group Group handle * @param[out] uri_path URI path @@ -821,7 +819,7 @@ int companion_group_information_get_uri_path(companion_group_h group, * * @since_tizen 5.0 * - * @remarks The @name should be released using free(). + * @remarks The @a name should be released using free(). * * @param[in] group Group handle * @param[out] name Name of the group @@ -847,7 +845,7 @@ int companion_group_information_get_name(companion_group_h group, * * @since_tizen 5.0 * - * @remarks The @host_addr should be released using free(). + * @remarks The @a host_addr should be released using free(). * * @param[in] group Group handle * @param[out] host_addr Host address of the group @@ -875,9 +873,9 @@ int companion_group_information_get_host_addr(companion_group_h group, * * @since_tizen 5.0 * - * @remarks The @device should be released using companion_device_information_destroy(). + * @remarks The @a device should be released using companion_device_information_destroy(). * - * @param[in] device Device handle + * @param[out] device Device handle * * @return 0 on success, otherwise a negative error value. * @retval #COMP_ERROR_NONE Successful @@ -897,9 +895,9 @@ int companion_device_information_create(companion_device_h* device); * * @since_tizen 5.0 * - * @remarks The @target should be released using companion_device_information_destroy(). + * @remarks The @a target should be released using companion_device_information_destroy(). * - * @param[out] target Target device handle + * @param[in] target Target device handle * @param[in] source Source device handle * * @return 0 on success, otherwise a negative error value. @@ -941,7 +939,7 @@ int companion_device_information_destroy(companion_device_h device); * * @since_tizen 5.0 * - * @remarks The @device_id should be released using free(). + * @remarks The @a device_id should be released using free(). * * @param[in] device Device handle * @param[out] device_id Device ID @@ -965,7 +963,7 @@ int companion_device_information_get_device_id(companion_device_h device, * * @since_tizen 5.0 * - * @remarks The @ip should be released using free(). + * @remarks The @a ip should be released using free(). * * @param[in] device Device handle * @param[out] ip IP address @@ -988,7 +986,7 @@ int companion_device_information_get_ip(companion_device_h device, char **ip); * * @since_tizen 5.0 * - * @remarks The @device_type should be released using free(). + * @remarks The @a device_type should be released using free(). * * @param[in] device Device handle * @param[out] device_type Device type diff --git a/capi/src/companion_dbus.h b/capi/src/companion_dbus.h index fdc5f06..894768b 100644 --- a/capi/src/companion_dbus.h +++ b/capi/src/companion_dbus.h @@ -20,7 +20,16 @@ #include +#ifdef __cplusplus +extern "C" +{ +#endif + int gdbus_initialize(comp_manager_s *handle); int gdbus_deinitialize(comp_manager_s *handle); +#ifdef __cplusplus +} +#endif + #endif /* __TIZEN_NETWORK_COMPANION_DBUS_INTERNAL_H__ */ diff --git a/capi/src/companion_util.h b/capi/src/companion_util.h index 6fbb635..2acfaea 100644 --- a/capi/src/companion_util.h +++ b/capi/src/companion_util.h @@ -20,9 +20,18 @@ #include +#ifdef __cplusplus +extern "C" +{ +#endif + companion_group_s *create_group_handle(char *uri_path, char *device_id, char *group_name, char *host_addr, char *resource_type, companion_group_type_e type); companion_device_s *create_device_handle(char *device_id, char *ip, char *device_type, int port); +#ifdef __cplusplus +} +#endif + #endif /* __TIZEN_NETWORK_COMMON_COMPANION_UTIL_H__ */ diff --git a/src/companion-manager/include/comp_gdbus.h b/src/companion-manager/include/comp_gdbus.h index 059e08e..4da1940 100644 --- a/src/companion-manager/include/comp_gdbus.h +++ b/src/companion-manager/include/comp_gdbus.h @@ -20,10 +20,19 @@ #include +#ifdef __cplusplus +extern "C" +{ +#endif + #define COMP_DBUS_SERVICE "org.tizen.companion" /**< For companion dbus */ #define COMP_DBUS_GROUP_PATH "/org/tizen/companion/group" /**< For group commands */ #define COMP_DBUS_ENABLER_PATH "/org/tizen/companion/enabler" /**< For d-bus activation */ int comp_gdbus_init(); +#ifdef __cplusplus +} +#endif + #endif /* __COMP_GDBUS_H__ */ diff --git a/src/companion-manager/include/comp_iot.h b/src/companion-manager/include/comp_iot.h index cc31b3a..baa7a47 100644 --- a/src/companion-manager/include/comp_iot.h +++ b/src/companion-manager/include/comp_iot.h @@ -57,4 +57,4 @@ int comp_iot_deinitialize(); #ifdef __cplusplus } #endif -#endif +#endif /* __COMP_IOT_H__ */ \ No newline at end of file diff --git a/src/companion-manager/include/comp_log.h b/src/companion-manager/include/comp_log.h index 9aaf017..ca6c0cb 100644 --- a/src/companion-manager/include/comp_log.h +++ b/src/companion-manager/include/comp_log.h @@ -21,6 +21,11 @@ #include #include +#ifdef __cplusplus +extern "C" +{ +#endif + #ifdef LOG_TAG #undef LOG_TAG #endif @@ -75,4 +80,9 @@ const char *comp_log_get_error_string(int result); +#ifdef __cplusplus +extern "C" +} #endif + +#endif /* __COMP_LOG_H__ */ diff --git a/src/mot-agent/ma-util.h b/src/mot-agent/ma-util.h index 6a0af31..1bdf540 100644 --- a/src/mot-agent/ma-util.h +++ b/src/mot-agent/ma-util.h @@ -31,6 +31,11 @@ #include "ma-log.h" +#ifdef __cplusplus +extern "C" +{ +#endif + #define DEBUG_UUID /**< To print device uuid */ #define WIFI_MAC_ADDR_LENGTH 17 /**< Wi-Fi MAC address size */ @@ -69,4 +74,8 @@ static OCProvisionDev_t* _clone_ocprovision_dev(const OCProvisionDev_t* src); #endif int ConvertUuidToStr(const OicUuid_t* uuid, char** strUuid); +#ifdef __cplusplus +} +#endif + #endif /* __MA_UTIL_H__ */