1. Aaron Jensen
  2. Carbon

Commits

Aaron Jensen  committed 5cf9a47

Improving documentation for Test-IPAddress.

  • Participants
  • Parent commits 451f66b
  • Branches default

Comments (0)

Files changed (1)

File Carbon/Network/Test-IPAddress.ps1

View file
 
     .DESCRIPTION
     Sometimes its useful to know if an IP address is being used on the local computer.  This function does just that.
+
+    .LINK
+    Test-IPAddress
+
+    .EXAMPLE
+    Test-IPAddress -IPAddress '10.1.2.3'
+
+    Returns `true` if the IP address `10.1.2.3` is being used on the local computer.
+
+    .EXAMPLE
+    Test-IPAddress -IPAddress '::1'
+
+    Demonstrates that you can use IPv6 addresses.
+
+    .EXAMPLE
+    Test-IPAddress -IPAddress ([Net.IPAddress]::Parse('10.5.6.7'))
+
+    Demonstrates that you can use real `System.Net.IPAddress` objects.
     #>
     [CmdletBinding()]
     param(