From 0fc9b4d4d748c362d190bbf91f749be3bdea9678 Mon Sep 17 00:00:00 2001
From: "hyunsube.lee" <hyunsube.lee@samsung.com>
Date: Wed, 2 Oct 2024 10:44:16 +0900
Subject: [PATCH] [WIFI] Reinforce API documents

---
 .../Tizen.Network.WiFi/WiFiAP.cs              |  8 ++---
 .../WiFiAddressInformation.cs                 |  4 +--
 .../Tizen.Network.WiFi/WiFiEap.cs             | 13 +++++---
 .../Tizen.Network.WiFi/WiFiManager.cs         | 32 +++++++++----------
 .../Tizen.Network.WiFi/WiFiNetwork.cs         |  4 +--
 .../Tizen.Network.WiFi/WiFiSecurity.cs        |  2 +-
 6 files changed, 33 insertions(+), 30 deletions(-)

diff --git a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs
index a4b5f4eb6cc..afda24c146c 100644
--- a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs
+++ b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs
@@ -75,7 +75,7 @@ internal WiFiAP(IntPtr handle)
         }
 
         /// <summary>
-        /// Creates an object for the access point.
+        /// Creates a new instance of the WiFiAP class for the specified access point.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="essid">The Extended Service Set Identifier of the access point.</param>
@@ -95,7 +95,7 @@ public WiFiAP(string essid)
         }
 
         /// <summary>
-        /// Creates an object for the hidden access point.
+        /// Creates a new instance of the WiFiAP class for a hidden access point.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="essid">The Extended Service Set Identifier of the access point.</param>
@@ -178,7 +178,7 @@ private void Initialize()
         }
 
         /// <summary>
-        /// Refreshes the access point information.
+        /// Updates the information of the access point to reflect the latest state and details.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <feature>http://tizen.org/feature/network.wifi</feature>
@@ -491,7 +491,7 @@ public static Task<WiFiAP> ConnectWpsWithoutSsidAsync(WpsInfo info)
         }
 
         /// <summary>
-        /// Stops ongoing WPS provisioning
+        /// Cancels any ongoing Wi-Fi Protected Setup (WPS) provisioning process.
         /// </summary>
         /// <since_tizen> 5 </since_tizen>
         /// <feature>http://tizen.org/feature/network.wifi</feature>
diff --git a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAddressInformation.cs b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAddressInformation.cs
index 8d69e7e894e..b50642acaae 100755
--- a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAddressInformation.cs
+++ b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAddressInformation.cs
@@ -202,7 +202,7 @@ public DnsConfigType DnsConfigType
         }
 
         /// <summary>
-        /// DHCP server address. It is only supported for IPv4 address family.
+        /// Represents the DHCP server address for the current Wi-Fi access point (AP). This property is only supported for the IPv4 address family.
         /// </summary>
         /// <value>Represents DHCP server address.</value>
         public System.Net.IPAddress DhcpServerAddress
@@ -222,7 +222,7 @@ public System.Net.IPAddress DhcpServerAddress
         }
 
         /// <summary>
-        /// DHCP lease duration. It is only supported for IPv4 address family.
+        /// Represents the DHCP lease duration for the current Wi-Fi access point (AP). This property is only supported for the IPv4 address family.
         /// </summary>
         /// <value>Represents DHCP lease duration.</value>
         public int  DhcpLeaseDuration
diff --git a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiEap.cs b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiEap.cs
index 31223a4a5a6..fedd793d392 100755
--- a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiEap.cs
+++ b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiEap.cs
@@ -137,6 +137,9 @@ internal WiFiEap(Interop.WiFi.SafeWiFiAPHandle apHandle)
 
         /// <summary>
         /// Gets the private key file of EAP.
+        /// Retrieves the file path of the private key used for Extensible Authentication Protocol (EAP) authentication.
+        /// This method returns the file path of the private key associated with the EAP configuration. The private key is used during the EAP handshake to securely authenticate the client.
+        /// Note that the returned file path is a string representation of the private key file path. Ensure that the file exists and is accessible before relying on its contents.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>The file path of private key.</returns>
@@ -158,7 +161,7 @@ public string GetPrivateKeyFile()
         }
 
         /// <summary>
-        /// Sets the private key information of EAP.
+        /// Configures the private key file path and password for Extensible Authentication Protocol (EAP) authentication.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="privateKeyFile">The file path of private key.</param>
@@ -183,7 +186,7 @@ public void SetPrivateKeyFile(string privateKeyFile, string password)
         }
 
         /// <summary>
-        /// Gets the client certificate of EAP.
+        /// Retrieves the file path of the client certificate used for Extensible Authentication Protocol (EAP) authentication.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>The file path of client certificate.</returns>
@@ -208,7 +211,7 @@ public string GetClientCertFile()
         }
 
         /// <summary>
-        /// Sets the CA certificate of EAP.
+        /// Sets the Certificate Authority (CA) certificate file path for Extensible Authentication Protocol (EAP) authentication.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="clientCertFile">The file path of client certificate.</param>
@@ -284,7 +287,7 @@ public bool IsPasswordSet()
         }
 
         /// <summary>
-        /// Sets the user name of EAP.
+        /// Configures the username for the Extensible Authentication Protocol (EAP) passphrase.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="userName">The user name</param>
@@ -308,7 +311,7 @@ public void SetUserName(string userName)
         }
 
         /// <summary>
-        /// Sets the password of EAP.
+        /// Configures the password for the Extensible Authentication Protocol (EAP) passphrase.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="password">The password</param>
diff --git a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs
index d7dd257d003..ab37e3f0216 100755
--- a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs
+++ b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs
@@ -232,7 +232,7 @@ static public event EventHandler<ScanStateChangedEventArgs> ScanStateChanged
         }
 
         /// <summary>
-        /// Gets the Wi-Fi safe handle.
+        /// Retrieves the Wi-Fi safe handle, which is used to manage Wi-Fi operations securely.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>The instance of the SafeWiFiManagerHandle.</returns>
@@ -249,7 +249,7 @@ public static SafeWiFiManagerHandle GetWiFiHandle()
         }
 
         /// <summary>
-        /// Gets the result of the scan.
+        /// Retrieves the results of the Wi-Fi scan, providing a list of discovered Wi-Fi access points (APs).
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>A list of the WiFiAP objects.</returns>
@@ -264,7 +264,7 @@ static public IEnumerable<WiFiAP> GetFoundAPs()
         }
 
         /// <summary>
-        /// Gets the result of ScanSpecificAPAsync(string essid) API.
+        /// Retrieves the results of the scan specific to a particular Wi-Fi access point (AP), providing a list of discovered APs matching the specified ESSID.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>A list containing the WiFiAP objects.</returns>
@@ -279,7 +279,7 @@ static public IEnumerable<WiFiAP> GetFoundSpecificAPs()
         }
 
         /// <summary>
-        /// Gets the result of the BssidScanAsync() API.
+        /// Retrieves the results of the BSSID scan, providing a list of discovered Wi-Fi access points (APs) based on their BSSID (Basic Service Set Identifier).
         /// </summary>
         /// <since_tizen> 5 </since_tizen>
         /// <returns>A list of the WiFiAP objects.</returns>
@@ -294,7 +294,7 @@ static public IEnumerable<WiFiAP> GetFoundBssids()
         }
 
         /// <summary>
-        /// Gets the list of Wi-Fi configurations.
+        /// Retrieves the list of Wi-Fi configurations stored on the device.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>A list containing the WiFiConfiguration objects.</returns>
@@ -310,7 +310,7 @@ static public IEnumerable<WiFiConfiguration> GetWiFiConfigurations()
         }
 
         /// <summary>
-        /// Saves the Wi-Fi configuration of the access point.
+        /// Saves the Wi-Fi configuration of the access point to the device's storage.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="configuration">The configuration to be stored.</param>
@@ -327,7 +327,7 @@ static public void SaveWiFiConfiguration(WiFiConfiguration configuration)
         }
 
         /// <summary>
-        /// Gets the object of the connected WiFiAP.
+        /// Retrieves the information of the currently connected Wi-Fi access point (AP).
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>The connected Wi-Fi access point (AP) information.</returns>
@@ -343,7 +343,7 @@ static public WiFiAP GetConnectedAP()
         }
 
         /// <summary>
-        /// Activates the Wi-Fi asynchronously.
+        /// Activates the Wi-Fi module asynchronously.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns> A task indicating whether the activate method is done or not.</returns>
@@ -377,7 +377,7 @@ static public Task ActivateWithPickerAsync()
         }
 
         /// <summary>
-        /// Deactivates the Wi-Fi asynchronously.
+        /// Deactivates the Wi-Fi module asynchronously.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>A task indicating whether the deactivate method is done or not.</returns>
@@ -394,7 +394,7 @@ static public Task DeactivateAsync()
         }
 
         /// <summary>
-        /// Starts the scan asynchronously.
+        /// Initiates a Wi-Fi scan asynchronously.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>A task indicating whether the scan method is done or not.</returns>
@@ -428,7 +428,7 @@ static public Task ScanSpecificAPAsync(string essid)
         }
 
         /// <summary>
-        /// Starts BSSID scan asynchronously.
+        /// Initiates a BSSID scan asynchronously.
         /// </summary>
         /// <remarks>
         /// This method must be called from MainThread.
@@ -447,7 +447,7 @@ static public Task BssidScanAsync()
         }
 
         /// <summary>
-        /// Set Auto Scan Mode.
+        /// Sets the auto scan mode for the Wi-Fi module.
         /// </summary>
         /// <since_tizen> 10 </since_tizen>
         /// <feature>http://tizen.org/feature/network.wifi</feature>
@@ -463,7 +463,7 @@ static public void SetAutoScanMode(WiFiAutoScanMode scanMode)
         }
 
         /// <summary>
-        /// Hidden Ap connect.
+        /// Connects to a hidden Wi-Fi access point asynchronously.
         /// </summary>
         /// <remarks>
         /// This method must be called from MainThread.
@@ -483,7 +483,7 @@ static public Task HiddenAPConnectAsync(string essid, int secType, string passwo
         }
 
         /// <summary>
-        /// Create Specific scan handle.
+        /// Creates a specific scan handle for the Wi-Fi module.
         /// </summary>
         /// <since_tizen> 9 </since_tizen>
         /// <feature>http://tizen.org/feature/network.wifi</feature>
@@ -499,7 +499,7 @@ static public void CreateSpecificHandle()
         }
 
         /// <summary>
-        /// Destroys Specific scan handle.
+        /// Destroys the specific scan handle for the Wi-Fi module.
         /// </summary>
         /// <since_tizen> 9 </since_tizen>
         /// <feature>http://tizen.org/feature/network.wifi</feature>
@@ -515,7 +515,7 @@ static public void DestroySpecificHandle()
         }
 
         /// <summary>
-        /// Starts Multi Scan.
+        /// Starts a multi-frequency scan for available Wi-Fi networks asynchronously.
         /// </summary>
         /// <remarks>
         /// This method must be called from MainThread.
diff --git a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiNetwork.cs b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiNetwork.cs
index ede4e4de684..86bd447fc8d 100755
--- a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiNetwork.cs
+++ b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiNetwork.cs
@@ -371,7 +371,7 @@ public string CountryCode
         }
 
         /// <summary>
-        /// Gets all IPv6 addresses of the access point.
+        /// Retrieves a list of all IPv6 addresses associated with the specified access point.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <returns>A list of IPv6 addresses of the access point.</returns>
@@ -411,7 +411,7 @@ public string CountryCode
         }
 
         /// <summary>
-        /// Gets the Bssid list.
+        /// Retrieves a list of BSSIDs (Basic Service Set Identifiers) associated with access points that have the same SSID (Service Set Identifier) as the current access point.
         /// </summary>
         /// <since_tizen> 5 </since_tizen>
         /// <returns>A list of BSSIDs of access points with the same SSID as that of this access point.</returns>
diff --git a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiSecurity.cs b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiSecurity.cs
index d32850424c8..a30369cd545 100755
--- a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiSecurity.cs
+++ b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiSecurity.cs
@@ -148,7 +148,7 @@ internal WiFiSecurity(Interop.WiFi.SafeWiFiAPHandle apHandle)
         }
 
         /// <summary>
-        /// Sets the passphrase.
+        /// Configures the passphrase for the Wi-Fi access point (AP).
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="passphrase">The passphrase of the access point.</param>