From: Jaehyun Kim Date: Fri, 20 Sep 2024 04:31:09 +0000 (+0900) Subject: Add missing return values to doxygen comment X-Git-Tag: accepted/tizen/unified/20241004.041910~2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F85%2F317885%2F1;p=platform%2Fcore%2Fapi%2Fwifi-aware.git Add missing return values to doxygen comment - Add missing return values of each APIs to doxygen comment - Reorder return values of each APIs according to the Tizen doxygen guideline Change-Id: I31e9e6290e15b3b29d44f99c72f373c7d67de07c Signed-off-by: Jaehyun Kim --- diff --git a/include/wifi-aware.h b/include/wifi-aware.h index 0e889af..93174e8 100644 --- a/include/wifi-aware.h +++ b/include/wifi-aware.h @@ -206,8 +206,10 @@ typedef void *wifi_aware_data_path_h; * @since_tizen 9.0 * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_ALREADY_INITIALIZED Already initialized * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * @see wifi_aware_deinitialize() */ int wifi_aware_initialize(void); @@ -217,6 +219,7 @@ int wifi_aware_initialize(void); * @since_tizen 9.0 * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_initialize() */ @@ -226,11 +229,11 @@ int wifi_aware_deinitialize(void); * @brief Called when Wi-Fi Aware is enabled. * @details The following error codes can be received: \n * #WIFI_AWARE_ERROR_NONE Successful \n + * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported \n + * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n * #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter \n * #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation \n - * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed \n - * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n - * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed * @since_tizen 9.0 * @param[in] error The error code * @param[in] user_data The user data passed from the request function @@ -248,11 +251,12 @@ typedef void(*wifi_aware_enabled_cb)(wifi_aware_error_e error, void *user_data); * @param[in] user_data The user data passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful - * @retval #WIFI_AWARE_ERROR_ALREADY_ENABLED Already enabled - * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory - * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_ALREADY_ENABLED Already enabled + * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * @see wifi_aware_disable() */ int wifi_aware_enable(wifi_aware_enabled_cb callback, void *user_data); @@ -264,10 +268,11 @@ int wifi_aware_enable(wifi_aware_enabled_cb callback, void *user_data); * @privilege %http://tizen.org/privilege/network.set * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation - * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation + * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed * @see wifi_aware_enable() */ int wifi_aware_disable(void); @@ -280,9 +285,10 @@ int wifi_aware_disable(void); * @param[out] session The Wi-Fi Aware Session handle that is newly created on success * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful - * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * * @par Here is an example of the usage: * @code @@ -311,6 +317,7 @@ int wifi_aware_session_create(wifi_aware_session_type_e session_type, wifi_aware * @param[in] session The Wi-Fi Aware Session handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_create() @@ -338,6 +345,7 @@ typedef void(*wifi_aware_session_terminated_cb)(wifi_aware_session_h session, * @param[in] user_data The user data to be passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_unset_terminated_cb() @@ -351,6 +359,7 @@ int wifi_aware_session_set_terminated_cb(wifi_aware_session_h session, * @param[in] session The Wi-Fi Aware Session * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_set_terminated_cb() @@ -366,11 +375,12 @@ int wifi_aware_session_unset_terminated_cb(wifi_aware_session_h session); * @param[in] session The Wi-Fi Aware Session handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter + * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied - * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_publish() * @see wifi_aware_session_subscribe() */ @@ -380,11 +390,11 @@ int wifi_aware_session_stop(wifi_aware_session_h session); * @brief Called when publish request is finished. * @details The following error codes can be received: \n * #WIFI_AWARE_ERROR_NONE Successful \n + * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported \n + * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n * #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter \n * #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation \n - * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed \n - * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n - * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed * @since_tizen 9.0 * @remarks The @a session should not be released. * @param[in] session The Wi-Fi Aware Session handle @@ -407,11 +417,12 @@ typedef void(*wifi_aware_published_cb)(wifi_aware_session_h session, * @param[in] user_data The user data passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter + * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied - * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_stop() */ int wifi_aware_session_publish(wifi_aware_session_h session, @@ -430,11 +441,12 @@ int wifi_aware_session_publish(wifi_aware_session_h session, * @param[in] user_data The user data passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter + * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied - * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_publish() */ int wifi_aware_session_update_publish(wifi_aware_session_h session, @@ -445,11 +457,11 @@ int wifi_aware_session_update_publish(wifi_aware_session_h session, * @brief Called when Subscribe request is finished. * @details The following error codes can be received: \n * #WIFI_AWARE_ERROR_NONE Successful \n + * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported \n + * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n * #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter \n * #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation \n - * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed \n - * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n - * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed * @since_tizen 9.0 * @remarks The @a session should not be released. * @param[in] session The Wi-Fi Aware Session handle @@ -471,11 +483,12 @@ typedef void(*wifi_aware_subscribed_cb)(wifi_aware_session_h session, * @param[in] user_data The user data passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter + * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied - * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_stop() */ int wifi_aware_session_subscribe(wifi_aware_session_h session, @@ -493,11 +506,12 @@ int wifi_aware_session_subscribe(wifi_aware_session_h session, * @param[in] user_data The user data passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter + * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied - * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_subscribe() */ int wifi_aware_session_update_subscribe(wifi_aware_session_h session, @@ -533,6 +547,7 @@ typedef void(*wifi_aware_service_discovered_cb)(wifi_aware_session_h session, * @param[in] user_data The user data to be passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_unset_service_discovered_cb() @@ -546,6 +561,7 @@ int wifi_aware_session_set_service_discovered_cb(wifi_aware_session_h session, * @param[in] session The Wi-Fi Aware Session handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_set_service_discovered_cb() @@ -556,11 +572,11 @@ int wifi_aware_session_unset_service_discovered_cb(wifi_aware_session_h session) * @brief Called when a message is sent to a peer. * @details The following error codes can be received: \n * #WIFI_AWARE_ERROR_NONE Successful \n + * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported \n + * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n * #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter \n * #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation \n - * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed \n - * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n - * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed * @since_tizen 9.0 * @remarks The @a session should not be released. * @param[in] session The Wi-Fi Aware Session handle @@ -583,12 +599,13 @@ typedef void(*wifi_aware_send_message_result_cb)(wifi_aware_session_h session, * @param[in] user_data The user data passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation - * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory - * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied + * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation + * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory */ int wifi_aware_session_send_message( wifi_aware_session_h session, @@ -621,6 +638,7 @@ typedef void(*wifi_aware_message_received_cb)( * @param[in] user_data The user data passed to @a callback * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_unset_message_received_cb() @@ -634,6 +652,7 @@ int wifi_aware_session_set_message_received_cb(wifi_aware_session_h session, * @param[in] session The Wi-Fi Aware Session handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_session_set_message_received_cb() @@ -648,9 +667,10 @@ int wifi_aware_session_unset_message_received_cb(wifi_aware_session_h session); * @param[in] origin The origin Peer handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * * @par Here is an example of the usage: * @code @@ -679,6 +699,7 @@ int wifi_aware_peer_clone(wifi_aware_peer_h *cloned, wifi_aware_peer_h origin); * @param[in] peer The Peer handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_peer_clone() @@ -693,9 +714,10 @@ int wifi_aware_peer_destroy(wifi_aware_peer_h peer); * @param[out] mac The MAC address of the peer * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * * @par Here is an example of the usage: * @code @@ -737,9 +759,10 @@ typedef enum { * @param[out] data_path The Data Path handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * * @par Here is an example of the usage: * @code @@ -770,6 +793,7 @@ int wifi_aware_data_path_create(wifi_aware_session_h session, wifi_aware_peer_h * @param[in] security_type The security type * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_data_path_create() @@ -784,9 +808,10 @@ int wifi_aware_data_path_set_security(wifi_aware_data_path_h data_path, wifi_awa * @param[in] key The passphrase * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @see wifi_aware_data_path_create() */ int wifi_aware_data_path_set_psk(wifi_aware_data_path_h data_path, const char *key); @@ -799,9 +824,10 @@ int wifi_aware_data_path_set_psk(wifi_aware_data_path_h data_path, const char *k * @param[in] key Pairwise Master Key. Its length shall be of length 32. * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @see wifi_aware_data_path_create() */ int wifi_aware_data_path_set_pmk(wifi_aware_data_path_h data_path, const unsigned char *key); @@ -814,6 +840,7 @@ int wifi_aware_data_path_set_pmk(wifi_aware_data_path_h data_path, const unsigne * @param[in] port The port * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_data_path_create() @@ -826,6 +853,7 @@ int wifi_aware_data_path_set_port(wifi_aware_data_path_h data_path, int port); * @param[in] data_path The Data Path handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_data_path_create() @@ -836,11 +864,11 @@ int wifi_aware_data_path_destroy(wifi_aware_data_path_h data_path); * @brief Called when Data Path open request is done. * @details The following error codes can be received: \n * #WIFI_AWARE_ERROR_NONE Successful \n + * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported \n + * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n * #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter \n * #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation \n - * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed \n - * #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied \n - * #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed * @since_tizen 9.0 * @remarks The @a data_path should not be released. * @param[in] data_path The Data Path handle @@ -862,11 +890,12 @@ typedef void(*wifi_aware_data_path_open_cb)(wifi_aware_data_path_h data_path, wi * @param[in] user_data The user data passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation - * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied + * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation + * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed * @see wifi_aware_data_path_close() */ int wifi_aware_data_path_open(wifi_aware_data_path_h data_path, @@ -880,11 +909,12 @@ int wifi_aware_data_path_open(wifi_aware_data_path_h data_path, * @param[in] data_path The Data Path handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation - * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_PERMISSION_DENIED Permission denied + * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation + * @retval #WIFI_AWARE_ERROR_OPERATION_FAILED Operation failed * @see wifi_aware_data_path_open() */ int wifi_aware_data_path_close(wifi_aware_data_path_h data_path); @@ -896,9 +926,10 @@ int wifi_aware_data_path_close(wifi_aware_data_path_h data_path); * @param[out] port The port * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation */ int wifi_aware_data_path_get_peer_port(wifi_aware_data_path_h data_path, int* port); @@ -910,9 +941,10 @@ int wifi_aware_data_path_get_peer_port(wifi_aware_data_path_h data_path, int* po * @param[out] ipv6_address The IPv6 address of a peer * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * * @par Here is an example of the usage: * @code @@ -942,9 +974,10 @@ int wifi_aware_data_path_get_peer_ipv6_address(wifi_aware_data_path_h data_path, * @param[out] interface The interface name * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_INVALID_OPERATION Invalid operation * * @par Here is an example of the usage: * @code @@ -986,6 +1019,7 @@ typedef void(*wifi_aware_data_path_terminated_cb)(wifi_aware_data_path_h data_pa * @param[in] user_data The user data passed to the callback function * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_data_path_unset_terminated_cb() @@ -998,6 +1032,7 @@ int wifi_aware_data_path_set_terminated_cb(wifi_aware_data_path_h data_path, wif * @param[in] data_path The Data Path handle * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_data_path_set_terminated_cb() @@ -1020,9 +1055,10 @@ int wifi_aware_data_path_unset_terminated_cb(wifi_aware_data_path_h data_path); * @param[out] publish The Wi-Fi Aware Publish handle. * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * * @par Here is an example of the usage: * @code @@ -1059,6 +1095,7 @@ int wifi_aware_publish_create(wifi_aware_publish_h *publish); * @param[in] publish The Wi-Fi Aware Publish handle. * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_publish_create() @@ -1072,6 +1109,7 @@ int wifi_aware_publish_destroy(wifi_aware_publish_h publish); * @param[in] ttl The lifetime(seconds) of publish session. 0 means forever until canceled. * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_publish_create() @@ -1085,6 +1123,7 @@ int wifi_aware_publish_set_ttl(wifi_aware_publish_h publish, unsigned short ttl) * @param[in] publish_type The Publish type * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_publish_create() @@ -1099,6 +1138,7 @@ int wifi_aware_publish_set_type(wifi_aware_publish_h publish, wifi_aware_publish * @param[in] service_name UTF-8 name which identifies the service * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_publish_create() @@ -1113,6 +1153,8 @@ int wifi_aware_publish_set_service_name(wifi_aware_publish_h publish, const char * @param[in] len The length of service specific information * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_publish_create() */ @@ -1127,6 +1169,8 @@ int wifi_aware_publish_set_service_specific_info(wifi_aware_publish_h publish, c * @param[in] len The whole length of match_filter * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_publish_create() */ @@ -1140,6 +1184,8 @@ int wifi_aware_publish_set_match_filter(wifi_aware_publish_h publish, const unsi * otherwise @c false if ranging is disabled. * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_publish_create() */ @@ -1161,9 +1207,10 @@ int wifi_aware_publish_enable_ranging(wifi_aware_publish_h publish, bool enable) * @param[out] subscribe The Wi-Fi Aware Subscribe handle. * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter - * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized + * @retval #WIFI_AWARE_ERROR_OUT_OF_MEMORY Out of memory * * @par Here is an example of the usage: * @code @@ -1200,6 +1247,7 @@ int wifi_aware_subscribe_create(wifi_aware_subscribe_h *subscribe); * @param[in] subscribe The Wi-Fi Aware Subscribe handle. * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_subscribe_create() @@ -1214,6 +1262,7 @@ int wifi_aware_subscribe_destroy(wifi_aware_subscribe_h subscribe); * 0 means forever until wifi_aware_service_discovered_cb(). * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_subscribe_create() @@ -1227,6 +1276,7 @@ int wifi_aware_subscribe_set_ttl(wifi_aware_subscribe_h subscribe, unsigned shor * @param[in] subscribe_type The Subscribe type * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_subscribe_create() @@ -1241,6 +1291,7 @@ int wifi_aware_subscribe_set_type(wifi_aware_subscribe_h subscribe, wifi_aware_s * @param[in] service_name UTF-8 name which identifies the service * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_subscribe_create() @@ -1255,6 +1306,7 @@ int wifi_aware_subscribe_set_service_name(wifi_aware_subscribe_h subscribe, cons * @param[in] len The length of service specific information * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_subscribe_create() @@ -1270,6 +1322,7 @@ int wifi_aware_subscribe_set_service_specific_info(wifi_aware_subscribe_h subscr * @param[in] len The whole length of match_filter * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_subscribe_create() @@ -1284,6 +1337,7 @@ int wifi_aware_subscribe_set_match_filter(wifi_aware_subscribe_h subscribe, cons * @param[in] distance The maximum distance * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_subscribe_create() @@ -1298,6 +1352,7 @@ int wifi_aware_subscribe_set_max_distance(wifi_aware_subscribe_h subscribe, int * @param[in] distance The minimum distance * @return 0 on success, otherwise a negative error value * @retval #WIFI_AWARE_ERROR_NONE Successful + * @retval #WIFI_AWARE_ERROR_NOT_SUPPORTED Not supported * @retval #WIFI_AWARE_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #WIFI_AWARE_ERROR_NOT_INITIALIZED Not initialized * @see wifi_aware_subscribe_create()