Add description #1

diff --git a/include/wifi-aware.h b/include/wifi-aware.h
index 17506a6..a7cd658 100644 (file)
--- a/include/wifi-aware.h
+++ b/include/wifi-aware.h
@@ -33,14 +33,14 @@ extern "C" {
  * @{
  */
 
-/**
- * @brief Enumeration for Wi-Fi Aware error code.
- * @since_tizen 6.0
- */
 #ifndef TIZEN_ERROR_WIFI_AWARE
 #define TIZEN_ERROR_WIFI_AWARE -0x03050000
 #endif
 
+/**
+ * @brief Enumeration for Wi-Fi Aware error code.
+ * @since_tizen 6.0
+ */
 typedef enum {
        /**
         * Successful
@@ -108,22 +108,36 @@ typedef enum {
        WIFI_AWARE_ERROR_INTERFACE_DOWN                 = TIZEN_ERROR_WIFI_AWARE|0x06,
 } wifi_aware_error_e;
 
+/**
+ * @brief Enumeration for Wi-Fi Aware termination reason.
+ * @since_tizen 6.0
+ */
 typedef enum {
        WIFI_AWARE_TERMINATION_REASON_UNKNOWN = 0,
 } wifi_aware_termination_reason_e;
 
+/**
+ * @brief Enumeration for Wi-Fi Aware session type.
+ * @since_tizen 6.0
+ */
 typedef enum {
        WIFI_AWARE_SESSION_PUBLISH = 0,
        WIFI_AWARE_SESSION_SUBSCRIBE,
 } wifi_aware_session_type_e;
 
+/**
+ * @brief Enumeration for Wi-Fi Aware publish type.
+ * @since_tizen 6.0
+ */
 typedef enum {
        WIFI_AWARE_PUBLISH_TYPE_UNSOLICITED = 0,/**< Unsolicited type */
        WIFI_AWARE_PUBLISH_TYPE_SOLICITED,      /**< Solicited type */
-       // TODO:
-       // WIFI_AWARE_PUBLISH_TYPE_UNSOLICITED_SOLICITED
 } wifi_aware_publish_type_e;
 
+/**
+ * @brief Enumeration for Wi-Fi Aware subscrbie type.
+ * @since_tizen 6.0
+ */
 typedef enum {
        WIFI_AWARE_SUBSCRIBE_TYPE_PASSIVE = 0,  /**< Passive type */
        WIFI_AWARE_SUBSCRIBE_TYPE_ACTIVE,   /**< Active type */
@@ -162,7 +176,7 @@ typedef void *wifi_aware_data_path_h;
 
 
 /**
- * @brief
+ * @brief Initializes Wi-Fi Aware
  * @since_tizen 6.0
  * @return     0 on success, otherwise a negative error value
  * @retval     #WIFI_AWARE_ERROR_NONE
@@ -172,7 +186,7 @@ typedef void *wifi_aware_data_path_h;
 int wifi_aware_initialize();
 
 /**
- * @brief
+ * @brief Deinitializes Wi-Fi Aware
  * @since_tizen 6.0
  * @return     0 on success, otherwise a negative error value
  * @retval     #WIFI_AWARE_ERROR_NONE
@@ -220,10 +234,10 @@ int wifi_aware_subscribe_create(wifi_aware_subscribe_h *subscribe);
 int wifi_aware_subscribe_destroy(wifi_aware_subscribe_h subscribe);
 
 /**
- * @brief
+ * @brief Sets TTL(Time To Live) to Publish configuration.
  * @since_tizen 6.0
- * @param[in] publish
- * @param[in] ttl
+ * @param[in] publish publish configuration handle.
+ * @param[in] ttl lifetime(seconds) of publish session. 0 means forever until canceled.
  * @return     0 on success, otherwise a negative error value
  * @retval     #WIFI_AWARE_ERROR_NONE
  */