Add XML documentation to eliminate all CS1591 warnings

[sunnynagavo]

Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(20,14): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(22,19): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection.Url' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(23,19): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection.Username' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(24,19): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection.Password' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(26,12): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection.GenericConnection(string, string, string)' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs(31,24): warning CS1591: Missing XML comment for publicly visible type or member 'MacOSHelper.IsMacOS' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(56,21): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.Network' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(103,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithMainRemoteArtifacts(params string[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(109,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithMainRemoteArtifacts(params RemoteArtifact[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(115,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithSecondaryArtifacts(params string[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(121,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithSecondaryRemoteArtifacts(params RemoteArtifact[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(127,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithSnapshots(params string[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(133,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithSecrets(params Secret[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Microcks.Testcontainers -> /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/bin/Release/net8.0/Microcks.Testcontainers.dll
Microcks.Testcontainers.Tests -> /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/tests/Microcks.Testcontainers.Tests/bin/Release/net8.0/Microcks.Testcontainers.Tests.dll

Build succeeded.

Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(20,14): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(22,19): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection.Url' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(23,19): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection.Username' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(24,19): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection.Password' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Connection/GenericConnection.cs(26,12): warning CS1591: Missing XML comment for publicly visible type or member 'GenericConnection.GenericConnection(string, string, string)' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs(31,24): warning CS1591: Missing XML comment for publicly visible type or member 'MacOSHelper.IsMacOS' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(56,21): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.Network' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(103,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithMainRemoteArtifacts(params string[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(109,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithMainRemoteArtifacts(params RemoteArtifact[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(115,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithSecondaryArtifacts(params string[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(121,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithSecondaryRemoteArtifacts(params RemoteArtifact[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(127,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithSnapshots(params string[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
Warning: /home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs(133,38): warning CS1591: Missing XML comment for publicly visible type or member 'MicrocksContainerEnsemble.WithSecrets(params Secret[])' [/home/runner/work/microcks-testcontainers-dotnet/microcks-testcontainers-dotnet/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj::TargetFramework=net8.0]
13 Warning(s)
0 Error(s)

currently there are 13 warnings, this issue will track in fixing them.

[github-actions]

👋 @sunnynagavo

Welcome to the Microcks community! 💖

Thanks and congrats 🎉 for opening your first issue here! Be sure to follow the issue template or please update it accordingly.

📢 If you're using Microcks in your organization, please add your company name to this list. 🙏 It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact.

If you need to know why and how to add yourself to the list, please read the blog post "Join the Microcks Adopters list and Empower the vibrant open source Community 🙌"

Hope you have a great time there!

🌟 ~~~~~~~~~ 🌟

📢 If you like Microcks, please ⭐ star ⭐ our repo to support it!

🙏 It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact.

[sunnynagavo]

I will work on this later as its not urgent issue.