Skip to content

Commit e7b26ee

Browse files
authored
Improve documentation comment on GetIsNetworkAvailable
***NO_CI***
1 parent 4c740cd commit e7b26ee

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

nanoFramework.System.Net/NetworkInformation/NetworkInterface.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,12 @@ internal enum UpdateOperation : byte
5656
/// <summary>
5757
/// Indicates whether any network connection is available.
5858
/// </summary>
59-
/// <returns><see langword="true"/> if a network connection is available; otherwise, <see langword="false"/>.</returns>
59+
/// <returns>
60+
/// <see langword="true"/> if a network connection is available; otherwise, <see langword="false"/>.
61+
/// </returns>
62+
/// <remarks>
63+
/// A network connection is considered to be available if any network interface is marked "up" and is not a loopback or tunnel interface.
64+
/// </remarks>
6065
[MethodImpl(MethodImplOptions.InternalCall)]
6166
public extern static bool GetIsNetworkAvailable();
6267

0 commit comments

Comments
 (0)