Update doxygen #4
authorSeonah Moon <seonah1.moon@samsung.com>
Fri, 10 Apr 2020 05:45:26 +0000 (14:45 +0900)
committerSeonah Moon <seonah1.moon@samsung.com>
Fri, 10 Apr 2020 05:45:26 +0000 (14:45 +0900)
include/wifi-aware.h

index 6a46053..3a353e4 100644 (file)
@@ -370,10 +370,11 @@ int wifi_aware_subscribe_set_service_specific_info(wifi_aware_subscribe_h subscr
 int wifi_aware_subscribe_set_match_filter(wifi_aware_subscribe_h subscribe, const unsigned char *match_filter, size_t len);
 
 /**
- * @brief Sets the maximum distance between the found services
+ * @brief Sets the maximum distance.
  * @since_tizen 6.0
+ * @remark Only for the services within the @a distance are searched.
  * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] distance The max distance between found services
+ * @param[in] distance The maximum distance 
  * @return 0 on success, otherwise a negative error value
  * @retval #WIFI_AWARE_ERROR_NONE
  * @see wifi_aware_subscrbie_create()
@@ -381,10 +382,11 @@ int wifi_aware_subscribe_set_match_filter(wifi_aware_subscribe_h subscribe, cons
 int wifi_aware_subscribe_set_max_distance(wifi_aware_subscribe_h subscribe, int distance);
 
 /**
- * @brief Sets the minimum distance between the found services
+ * @brief Sets the minimum distance.
  * @since_tizen 6.0
+ * @remark Only for the services at least at the @ a distance are searched.
  * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] distance The min distance between found services
+ * @param[in] distance The minimum distance
  * @return 0 on success, otherwise a negative error value
  * @retval #WIFI_AWARE_ERROR_NONE
  * @see wifi_aware_subscrbie_create()
@@ -581,7 +583,8 @@ int wifi_aware_session_update_subscribe(wifi_aware_session_h session,
 /**
  * @brief Called whenever a matched service for the subscribe configurations is found.
  * @since_tizen 6.0
- * @remkar If ranging is not supported or not enabled, @a distance would be 0.
+ * @remark If the publisher doesn't enabled ranging or the subscriber doesn't set both max and min distance,\n
+ *         @a distance would be negative value.
  * @param[in] session   The Wi-Fi Aware Session handle
  * @param[in] peer      The found Peer information 
  * @param[in] service_specific_info     Sequence of octets which were received from published service
@@ -765,7 +768,7 @@ int wifi_aware_data_path_set_psk(wifi_aware_data_path_h data_path, const char *k
 /**
  * @brief Sets a PMK for Wi-Fi Aware Data Path.
  * @since_tizen 6.0
- * @remkar @key can be used only when security type is WIFI_AWARE_SECURITY_TYPE_PMK.
+ * @remark @key can be used only when security type is WIFI_AWARE_SECURITY_TYPE_PMK.
  * @param[in] data_path The Data Path handle
  * @param[in] key        Pairwise Master Key. Its length shall be of length 32.
  * @return 0 on success, otherwise a negative error value
@@ -809,7 +812,7 @@ typedef void(*wifi_aware_data_path_open_cb)(wifi_aware_data_path_h data_path, wi
                void *user_data);
 
 /**
- * @brief Starts to open a Wi-Fi Aware Data Path.
+ * @brief Requests to open a Wi-Fi Aware Data Path.
  * @remarks The @a callback will be always invoked whether the open request succeeds or fails.
  * @since_tizen 6.0
  * @param[in] data_path The Data Path handle
@@ -831,7 +834,6 @@ int wifi_aware_data_path_close(wifi_aware_data_path_h data_path);
 
 /**
  * @brief Gets a port of a peer.
- * @remarks This is only for Data Path Initiator.
  * @since_tizen 6.0
  * @param[in] data_path The Data Path handle
  * @param[out] port     The port