docs: Update

atc-net · Dec 3, 2023 · d5271aa · d5271aa
1 parent 9f5aafe
commit d5271aa
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/docs/CodeDoc/Atc.Network/Atc.Network.md b/docs/CodeDoc/Atc.Network/Atc.Network.md
@@ -176,6 +176,38 @@ ConnectionStateEventArgs.
 
 
 
+<br />
+
+## IPStatusExtensions
+Provides extension methods for the `System.Net.NetworkInformation.IPStatus` enumeration.
+><b>Remarks:</b> This static class extends the `System.Net.NetworkInformation.IPStatus` enumeration, allowing for easy retrieval of localized string descriptions for each IP status value. This can be particularly useful for displaying user-friendly status messages in applications that perform network operations and diagnostics.
+
+>```csharp
+>public static class IPStatusExtensions
+>```
+
+### Static Methods
+
+#### GetLocalizedDescription
+>```csharp
+>string GetLocalizedDescription(this IPStatus ipStatus)
+>```
+><b>Summary:</b> Retrieves a localized description for a specified `System.Net.NetworkInformation.IPStatus` value.
+>
+><b>Parameters:</b><br>
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`ipStatus`&nbsp;&nbsp;-&nbsp;&nbsp;The  value for which a localized description is needed.<br />
+>
+><b>Returns:</b> A localized string representation of the specified `System.Net.NetworkInformation.IPStatus` value.
+>
+><b>Code example:</b>
+>```csharp
+>This example shows how to call the  method on an instance of the  enumeration:
+>
+>var status = IPStatus.TimedOut;
+>var description = status.GetLocalizedDescription();
+>Console.WriteLine(description); // Outputs the localized description for the IPStatus.TimedOut
+>```
+
 <br />
 
 ## LoggingEventIdConstants

diff --git a/docs/CodeDoc/Atc.Network/Index.md b/docs/CodeDoc/Atc.Network/Index.md
@@ -14,6 +14,7 @@
 - [IPScannerConfigExtensions](Atc.Network.md#ipscannerconfigextensions)
 - [IPScannerProgressReportingType](Atc.Network.md#ipscannerprogressreportingtype)
 - [IPServicePortExaminationLevel](Atc.Network.md#ipserviceportexaminationlevel)
+- [IPStatusExtensions](Atc.Network.md#ipstatusextensions)
 - [LoggingEventIdConstants](Atc.Network.md#loggingeventidconstants)
 - [NetworkQualityCategoryType](Atc.Network.md#networkqualitycategorytype)
 - [ServiceProtocolType](Atc.Network.md#serviceprotocoltype)

diff --git a/docs/CodeDoc/Atc.Network/IndexExtended.md b/docs/CodeDoc/Atc.Network/IndexExtended.md
@@ -29,6 +29,9 @@
      - GetTasksToProcessCount(this IPScannerConfig ipScannerConfig)
 - [IPScannerProgressReportingType](Atc.Network.md#ipscannerprogressreportingtype)
 - [IPServicePortExaminationLevel](Atc.Network.md#ipserviceportexaminationlevel)
+- [IPStatusExtensions](Atc.Network.md#ipstatusextensions)
+  -  Static Methods
+     - GetLocalizedDescription(this IPStatus ipStatus)
 - [LoggingEventIdConstants](Atc.Network.md#loggingeventidconstants)
 - [NetworkQualityCategoryType](Atc.Network.md#networkqualitycategorytype)
 - [ServiceProtocolType](Atc.Network.md#serviceprotocoltype)