Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Nework.WiFi] Reinforce API documents #6390

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Nework.WiFi] Reinforce API documents #6390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAddressInformation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
13 changes: 8 additions & 5 deletions src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiEap.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down
32 changes: 16 additions & 16 deletions src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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.
Expand All @@ -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>
Expand All @@ -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.
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiNetwork.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiSecurity.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading