Add documentation

SonarSource · Sep 25, 2024 · 734aa31 · 734aa31
1 parent 290d104
commit 734aa31
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/ConnectedMode/ConnectionInfo.cs b/src/ConnectedMode/ConnectionInfo.cs
@@ -29,6 +29,11 @@ public enum ConnectionServerType
     SonarCloud
 }
 
+/// <summary>
+/// Model containing connection information, intended to be used by UI components
+/// </summary>
+/// <param name="Id">The organization key for SonarCloud or the server uri for SonarQube</param>
+/// <param name="ServerType">The type of server (SonarCloud, SonarQube)</param>
 public record ConnectionInfo(string Id, ConnectionServerType ServerType)
 {
     public static ConnectionInfo From(ServerConnection serverConnection)