* description to class ServerConfig

AbsaOSS · Nov 25, 2024 · 3955a50 · 3955a50
1 parent e07dffb
commit 3955a50
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/reader/src/main/scala/za/co/absa/atum/reader/server/ServerConfig.scala b/reader/src/main/scala/za/co/absa/atum/reader/server/ServerConfig.scala
@@ -18,6 +18,10 @@ package za.co.absa.atum.reader.server
 
 import com.typesafe.config.{Config, ConfigFactory}
 
+/**
+ * A case class representing the configuration to connect to an Atum server instance.
+ * @param host  The URL of the Atum server instance.
+ */
 case class ServerConfig (host: String)
 
 object ServerConfig {