From: Cheoleun Moon Date: Mon, 21 Oct 2019 14:30:20 +0000 (+0900) Subject: Correct ASP header comments X-Git-Tag: submit/tizen/20191104.104219^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=92e1415e47bfdb7fcebadec83b93733314717d7b;p=platform%2Fcore%2Fapi%2Fasp.git Correct ASP header comments Change-Id: Iaff84893379318c4cdb84dd1e6bbc9b1fe179051 Signed-off-by: Cheoleun Moon --- diff --git a/include/asp.h b/include/asp.h index f39425b..d9eee39 100755 --- a/include/asp.h +++ b/include/asp.h @@ -67,8 +67,8 @@ typedef enum { * @since_tizen 4.0 * @see asp_advert_set_p2p_role_scheme() * @see asp_advert_get_p2p_role_scheme() - * @see asp_session_set_p2p_role() - * @see asp_session_get_p2p_role() + * @see asp_session_set_p2p_role_scheme() + * @see asp_session_get_p2p_role_scheme() */ typedef enum { ASP_ADVERT_P2P_ROLE_SCHEME_ANY, /**< All roles are acceptable */ @@ -398,7 +398,7 @@ int asp_initialize(void); * @brief Deinitializes Application Service Platform (ASP). * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect + * @privilege %http://tizen.org/privilege/wifidirect * @return 0 on success, otherwise a negative error value. * @retval #ASP_ERROR_NONE Successful * @retval #ASP_ERROR_NOT_PERMITTED Operation not permitted @@ -547,7 +547,7 @@ int asp_session_unset_config_request_cb(void); * @retval #ASP_ERROR_NOT_INITIALIZED Not initialized * @pre Application Service Platform (ASP) must be initialized by asp_initialize(). * @see asp_initialize() - * @see asp_session_unset_connection_status_changed_cb() + * @see asp_session_unset_connect_status_cb() * @see asp_session_connect_status_cb() */ int asp_session_set_connect_status_cb(asp_session_connect_status_cb cb, void *user_data); @@ -661,7 +661,7 @@ int asp_advert_create(char *instance_name, asp_advert_service_h *adv_service); * @retval #ASP_ERROR_NOT_INITIALIZED Not initialized * @retval #ASP_ERROR_OPERATION_FAILED Operation failed * @retval #ASP_ERROR_SERVICE_NOT_FOUND Service not found - * @pre This API needs asp_create_service() before use + * @pre This API needs asp_advert_create() before use * @see asp_advert_create() */ int asp_advert_destroy(asp_advert_service_h adv_service); @@ -934,7 +934,7 @@ int asp_advert_get_p2p_role_scheme(asp_advert_service_h adv_service, * @since_tizen 4.0 * @param[in] adv_service Service descriptor handle provided by the asp_advert_create() * @param[in] config_method preferred Wi-Fi Simple Config (WSC) configuration method. - * Default value is ASP_WPS_TYPE_DEFAULT. + * Default value is #ASP_WPS_TYPE_DEFAULT. * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful * @retval #ASP_ERROR_NOT_PERMITTED Operation not permitted @@ -981,7 +981,7 @@ int asp_advert_get_p2p_config_method(asp_advert_service_h adv_service, * @param[in] adv_service Service descriptor handle provided by the asp_advert_create() * @param[in] rsp_info Specified for a particular service up to 144 bytes. * You can refer to Wi-Fi Peer-to-Peer Services Technical Specification, - * Wi-Fi Alliance. Available at:http://www.wi-fi.org + * Wi-Fi Alliance. Available at: http://www.wi-fi.org * @param[in] length The length of @a rsp_info in bytes, maximum length is 144 * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful @@ -1004,7 +1004,7 @@ int asp_advert_set_p2p_response(asp_advert_service_h adv_service, * asp_advert_create(). If the service is being advertised, no changes can be made to it. * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect + * @privilege %http://tizen.org/privilege/wifidirect * @param[in] adv_service Service descriptor handle provided by the asp_advert_create() * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful @@ -1028,7 +1028,7 @@ int asp_advert_start_advertising(asp_advert_service_h adv_service); * asp_advert_start_advertising(). * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect + * @privilege %http://tizen.org/privilege/wifidirect * @param[in] adv_service Service descriptor handle provided by the asp_advert_create() * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful @@ -1051,8 +1051,8 @@ int asp_advert_stop_advertising(asp_advert_service_h adv_service); * status after advertising service using asp_advert_start_advertising(). * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect - * @param[in] adv_service Service descriptor handle provided by the asp_create_service() + * @privilege %http://tizen.org/privilege/wifidirect + * @param[in] adv_service Service descriptor handle provided by the asp_advert_create() * @param[in] status Status of the service: * (@c 1 = available to use, @c 0 = not available to use, * @c 2-255 = service specific information) @@ -1212,7 +1212,7 @@ int asp_seek_set_preferred_connection(asp_seek_service_h seek_service, * @details If the service is currently seeking, no changes can be made to it. * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect + * @privilege %http://tizen.org/privilege/wifidirect * @param[in] seek_service Service seek handle provided by the asp_seek_create() * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful @@ -1236,7 +1236,7 @@ int asp_seek_start(asp_seek_service_h seek_service); * asp_seek_start(). * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect + * @privilege %http://tizen.org/privilege/wifidirect * @param[in] seek_service Service seek handle provided by the asp_seek_create() * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful @@ -1261,7 +1261,7 @@ int asp_seek_stop(asp_seek_service_h seek_service); * asp_seek_search_result_cb() * @param[in] adv_id The advertisement ID provided by * asp_seek_search_result_cb() - * @param[in] session ASP session descriptor handle + * @param[out] session ASP session descriptor handle * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful * @retval #ASP_ERROR_NOT_PERMITTED Operation not permitted @@ -1353,7 +1353,7 @@ int asp_session_get_id(asp_session_h session, unsigned int *session_id); * The session_info parameter is defined for each service section * and up to 144 bytes. You can refer to Wi-Fi Peer-to-Peer Services * Technical Specification, Wi-Fi Alliance. - * Available at:http://www.wi-fi.org + * Available at: http://www.wi-fi.org * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful * @retval #ASP_ERROR_NOT_PERMITTED Operation not permitted @@ -1418,7 +1418,7 @@ int asp_session_get_info(asp_session_h session, char **session_info); * @retval #ASP_ERROR_OPERATION_FAILED Operation failed * @retval #ASP_ERROR_SESSION_NOT_FOUND Session not found * @retval #ASP_ERROR_NETWORK_ROLE_REJECTED Network role rejected - * @pre This API needs asp_create_service() before use. + * @pre This API needs asp_create_session() before use. * @see asp_create_session() */ int asp_session_set_p2p_role_scheme(asp_session_h session, @@ -1520,7 +1520,7 @@ int asp_session_get_close_status(asp_session_h session, int *status); * @brief Starts to connect the Application Service Platform session. * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect + * @privilege %http://tizen.org/privilege/wifidirect * @param[in] session Application Service Platform session descriptor handle * @return 0 on success, otherwise a negative error value * @retval #ASP_ERROR_NONE Successful @@ -1541,7 +1541,7 @@ int asp_session_connect(asp_session_h session); * @brief Confirms the Application Service Platform(ASP) session request. * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect + * @privilege %http://tizen.org/privilege/wifidirect * @param[in] session ASP session descriptor handle provided by * the asp_session_request_cb() callback or * asp_session_create() if pin is requested. @@ -1612,7 +1612,7 @@ int asp_session_set_state_ready(asp_session_h session); * if not other ASP sessions are using it. * @since_tizen 4.0 * @privlevel public - * @privilege http://tizen.org/privilege/wifidirect + * @privilege %http://tizen.org/privilege/wifidirect * @param[in] session ASP session descriptor handle provided by * the asp_session_request_cb() callback or * asp_session_create()